[Hub Generated] Review request for Microsoft.Media/Streaming to add version stable/2022-11-01

[StephanieHan]

This is a PR generated at OpenAPI Hub. You can view your work branch via this link.

ARM API Information (Control Plane)

Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.

Changelog

Add a changelog entry for this PR by answering the following questions:

1. What's the purpose of the update?
   • [ ] new service onboarding
   • [x] new API version
   • [ ] update existing version for new feature
   • [ ] update existing version to fix swagger quality issue in s360
   • [ ] Other, please clarify
2. When are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month.
3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
4. By default, Azure SDKs of all languages (.NET/Python/Java/JavaScript for both management-plane SDK and data-plane SDK, Go for management-plane SDK only ) MUST be refreshed with/after swagger of new version is published. If you prefer NOT to refresh any specific SDK language upon swagger updates in the current PR, please leave details with justification here.

Contribution checklist (MS Employees Only):

• [x] I commit to follow the Breaking Change Policy of "no breaking changes"
• [x] I have reviewed the documentation for the workflow.
• [x] Validation tools were run on swagger spec(s) and errors have all been fixed in this PR. How to fix?

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

Applicability: :warning:

If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review.

• Change to data plane APIs
• Adding new properties
• All removals

Otherwise your PR may be subject to ARM review requirements. Complete the following:

• [x] Check this box if any of the following apply to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.

  • Adding a new service
  • Adding new API(s)
  • Adding a new API version -[ ] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki.

• [x] Ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.

• [ ] If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.

Breaking Change Review Checklist

If you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.

Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.

NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)

Please follow the link to find more details on PR review process.

[openapi-workflow-bot[bot]]

Hi, @StephanieHan Thanks for your PR. I am workflow bot for review process. Here are some small tips.

Please ensure to do self-check against checklists in first PR comment.

PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.

For specs comparison cross API versions, Use API Specs Comparison Report Generator

If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

Any feedback about review process or workflow bot, pls contact swagger and tools team. [email protected]

[openapi-pipeline-app[bot]]

Swagger Validation Report

️🔄BreakingChange inProgress [Detail]

️⌛Breaking Change(Cross-Version) pending [Detail]

️⌛CredScan pending [Detail]

️🔄LintDiff inProgress [Detail]

️⚠️Avocado: 1 Warnings warning [Detail]

Rule	Message
:warning: MULTIPLE_API_VERSION	The default tag contains multiple API versions swaggers. readme: specification/mediaservices/resource-manager/readme.md tag: specification/mediaservices/resource-manager/readme.md#tag-package-streaming-2022-11

️⌛ApiReadinessCheck pending [Detail]

️🔄~[Staging] ServiceAPIReadinessTest inProgress [Detail]

️️✔️ModelValidation succeeded [Detail] [Expand]

Validation passes for ModelValidation.

️️✔️SemanticValidation succeeded [Detail] [Expand]

Validation passes for SemanticValidation.

️⌛PoliCheck pending [Detail]

️️✔️PrettierCheck succeeded [Detail] [Expand]

Validation passes for PrettierCheck.

️️✔️SpellCheck succeeded [Detail] [Expand]

Validation passes for SpellCheck.

️️✔️Lint(RPaaS) succeeded [Detail] [Expand]

Validation passes for Lint(RPaaS).

️🔄CadlValidation inProgress [Detail]

️⌛PR Summary pending [Detail]

_{Posted by Swagger Pipeline | How to fix these errors?}

[openapi-pipeline-app[bot]]

Swagger Generation Artifacts

️🔄ApiDocPreview inProgress [Detail]

️⌛SDK Breaking Change Tracking pending [Detail]

_{Posted by Swagger Pipeline | How to fix these errors?}

[openapi-pipeline-app[bot]]

Generated ApiView

Language	Package Name	ApiView Link
Go	sdk/resourcemanager/mediaservices/armmediaservices	https://apiview.dev/Assemblies/Review/b34f4afe477544c58025eea7cf4862cf
JavaScript	@azure/arm-mediaservices	https://apiview.dev/Assemblies/Review/949ecbf093be488fa6df62a4844db5b5

[StephanieHan]

/azp run unifiedPipeline

[azure-pipelines[bot]]

No pipelines are associated with this pull request.

[openapi-workflow-bot[bot]]

Hi, @StephanieHan your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]).

[rkmanda]

