azure-rest-api-specs
azure-rest-api-specs copied to clipboard
Azure
[Hub Generated] Review request for Microsoft.Media/Encoding to add version stable/2022-07-01
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:
- 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
- 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.
- When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
- 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.
-
[x] 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.
Hi, @Chuansssss Thanks for your PR. I am workflow bot for review process. Here are some small tips.
![openapi-workflow-bot[bot] avatar](https://avatars.githubusercontent.com/in/81125?v=4 "Published by a pub.dev verified publisher"){kind=small}
Swagger Validation Report
️⌛BreakingChange pending [Detail]
️⌛Breaking Change(Cross-Version) pending [Detail]
️⌛CredScan pending [Detail]
️⌛LintDiff pending [Detail]
️🔄Avocado inProgress [Detail]
️🔄ApiReadinessCheck inProgress [Detail]
️⌛~[Staging] ServiceAPIReadinessTest pending [Detail]
️🔄~[Staging] SwaggerAPIView inProgress [Detail]
️⌛~[Staging] CadlAPIView pending [Detail]
️❌ModelValidation: 2 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
id is required to return in response of GET/PUT resource calls but not being provided Url: Accounts/stable/2021-11-01/Accounts.json#L517:21 ExampleUrl: stable/2021-11-01/examples/accounts-get-by-name.json#L10:15 |
|
id is required to return in response of GET/PUT resource calls but not being provided Url: Accounts/stable/2021-11-01/Accounts.json#L517:21 ExampleUrl: stable/2021-11-01/examples/accounts-get-by-name.json#L10:15 |
️🔄SemanticValidation inProgress [Detail]
️⌛PoliCheck pending [Detail]
️🔄PrettierCheck inProgress [Detail]
️🔄SpellCheck inProgress [Detail]
️🔄Lint(RPaaS) inProgress [Detail]
️🔄CadlValidation inProgress [Detail]
️⌛PR Summary pending [Detail]
![openapi-pipeline-app[bot] avatar](https://avatars.githubusercontent.com/in/65541?v=4 "Published by a pub.dev verified publisher"){kind=small}
Swagger Generation Artifacts
️️✔️ApiDocPreview succeeded [Detail] [Expand]
Please click here to preview with your @microsoft account.
️❌SDK Breaking Change Tracking failed [Detail]
Breaking Changes Tracking
❌azure-sdk-for-js - @azure/arm-mediaservices - Approved - 14.0.0+ Interface AssetsListNextOptionalParams no longer has parameter filter + Interface AssetsListNextOptionalParams no longer has parameter orderby + Interface AssetsListNextOptionalParams no longer has parameter top + Interface ContentKeyPoliciesListNextOptionalParams no longer has parameter filter + Interface ContentKeyPoliciesListNextOptionalParams no longer has parameter orderby + Interface ContentKeyPoliciesListNextOptionalParams no longer has parameter top + Interface JobsListNextOptionalParams no longer has parameter filter + Interface JobsListNextOptionalParams no longer has parameter orderby + Interface StreamingLocatorsListNextOptionalParams no longer has parameter filter + Interface StreamingLocatorsListNextOptionalParams no longer has parameter orderby + Interface StreamingLocatorsListNextOptionalParams no longer has parameter top + Interface StreamingPoliciesListNextOptionalParams no longer has parameter filter + Interface StreamingPoliciesListNextOptionalParams no longer has parameter orderby + Interface StreamingPoliciesListNextOptionalParams no longer has parameter top + Interface TransformsListNextOptionalParams no longer has parameter filter + Interface TransformsListNextOptionalParams no longer has parameter orderby + Type of parameter odataType of interface Audio_2 is changed from "#Microsoft.Media.Audio" | "#Microsoft.Media.AacAudio" to "#Microsoft.Media.Audio" | "#Microsoft.Media.AacAudio" | "#Microsoft.Media.DDAudio" + Type of parameter odataType of interface Codec is changed from "#Microsoft.Media.Audio" | "#Microsoft.Media.AacAudio" | "#Microsoft.Media.Video" | "#Microsoft.Media.H265Video" | "#Microsoft.Media.CopyVideo" | "#Microsoft.Media.Image" | "#Microsoft.Media.CopyAudio" | "#Microsoft.Media.H264Video" | "#Microsoft.Media.JpgImage" | "#Microsoft.Media.PngImage" to "#Microsoft.Media.Audio" | "#Microsoft.Media.AacAudio" | "#Microsoft.Media.DDAudio" | "#Microsoft.Media.Video" | "#Microsoft.Media.H265Video" | "#Microsoft.Media.CopyVideo" | "#Microsoft.Media.Image" | "#Microsoft.Media.CopyAudio" | "#Microsoft.Media.H264Video" | "#Microsoft.Media.JpgImage" | "#Microsoft.Media.PngImage"
️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]
️✔️Succeeded [Logs]Release - Generate from 6e011aae8dd50b5acb4bd5e951f5b930a010bc41. SDK Automation 14.0.0command pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json command pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json
️✔️Azure.ResourceManager.Media [View full logs] [Release SDK Changes]info [Changelog]
️⚠️ azure-sdk-for-python-track2 warning [Detail]
⚠️Warning [Logs]Release - Generate from 6e011aae8dd50b5acb4bd5e951f5b930a010bc41. SDK Automation 14.0.0command sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json cmderr [automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed. command sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json cmderr [automation_generate.sh] cmderr [automation_generate.sh] npm notice New major version of npm available! 8.19.2 -> 9.2.0 cmderr [automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.2.0> cmderr [automation_generate.sh] npm notice Run `npm install -g [email protected]` to update! cmderr [automation_generate.sh] npm notice
️✔️track2_azure-mgmt-media [View full logs] [Release SDK Changes]info [Changelog] ### Features Added info [Changelog] info [Changelog] - Model Filters has a new parameter fade_in info [Changelog] - Model Filters has a new parameter fade_out info [Changelog] - Model StandardEncoderPreset has a new parameter experimental_options
️⚠️ azure-sdk-for-java warning [Detail]
⚠️Warning [Logs]Release - Generate from 6e011aae8dd50b5acb4bd5e951f5b930a010bc41. SDK Automation 14.0.0command ./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json cmderr [init.sh] [notice] A new release of pip available: 22.3 -> 22.3.1 cmderr [init.sh] [notice] To update, run: pip install --upgrade pip cmderr [init.sh] [notice] A new release of pip available: 22.3 -> 22.3.1 cmderr [init.sh] [notice] To update, run: pip install --upgrade pip command ./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json cmderr [generate.py] [ForkJoinPool-1-worker-3] INFO com.azure.core.test.implementation.TestingHelpers - Environment variable 'AZURE_TEST_MODE' has not been set yet. Using 'Playback' mode.
️✔️azure-resourcemanager-mediaservices [View full logs] [Release SDK Changes]
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
️✔️Succeeded [Logs]Release - Generate from 6e011aae8dd50b5acb4bd5e951f5b930a010bc41. SDK Automation 14.0.0command sh ./eng/scripts/automation_init.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json command generator automation-v2 ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
️✔️sdk/resourcemanager/mediaservices/armmediaservices [View full logs] [Release SDK Changes]info [Changelog] ### Features Added info [Changelog] info [Changelog] - New value `EncoderNamedPresetDDGoodQualityAudio` added to type alias `EncoderNamedPreset` info [Changelog] - New value `JobErrorCategoryAccount` added to type alias `JobErrorCategory` info [Changelog] - New value `JobErrorCodeIdentityUnsupported` added to type alias `JobErrorCode` info [Changelog] - New function `*DDAudio.GetAudio() *Audio` info [Changelog] - New function `*DDAudio.GetCodec() *Codec` info [Changelog] - New struct `DDAudio` info [Changelog] - New struct `Fade` info [Changelog] - New field `FadeIn` in struct `Filters` info [Changelog] - New field `FadeOut` in struct `Filters` info [Changelog] - New field `ExperimentalOptions` in struct `StandardEncoderPreset` info [Changelog] info [Changelog] Total 0 breaking change(s), 11 additive change(s).
️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
️✔️Succeeded [Logs]Release - Generate from 6e011aae8dd50b5acb4bd5e951f5b930a010bc41. SDK Automation 14.0.0command sh .scripts/automation_init.sh ../azure-sdk-for-js_tmp/initInput.json ../azure-sdk-for-js_tmp/initOutput.json warn File azure-sdk-for-js_tmp/initOutput.json not found to read command sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json
️✔️@azure/arm-mediaservices [View full logs] [Release SDK Changes] Breaking Change Detectedinfo [Changelog] **Features** info [Changelog] info [Changelog] - Added Interface DDAudio info [Changelog] - Added Interface Fade info [Changelog] - Interface Filters has a new optional parameter fadeIn info [Changelog] - Interface Filters has a new optional parameter fadeOut info [Changelog] - Interface StandardEncoderPreset has a new optional parameter experimentalOptions info [Changelog] - Enum KnownEncoderNamedPreset has a new value DDGoodQualityAudio info [Changelog] - Enum KnownJobErrorCategory has a new value Account info [Changelog] - Enum KnownJobErrorCode has a new value IdentityUnsupported info [Changelog] - Added function getContinuationToken info [Changelog] info [Changelog] **Breaking Changes** info [Changelog] info [Changelog] - Interface AssetsListNextOptionalParams no longer has parameter filter info [Changelog] - Interface AssetsListNextOptionalParams no longer has parameter orderby info [Changelog] - Interface AssetsListNextOptionalParams no longer has parameter top info [Changelog] - Interface ContentKeyPoliciesListNextOptionalParams no longer has parameter filter info [Changelog] - Interface ContentKeyPoliciesListNextOptionalParams no longer has parameter orderby info [Changelog] - Interface ContentKeyPoliciesListNextOptionalParams no longer has parameter top info [Changelog] - Interface JobsListNextOptionalParams no longer has parameter filter info [Changelog] - Interface JobsListNextOptionalParams no longer has parameter orderby info [Changelog] - Interface StreamingLocatorsListNextOptionalParams no longer has parameter filter info [Changelog] - Interface StreamingLocatorsListNextOptionalParams no longer has parameter orderby info [Changelog] - Interface StreamingLocatorsListNextOptionalParams no longer has parameter top info [Changelog] - Interface StreamingPoliciesListNextOptionalParams no longer has parameter filter info [Changelog] - Interface StreamingPoliciesListNextOptionalParams no longer has parameter orderby info [Changelog] - Interface StreamingPoliciesListNextOptionalParams no longer has parameter top info [Changelog] - Interface TransformsListNextOptionalParams no longer has parameter filter info [Changelog] - Interface TransformsListNextOptionalParams no longer has parameter orderby info [Changelog] - Type of parameter odataType of interface Audio_2 is changed from "#Microsoft.Media.Audio" | "#Microsoft.Media.AacAudio" to "#Microsoft.Media.Audio" | "#Microsoft.Media.AacAudio" | "#Microsoft.Media.DDAudio" info [Changelog] - Type of parameter odataType of interface Codec is changed from "#Microsoft.Media.Audio" | "#Microsoft.Media.AacAudio" | "#Microsoft.Media.Video" | "#Microsoft.Media.H265Video" | "#Microsoft.Media.CopyVideo" | "#Microsoft.Media.Image" | "#Microsoft.Media.CopyAudio" | "#Microsoft.Media.H264Video" | "#Microsoft.Media.JpgImage" | "#Microsoft.Media.PngImage" to "#Microsoft.Media.Audio" | "#Microsoft.Media.AacAudio" | "#Microsoft.Media.DDAudio" | "#Microsoft.Media.Video" | "#Microsoft.Media.H265Video" | "#Microsoft.Media.CopyVideo" | "#Microsoft.Media.Image" | "#Microsoft.Media.CopyAudio" | "#Microsoft.Media.H264Video" | "#Microsoft.Media.JpgImage" | "#Microsoft.Media.PngImage"
️⚠️ azure-resource-manager-schemas warning [Detail]
⚠️Warning [Logs]Release - Generate from 6e011aae8dd50b5acb4bd5e951f5b930a010bc41. Schema Automation 14.0.0command .sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json cmderr [initScript.sh] cmderr [initScript.sh] npm WARN old lockfile The package-lock.json file was created with an old version of npm, cmderr [initScript.sh] npm WARN old lockfile so supplemental metadata must be fetched from the registry. cmderr [initScript.sh] npm WARN old lockfile cmderr [initScript.sh] npm WARN old lockfile This is a one-time fix-up, please be patient... cmderr [initScript.sh] npm WARN old lockfile warn File azure-resource-manager-schemas_tmp/initOutput.json not found to read command .sdkauto/generateScript.sh ../azure-resource-manager-schemas_tmp/generateInput.json ../azure-resource-manager-schemas_tmp/generateOutput.json
️✔️mediaservices [View full logs] [Release Schema Changes]
️❌ azure-powershell failed [Detail]
❌Failed [Logs]Release - Generate from 6e011aae8dd50b5acb4bd5e951f5b930a010bc41. SDK Automation 14.0.0command sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json command pwsh ./tools/SwaggerCI/psci.ps1 ../azure-powershell_tmp/generateInput.json ../azure-powershell_tmp/generateOutput.json
❌Az.mediaservices [View full logs] [Release SDK Changes]
Generated ApiView
| Language | Package Name | ApiView Link |
|---|---|---|
| Go | sdk/resourcemanager/mediaservices/armmediaservices | https://apiview.dev/Assemblies/Review/594eaafbff86483db3ccdd565bf8d043 |
| .Net | Azure.ResourceManager.Media | https://apiview.dev/Assemblies/Review/ad355ee18e1f41f58422688240ac45e7 |
| Java | azure-resourcemanager-mediaservices | https://apiview.dev/Assemblies/Review/fb54812e93e54623902df8e0668d3c4c |
| JavaScript | @azure/arm-mediaservices | https://apiview.dev/Assemblies/Review/4f36c1694a9c4c1ebe448f014026e9a0 |
![azure-pipelines[bot] avatar](https://avatars.githubusercontent.com/in/9426?v=4 "Published by a pub.dev verified publisher"){kind=small}
Hi, @Chuansssss your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]).
"experimentalOptions": {
Are these user defined key value pairs?
Refers to: specification/mediaservices/resource-manager/Microsoft.Media/Encoding/stable/2022-07-01/Encoding.json:1546 in 78b7e5a. [](commit_id = 78b7e5a8324fbae41d02872bbdf7d0403cfcf1da, deletion_comment = False)
Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove ARMChangesRequested
"experimentalOptions": {Are these user defined key value pairs?
Refers to: specification/mediaservices/resource-manager/Microsoft.Media/Encoding/stable/2022-07-01/Encoding.json:1546 in 78b7e5a. [](commit_id = 78b7e5a, deletion_comment = False)
It is handled as ODataTypedValueDictionary
Hi @Chuansssss, one or multiple validation error/warning suppression(s) is detected in your PR. Please follow the Swagger-Suppression-Process to get approval.
"experimentalOptions": {
Per offline discussion. These are user defined keys and the service doesnt interpret the set of keys. Its modelled as a string due to the dependency on a different team that cannot provide support for the dictionary.
In reply to: 1286400514
Refers to: specification/mediaservices/resource-manager/Microsoft.Media/Encoding/stable/2022-07-01/Encoding.json:1546 in 78b7e5a. [](commit_id = 78b7e5a8324fbae41d02872bbdf7d0403cfcf1da, deletion_comment = False)
"experimentalOptions": {
suggested releasing this as a preview API version and modify the behavior of this property before going GA
In reply to: 1306380963
Refers to: specification/mediaservices/resource-manager/Microsoft.Media/Encoding/stable/2022-07-01/Encoding.json:1546 in 78b7e5a. [](commit_id = 78b7e5a8324fbae41d02872bbdf7d0403cfcf1da, deletion_comment = False)
Hi, @Chuansssss. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.
@qiaozha to approve JS breaking change @fengzhou-msft to check why .Net SDK track 2 generation failure @jianyexi to check why SuppressionReviewRequired
The azure-sdk-for-net-track2 failure is caused by the Fade.Duration property not having a format which is a specific requirement by .NET. It could be fixed in the autorest.md of azure-sdk-for-net later.
The
azure-sdk-for-net-track2failure is caused by theFade.Durationproperty not having a format which is a specific requirement by .NET. It could be fixed in theautorest.mdofazure-sdk-for-netlater.
@fengzhou-msft I think we should fix it in the PR. @Chuansssss can you add "format": "duration" to duration property. I don't have access to make changes to your fork.
Hi @Chuansssss, 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 |