Azure
Calec/new api version
ARM (Control Plane) API Specification Update Pull Request
Purpose of this PR
What's the purpose of this PR? Check all that apply. This is mandatory!
- [x] New API version. (Such PR should have been generated with OpenAPI Hub, per this wiki doc.)
- [ ] Update existing version for a new feature. (This is applicable only when you are revising a private preview API version.)
- [ ] Update existing version to fix swagger quality issues in S360.
- [ ] Other, please clarify:
- edit this with your clarification
Due diligence checklist
To merge this PR, you must go through the following checklist and confirm you understood and followed the instructions by checking all the boxes:
- [x] I have reviewed the general guidance on the spec PR review process: https://aka.ms/specprreview.
- [x] I confirm this PR is modifying Azure Resource Manager (ARM) related specifications, and not data-plane related specifications.
- [x] I commit to follow the Breaking Change Policy.
- [x] I have reviewed following Resource Provider guidelines, including
ARM resource provider contract and
REST guidelines (estimated time: 4 hours).
I understand this is required before I can request review from an ARM API Review board.
ARM API changes review
- If you want for the ARM team to review this PR, you must add the
ARMReviewlabel. - The automation may automatically add the
ARMReviewlabel, if appropriate.
If this happens, proceed according to guidance given in GitHub comments also added by the automation.
Breaking change review
If you have any breaking changes as defined in the Breaking Change Policy, follow the process outlined in the High-level Breaking Change Process doc.
Getting help
- For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure and https://aka.ms/ci-fix.
- For additional help, see https://aka.ms/azsdk/support/spectools.
Hi, @calecarter 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 succeeded [Detail] [Expand]
There are no breaking changes.
️❌Breaking Change(Cross-Version): 55 Errors, 73 Warnings failed [Detail]
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| policyAssignments.json | 2023-04-01(5a7178b) | 2022-06-01(main) |
| policyAssignments.json | 2023-04-01(5a7178b) | 2017-06-01-preview(main) |
| policyDefinitions.json | 2023-04-01(5a7178b) | 2021-06-01(main) |
| policySetDefinitions.json | 2023-04-01(5a7178b) | 2021-06-01(main) |
| policySetDefinitions.json | 2023-04-01(5a7178b) | 2017-06-01-preview(main) |
The following breaking changes are detected by comparison with the latest stable version:
Only 30 items are listed, please refer to log for more details.
The following breaking changes are detected by comparison with the latest preview version:
Only 30 items are listed, please refer to log for more details.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 6 Warnings warning [Detail]
| compared tags (via openapi-validator v2.1.4) | new version | base version |
|---|---|---|
| package-policy-2023-04 | package-policy-2023-04(5a7178b) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| :warning: PostOperationIdContainsUrlVerb | OperationId should contain the verb: 'listpolicydefinitionversions' in:'PolicyDefinitionVersions_ListAllBuiltins'. Consider updating the operationId Location: Microsoft.Authorization/stable/2023-04-01/policyDefinitionVersions.json#L42 |
|
| :warning: PostOperationIdContainsUrlVerb | OperationId should contain the verb: 'listpolicydefinitionversions' in:'PolicyDefinitionVersions_ListAllAtManagementGroup'. Consider updating the operationId Location: Microsoft.Authorization/stable/2023-04-01/policyDefinitionVersions.json#L76 |
|
| :warning: PostOperationIdContainsUrlVerb | OperationId should contain the verb: 'listpolicydefinitionversions' in:'PolicyDefinitionVersions_ListAll'. Consider updating the operationId Location: Microsoft.Authorization/stable/2023-04-01/policyDefinitionVersions.json#L113 |
|
| :warning: PostOperationIdContainsUrlVerb | OperationId should contain the verb: 'listpolicysetdefinitionversions' in:'PolicySetDefinitionVersions_ListAllBuiltins'. Consider updating the operationId Location: Microsoft.Authorization/stable/2023-04-01/policySetDefinitionVersions.json#L42 |
|
| :warning: PostOperationIdContainsUrlVerb | OperationId should contain the verb: 'listpolicysetdefinitionversions' in:'PolicySetDefinitionVersions_ListAllAtManagementGroup'. Consider updating the operationId Location: Microsoft.Authorization/stable/2023-04-01/policySetDefinitionVersions.json#L76 |
|
| :warning: PostOperationIdContainsUrlVerb | OperationId should contain the verb: 'listpolicysetdefinitionversions' in:'PolicySetDefinitionVersions_ListAll'. Consider updating the operationId Location: Microsoft.Authorization/stable/2023-04-01/policySetDefinitionVersions.json#L113 |
️❌Avocado: 1 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
The readme file has more than one default tag. readme: specification/resources/resource-manager/readme.md |
️❌SwaggerAPIView: 0 Errors, 0 Warnings failed [Detail]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️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).
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
![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-go - sdk/resourcemanager/resources/armpolicy - Approved - 0.8.0+ Function `NewClientFactory` parameter(s) have been changed from `(string, azcore.TokenCredential, *arm.ClientOptions)` to `(string, string, string, string, azcore.TokenCredential, *arm.ClientOptions)`
❌azure-sdk-for-js - @azure/arm-policy - Approved - 6.0.0-beta.1+ Class PolicyClient has a new signature + Operation PolicyAssignments.list has a new signature + Operation PolicyAssignments.listForResource has a new signature + Operation PolicyAssignments.listForResourceGroup has a new signature + Operation PolicyDefinitions.createOrUpdate has a new signature + Operation PolicyDefinitions.delete has a new signature + Operation PolicyDefinitions.get has a new signature + Operation PolicyDefinitions.list has a new signature + Operation PolicySetDefinitions.createOrUpdate has a new signature + Operation PolicySetDefinitions.delete has a new signature + Operation PolicySetDefinitions.get has a new signature + Operation PolicySetDefinitions.list has a new signature
️⚠️ azure-sdk-for-net-track2 warning [Detail]
⚠️Warning [Logs]Release - Generate from b1f57e54d560d162ff7c715103158aa020dad2c9. 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 warn No file changes detected after generation
️✔️Azure.ResourceManager.Resources [View full logs]info [Changelog]
️❌ azure-sdk-for-python-track2 failed [Detail]
❌Code Generator Failed [Logs]Release - Generate from b1f57e54d560d162ff7c715103158aa020dad2c9. 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! 9.6.7 -> 10.1.0 cmderr [automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.1.0> cmderr [automation_generate.sh] npm notice Run `npm install -g [email protected]` to update! cmderr [automation_generate.sh] npm notice cmdout [automation_generate.sh] [Autorest]/mnt/vss/_work/1/s/azure-sdk-for-python_tmp/venv-sdk/auto_temp.json does not exist!!!Error happened during codegen error Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-python]: sh scripts/automation_generate.sh warn Skip package processing as generation is failed
️⚠️ azure-sdk-for-java warning [Detail]
⚠️Warning [Logs]Release - Generate from b1f57e54d560d162ff7c715103158aa020dad2c9. 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 is available: 23.0.1 -> 23.2.1 cmderr [init.sh] [notice] To update, run: pip install --upgrade pip cmderr [init.sh] [notice] A new release of pip is available: 23.0.1 -> 23.2.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
️✔️azure-resourcemanager-resources-generated [View full logs] [Release SDK Changes]
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
️✔️Succeeded [Logs]Release - Generate from b1f57e54d560d162ff7c715103158aa020dad2c9. 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
- Only show 11 items here, please refer to log for details.
️✔️sdk/resourcemanager/resources/armresources [View full logs] [Release SDK Changes] Breaking Change Detectedinfo [Changelog] - Operation `*TagsClient.CreateOrUpdateAtScope` has been changed to LRO, use `*TagsClient.BeginCreateOrUpdateAtScope` instead. info [Changelog] - Operation `*TagsClient.DeleteAtScope` has been changed to LRO, use `*TagsClient.BeginDeleteAtScope` instead. info [Changelog] - Operation `*TagsClient.UpdateAtScope` has been changed to LRO, use `*TagsClient.BeginUpdateAtScope` instead. info [Changelog] info [Changelog] ### Features Added info [Changelog] info [Changelog] - New struct `DeploymentParameter` info [Changelog] - New struct `KeyVaultParameterReference` info [Changelog] - New struct `KeyVaultReference` info [Changelog] info [Changelog] Total 5 breaking change(s), 6 additive change(s).
️✔️sdk/resourcemanager/resources/armdeploymentscripts [View full logs] [Release SDK Changes]info [Changelog] ### Other Changes info [Changelog] info [Changelog] Total 0 breaking change(s), 0 additive change(s).
️✔️sdk/resourcemanager/resources/armfeatures [View full logs] [Release SDK Changes]info [Changelog] ### Other Changes info [Changelog] info [Changelog] Total 0 breaking change(s), 0 additive change(s).
️✔️sdk/resourcemanager/resources/armlinks [View full logs] [Release SDK Changes]info [Changelog] ### Other Changes info [Changelog] info [Changelog] Total 0 breaking change(s), 0 additive change(s).
️✔️sdk/resourcemanager/resources/armlocks [View full logs] [Release SDK Changes]info [Changelog] ### Other Changes info [Changelog] info [Changelog] Total 0 breaking change(s), 0 additive change(s).
️✔️sdk/resourcemanager/resources/armmanagedapplications [View full logs] [Release SDK Changes]info [Changelog] ### Other Changes info [Changelog] info [Changelog] Total 0 breaking change(s), 0 additive change(s).
- Only show 11 items here, please refer to log for details.
️✔️sdk/resourcemanager/resources/armpolicy [View full logs] [Release SDK Changes] Breaking Change Detectedinfo [Changelog] - New struct `VariableValueColumnValue` info [Changelog] - New struct `VariableValueListResult` info [Changelog] - New struct `VariableValueProperties` info [Changelog] - New field `Overrides`, `ResourceSelectors` in struct `AssignmentProperties` info [Changelog] - New field `Properties` in struct `AssignmentUpdate` info [Changelog] - New field `Version`, `Versions` in struct `DefinitionProperties` info [Changelog] - New field `AssignmentScopeValidation`, `ResourceSelectors` in struct `ExemptionProperties` info [Changelog] - New field `Schema` in struct `ParameterDefinitionsValue` info [Changelog] - New field `Version`, `Versions` in struct `SetDefinitionProperties` info [Changelog] info [Changelog] Total 1 breaking change(s), 107 additive change(s).
️✔️sdk/resourcemanager/resources/armsubscriptions [View full logs] [Release SDK Changes]info [Changelog] ### Other Changes info [Changelog] info [Changelog] Total 0 breaking change(s), 0 additive change(s).
️✔️sdk/resourcemanager/resources/armtemplatespecs [View full logs] [Release SDK Changes]info [Changelog] ### Other Changes info [Changelog] info [Changelog] Total 0 breaking change(s), 0 additive change(s).
️✔️sdk/resourcemanager/resources/armchanges [View full logs] [Release SDK Changes]info [Changelog] ### Other Changes info [Changelog] info [Changelog] Total 0 breaking change(s), 0 additive change(s).
️✔️sdk/resourcemanager/resources/armdeploymentstacks [View full logs] [Release SDK Changes]info [Changelog] ### Other Changes info [Changelog] info [Changelog] Total 0 breaking change(s), 0 additive change(s).
️🔄 azure-sdk-for-js inProgress [Detail]
️❌ azure-resource-manager-schemas failed [Detail]
❌Pipeline Framework Failed [Logs]Release - Generate from b1f57e54d560d162ff7c715103158aa020dad2c9. 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] npm notice cmderr [initScript.sh] npm notice New major version of npm available! 8.19.4 -> 10.1.0 cmderr [initScript.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.1.0> cmderr [initScript.sh] npm notice Run `npm install -g [email protected]` to update! cmderr [initScript.sh] npm notice 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 cannot force update branch 'sdkAuto/resources' as it is the current HEAD of the repository. Error: cannot force update branch 'sdkAuto/resources' as it is the current HEAD of the repository.
️✔️resources [View full logs] [Release Schema Changes]️✔️resources [View full logs]error Fatal error: cannot force update branch 'sdkAuto/resources' as it is the current HEAD of the repository. error The following packages are still pending: error resources error resources error resources error resources
️✔️resources️✔️resources
️❌ azure-powershell failed [Detail]
❌Pipeline Framework Failed [Logs]Release - Generate from b1f57e54d560d162ff7c715103158aa020dad2c9. 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 SSL error: syscall failure: Broken pipe Error: SSL error: syscall failure: Broken pipe
⚠️Az.resources.DefaultTag [View full logs]error Fatal error: SSL error: syscall failure: Broken pipe error The following packages are still pending: error Az.resources.DefaultTag
Generated ApiView
| Language | Package Name | ApiView Link |
|---|---|---|
| Go | sdk/resourcemanager/resources/armchanges | There is no API change compared with the previous version |
| Go | sdk/resourcemanager/resources/armdeploymentscripts | https://apiview.dev/Assemblies/Review/0dd895fcc6ba46fca0c2ec0aa39b9bd4 |
| Go | sdk/resourcemanager/resources/armdeploymentstacks | https://apiview.dev/Assemblies/Review/cea4bebc259d463dbf381e45095307fa |
| Go | sdk/resourcemanager/resources/armfeatures | There is no API change compared with the previous version |
| Go | sdk/resourcemanager/resources/armlinks | There is no API change compared with the previous version |
| Go | sdk/resourcemanager/resources/armlocks | There is no API change compared with the previous version |
| Go | sdk/resourcemanager/resources/armmanagedapplications | https://apiview.dev/Assemblies/Review/2f4ef9016cac46b09d515302c25de169 |
| Go | sdk/resourcemanager/resources/armpolicy | https://apiview.dev/Assemblies/Review/4ee3742a9ea74e4d91d5797e0f669efe |
| Go | sdk/resourcemanager/resources/armresources | https://apiview.dev/Assemblies/Review/bcf353f198e54dd3ae0e6786cbcec0bd |
| Go | sdk/resourcemanager/resources/armsubscriptions | There is no API change compared with the previous version |
| Go | sdk/resourcemanager/resources/armtemplatespecs | There is no API change compared with the previous version |
| .Net | Azure.ResourceManager.Resources | There is no API change compared with the previous version |
Hi @calecarter! For review efficiency consideration, when creating a new API version, it is required to place API specs of the base version in the first commit, and push new version updates into successive commits. You can use OpenAPIHub to initialize the PR for adding a new version.
For more details refer to the wiki. #Resolved
Hi @calecarter! Your PR has some issues. Please fix the CI issues, if present, in following order: Avocado, SemanticValidation, ModelValidation, Breaking Change, LintDiff.
| 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 reach out on the Teams channel aka.ms/azsdk/support/specreview-channel. #Resolved
@calecarter You have a large number of Lint validation failures introduced in this PR : https://github.com/Azure/azure-rest-api-specs/pull/24542/checks?check_run_id=15028691475 Can you please fix them before starting ARM review ? #Resolved
Please address or respond to feedback from the ARM API reviewer.
When you are ready to continue the ARM API review, please remove the ARMChangesRequested label.
This will notify the reviewer to have another look.
If the feedback provided needs further discussion, please use this Teams channel to post your questions - aka.ms/azsdk/support/specreview-channel.
Please include [ARM Query] in the title of your question to indicate that it is ARM-related. #Resolved
Hi @calecarter! The automation detected breaking changes in this pull request. As a result, it added the BreakingChangeReviewRequired label.
You cannot proceed with merging this PR until you complete one of the following action items:
ACTION ITEM ALTERNATIVE A: Fix the breaking change.
Please consult the documentation provided in the relevant validation failures.
ACTION ITEM ALTERNATIVE B: Request approval.
Alternatively, if you cannot fix the breaking changes, then you can request an approval for them. Please follow the process described in the High-level Breaking Change Process doc.
ACTION ITEM ALTERNATIVE C: Report false positive.
If you think there are no breaking changes, i.e. the validation should pass yet it fails, then proceed as explained in ACTION ITEM ALTERNATIVE B.
This applies even if the breaking change tool fails with internal runtime error. In such case a manual breaking change review is necessary. #Resolved
Hi @calecarter, one or multiple validation error/warning suppression(s) is detected in your PR. Please follow the Swagger-Suppression-Process to get approval. #Resolved
All linter errors have been addressed. I don't understand the Avacado error so need help with that. All of the breaking changes flagged in this PR are due to linter fixes. There are no REST layer changes to existing APIs. #Resolved
Please address or respond to feedback from the ARM API reviewer.
When you are ready to continue the ARM API review, please remove the ARMChangesRequested label.
This will notify the reviewer to have another look.
If the feedback provided needs further discussion, please use this Teams channel to post your questions - aka.ms/azsdk/support/specreview-channel.
Please include [ARM Query] in the title of your question to indicate that it is ARM-related.
![azure-pipelines[bot] avatar](https://avatars.githubusercontent.com/in/9426?v=4 "Published by a pub.dev verified publisher"){kind=small}
Hi, @calecarter. 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. #Closed
![microsoft-github-policy-service[bot] avatar](https://avatars.githubusercontent.com/in/95686?v=4 "Published by a pub.dev verified publisher"){kind=small}
Hi, @calecarter. 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. #Closed
Hi, @calecarter. 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. #Closed
Hi, @calecarter. 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. #Closed
Hi, @calecarter. 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. #Closed
Hi, @calecarter. 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. #Closed
Hi, @calecarter. 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. #Closed
Hi, @calecarter. 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. #Closed
Next Steps to Merge
✔️ All automated merging requirements have been met! Refer to step 4 in the PR workflow diagram (even if your PR is for data plane, not ARM).
Hi, @calecarter. 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. #Closed
Hi, @calecarter. 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. #Closed
Hi, @calecarter. 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. #Closed
Hi, @calecarter. 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. #Closed
Hi, @calecarter. 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. #Closed