"Status": {

should be modelled as a proxy resource with along with the top level envelope

---

Refers to: specification/mediaservices/resource-manager/Microsoft.Media/Streaming/stable/2022-11-01/streamingservice.json:2652 in 7ae44c4. [](commit_id = 7ae44c48f8994ed7e3a39407c4482bc95a391c6f, deletion_comment = False)

[rkmanda]

"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/liveEvents/{liveEventName}/trackIngestHeartbeat": {

resourceCollection names MUST be nouns and plural

---

Refers to: specification/mediaservices/resource-manager/Microsoft.Media/Streaming/stable/2022-11-01/streamingservice.json:587 in 7ae44c4. [](commit_id = 7ae44c48f8994ed7e3a39407c4482bc95a391c6f, deletion_comment = False)

[rkmanda]

"StreamEvent": {

model as proxy resource

---

Refers to: specification/mediaservices/resource-manager/Microsoft.Media/Streaming/stable/2022-11-01/streamingservice.json:2695 in 7ae44c4. [](commit_id = 7ae44c48f8994ed7e3a39407c4482bc95a391c6f, deletion_comment = False)

[rkmanda]

      "additionalProperties": {

is this user defined?

---

Refers to: specification/mediaservices/resource-manager/Microsoft.Media/Streaming/stable/2022-11-01/streamingservice.json:2709 in 7ae44c4. [](commit_id = 7ae44c48f8994ed7e3a39407c4482bc95a391c6f, deletion_comment = False)

[rkmanda]

"LiveEventStreamEventsGetResult": {

x-ms-pageable

---

Refers to: specification/mediaservices/resource-manager/Microsoft.Media/Streaming/stable/2022-11-01/streamingservice.json:2717 in 7ae44c4. [](commit_id = 7ae44c48f8994ed7e3a39407c4482bc95a391c6f, deletion_comment = False)

[rkmanda]

"LiveEventStatusGetResult": {

x-ms-pageable

---

Refers to: specification/mediaservices/resource-manager/Microsoft.Media/Streaming/stable/2022-11-01/streamingservice.json:2682 in 7ae44c4. [](commit_id = 7ae44c48f8994ed7e3a39407c4482bc95a391c6f, deletion_comment = False)

[rkmanda]

      "additionalProperties": {

is this user defined?

---

Refers to: specification/mediaservices/resource-manager/Microsoft.Media/Streaming/stable/2022-11-01/streamingservice.json:2740 in 7ae44c4. [](commit_id = 7ae44c48f8994ed7e3a39407c4482bc95a391c6f, deletion_comment = False)

[rkmanda]

"LiveEventTrackIngestHeartbeatGetResult": {

x-ms-pageable

---

Refers to: specification/mediaservices/resource-manager/Microsoft.Media/Streaming/stable/2022-11-01/streamingservice.json:2748 in 7ae44c4. [](commit_id = 7ae44c48f8994ed7e3a39407c4482bc95a391c6f, deletion_comment = False)

[rkmanda]

"TrackEvent": {

model as proxy resource

---

Refers to: specification/mediaservices/resource-manager/Microsoft.Media/Streaming/stable/2022-11-01/streamingservice.json:2730 in 7ae44c4. [](commit_id = 7ae44c48f8994ed7e3a39407c4482bc95a391c6f, deletion_comment = False)

[rkmanda]

      "additionalProperties": {

remove all free form objects or provide a justification for why you need it?

---

In reply to: 1286419741

---

Refers to: specification/mediaservices/resource-manager/Microsoft.Media/Streaming/stable/2022-11-01/streamingservice.json:2709 in 0b59b3e. [](commit_id = 0b59b3e6849c2d77c77a0a2efa33b3f463ca0c8a, deletion_comment = False)

[rkmanda]

    "operationId": "LiveEvents_TrackIngestHeartbeat",

Please fix the operation names as per the suggestions provided in the lintdiff pipeline evaluation under Checks > ~[Staging] Swagger Lintdiff

---

Refers to: specification/mediaservices/resource-manager/Microsoft.Media/Streaming/stable/2022-11-01/streamingservice.json:594 in 7ae44c4. [](commit_id = 7ae44c48f8994ed7e3a39407c4482bc95a391c6f, deletion_comment = False)

[rkmanda]

    "operationId": "LiveEvents_TrackIngestHeartbeat",

Please check other warnings there and fix as well

---

In reply to: 1286422340

---

Refers to: specification/mediaservices/resource-manager/Microsoft.Media/Streaming/stable/2022-11-01/streamingservice.json:594 in 0b59b3e. [](commit_id = 0b59b3e6849c2d77c77a0a2efa33b3f463ca0c8a, deletion_comment = False)

[openapi-workflow-bot[bot]]

Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove ARMChangesRequested

[StephanieHan]

"Status": {

should be modelled as a proxy resource with along with the top level envelope

---

Do we need to model it as a proxy resource even if it's not an ARM resource? Those three new added endpoints are to get some telemetry data of the live event(which is an ARM resource). They are just like the ArmStreamingEndpointSkuInfo entity (which is not modelled as a proxy resource) which exists already.

---

In reply to: 1286415766

[StephanieHan]

      "additionalProperties": {

remove all free form objects or provide a justification for why you need it?

---

This is not user defined. We need these free form objects because we have to return different set of data inside the data field for different eventType. For example this list will be returned:

[ 
{ 
  “eventType”: “/StreamEvent/Ingestion/FirstChunkReceived”, 
  “eventTime”: “2022-04-25T12:01:00.0000”, 
  “level”: “4”, 
  “data”: { 
    “streamid”: “mystream”, 
    “mediatype”: “video”, 
    “trackname”: “video”, 
    “bitrate”: 1600000, 
    “mediatimestamp”: “6030”, 
    “duration”: 180000, 
    “timescale”: 90000, 
    “resultcode”: “S_OK” 
    “ResultMessage”: “succeeded”, 
    “resolution”: “1024x576” 
  } 
},
{ 
  “eventType”: “/StreamEvent/Ingestion/BeginIngest”, 
  “eventTime”: “2022-04-25T12:00:00.0000”, 
  “level”: “4”, 
  “data”: { 
    “streamname”: “video”, 
    “resultcode”: “S_OK” 
    “ResultMessage”: “succeeded” 
  } 
} 
] 

We'll document what's the data set for each eventType for customers.

---

In reply to: 1286421118

[openapi-workflow-bot[bot]]

Hi @StephanieHan, one or multiple validation error/warning suppression(s) is detected in your PR. Please follow the Swagger-Suppression-Process to get approval.

[openapi-workflow-bot[bot]]

Hi @StephanieHan, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff. If you have any questions, please post your questions in this channel https://aka.ms/swaggersupport.

Task	How to fix	Priority
Avocado	Fix-Avocado	High
Semantic validation	Fix-SemanticValidation-Error	High
Model validation	Fix-ModelValidation-Error	High
LintDiff	Fix-LintDiff	high

If you need further help, please feedback via swagger feedback.

[StephanieHan]

"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/liveEvents/{liveEventName}/trackIngestHeartbeat": {

resourceCollection names MUST be nouns and plural

---

How about the name of another one? "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/liveEvents/{liveEventName}/status". Is it good to use status?

---

In reply to: 1286417977

[giakas]

"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/liveEvents/{liveEventName}/trackIngestHeartbeat": {

resourceCollection names MUST be nouns and plural

How about the name of another one? "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/liveEvents/{liveEventName}/status". Is it good to use status?

In reply to: 1286417977

This is kind of the reason I am asking if these calls should be a POST, since they are not returning ARM resources. and might be confusing to the customers.

[zizw123]

"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/liveEvents/{liveEventName}/trackIngestHeartbeats": {

Like rkmanda mentioned, please check the lintdiff for this

---

Refers to: specification/mediaservices/resource-manager/Microsoft.Media/Streaming/stable/2022-11-01/streamingservice.json:593 in aef67ad. [](commit_id = aef67ad340dda57cd4c084983cb71849f8bb6ea0, deletion_comment = False)

[giakas]

/azp run

[azure-pipelines[bot]]

Azure Pipelines successfully started running 1 pipeline(s).

[openapi-pipeline-app[bot]]

Swagger Generation Artifacts

️🔄ApiDocPreview inProgress [Detail]

️️✔️SDK Breaking Change Tracking succeeded [Detail] [Expand]

Breaking Changes Tracking

️⌛ azure-sdk-for-net-track2 pending [Detail]

️⌛ azure-sdk-for-python-track2 pending [Detail]

️⌛ azure-sdk-for-go pending [Detail]

_{Posted by Swagger Pipeline | How to fix these errors?}