[Compute] New API Version 2021-08-01 #17118

haagha · 2021-12-16T17:29:08Z

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

Changelog

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

What's the purpose of the update?
- new service onboarding
- 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.
If updating an existing version, please select the specific langauge SDKs and CLIs that must be refreshed after the swagger is published.
- SDK of .NET (need service team to ensure code readiness)
- SDK of Python
- SDK of Java
- SDK of Js
- SDK of Go
- PowerShell
- CLI
- Terraform
- No refresh required for updates in this PR

Contribution checklist:

I commit to follow the Breaking Change Policy of "no breaking changes"
I have reviewed the documentation for the workflow.
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: ⚠️

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:

Check this box if any of the following apply to the PR so that label "WaitForARMFeedback" will be added automatically to begin ARM API Review. Failure to comply may result in delays to the manifest.
- Adding a new service
- Adding new API(s)
- Adding a new API version
  -[x] 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.
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 any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.

Removing API(s) in a stable version
Removing properties in a stable version
Removing API version(s) in a stable version
Updating API in a stable or public preview version with Breaking Change Validation errors
Updating API(s) in public preview over 1 year (refer to Retirement of Previews)

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

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

* Add supportedCapabilities in SnapshotUpdateProperties model * Add an example for update acceleratedNetwork on snapshots * Fix example model * clean up

* DiskRP swagger changes for TVM and CVM of version 2021-08-01 * adding examples for CVM * fix errors * fix errors * fix unreferences example file * fix for: additional properties not allowed error * fix spell check error * fix spell check for secureVMDiskEncryptionSetId property * fix prettier check * addressing comment * addressing comments

* RRP changes * Fix prettier

openapi-workflow-bot · 2021-12-16T17:29:12Z

Hi, @haagha 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-workflow-bot · 2021-12-16T17:29:13Z

[Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks.

openapi-pipeline-app · 2021-12-16T17:29:13Z

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]

There are no breaking changes.

️🔄LintDiff inProgress [Detail]

️⚠️Avocado: 1 Warnings warning [Detail]

Rule	Message
⚠️ MULTIPLE_API_VERSION	The default tag contains multiple API versions swaggers. readme: specification/compute/resource-manager/readme.md tag: specification/compute/resource-manager/readme.md#tag-package-2021-08-01

️️✔️~[Staging] ApiReadinessCheck succeeded [Detail] [Expand]

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

Validation passes for ModelValidation.

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

Validation passes for SemanticValidation.

️⚠️Cross-Version Breaking Changes: 18 Warnings warning [Detail]

Compared Swaggers (Based on Oad v0.9.1)
- current:stable/2021-08-01/disk.json compared with base:stable/2021-04-01/disk.json
- current:stable/2021-08-01/disk.json compared with base:preview/2016-04-30-preview/disk.json

The following breaking changes are detected by comparison with latest preview version:

Rule	Message
⚠️ 1006 - RemovedDefinition	The new version is missing a definition that was found in the old version. Was 'EncryptionSettings' removed or renamed? New: Microsoft.Compute/stable/2021-08-01/disk.json#L1851:3 Old: Microsoft.Compute/preview/2016-04-30-preview/disk.json#L693:3
⚠️ 1032 - DifferentAllOf	The new version has a different 'allOf' property than the previous one. New: Microsoft.Compute/stable/2021-08-01/disk.json#L156:13 Old: Microsoft.Compute/preview/2016-04-30-preview/disk.json#L108:13
⚠️ 1032 - DifferentAllOf	The new version has a different 'allOf' property than the previous one. New: Microsoft.Compute/stable/2021-08-01/disk.json#L521:13 Old: Microsoft.Compute/preview/2016-04-30-preview/disk.json#L448:13
⚠️ 1032 - DifferentAllOf	The new version has a different 'allOf' property than the previous one. New: Microsoft.Compute/stable/2021-08-01/disk.json#L1948:5 Old: Microsoft.Compute/preview/2016-04-30-preview/disk.json#L755:5
⚠️ 1032 - DifferentAllOf	The new version has a different 'allOf' property than the previous one. New: Microsoft.Compute/stable/2021-08-01/disk.json#L3085:5 Old: Microsoft.Compute/preview/2016-04-30-preview/disk.json#L1077:5
⚠️ 1033 - RemovedProperty	The new version is missing a property found in the old version. Was 'accountType' renamed or removed? New: Microsoft.Compute/stable/2021-08-01/disk.json#L2076:7 Old: Microsoft.Compute/preview/2016-04-30-preview/disk.json#L789:7
⚠️ 1033 - RemovedProperty	The new version is missing a property found in the old version. Was 'encryptionSettings' renamed or removed? New: Microsoft.Compute/stable/2021-08-01/disk.json#L2076:7 Old: Microsoft.Compute/preview/2016-04-30-preview/disk.json#L789:7
⚠️ 1033 - RemovedProperty	The new version is missing a property found in the old version. Was 'ownerId' renamed or removed? New: Microsoft.Compute/stable/2021-08-01/disk.json#L2076:7 Old: Microsoft.Compute/preview/2016-04-30-preview/disk.json#L789:7
⚠️ 1033 - RemovedProperty	The new version is missing a property found in the old version. Was 'accountType' renamed or removed? New: Microsoft.Compute/stable/2021-08-01/disk.json#L2594:7 Old: Microsoft.Compute/preview/2016-04-30-preview/disk.json#L910:7
⚠️ 1033 - RemovedProperty	The new version is missing a property found in the old version. Was 'creationData' renamed or removed? New: Microsoft.Compute/stable/2021-08-01/disk.json#L2594:7 Old: Microsoft.Compute/preview/2016-04-30-preview/disk.json#L910:7
⚠️ 1033 - RemovedProperty	The new version is missing a property found in the old version. Was 'encryptionSettings' renamed or removed? New: Microsoft.Compute/stable/2021-08-01/disk.json#L2594:7 Old: Microsoft.Compute/preview/2016-04-30-preview/disk.json#L910:7
⚠️ 1033 - RemovedProperty	The new version is missing a property found in the old version. Was 'properties' renamed or removed? New: Microsoft.Compute/stable/2021-08-01/disk.json#L3045:7 Old: Microsoft.Compute/preview/2016-04-30-preview/disk.json#L1034:7
⚠️ 1033 - RemovedProperty	The new version is missing a property found in the old version. Was 'accountType' renamed or removed? New: Microsoft.Compute/stable/2021-08-01/disk.json#L2227:7 Old: Microsoft.Compute/preview/2016-04-30-preview/disk.json#L789:7
⚠️ 1033 - RemovedProperty	The new version is missing a property found in the old version. Was 'encryptionSettings' renamed or removed? New: Microsoft.Compute/stable/2021-08-01/disk.json#L2227:7 Old: Microsoft.Compute/preview/2016-04-30-preview/disk.json#L789:7
⚠️ 1033 - RemovedProperty	The new version is missing a property found in the old version. Was 'ownerId' renamed or removed? New: Microsoft.Compute/stable/2021-08-01/disk.json#L2227:7 Old: Microsoft.Compute/preview/2016-04-30-preview/disk.json#L789:7
⚠️ 1033 - RemovedProperty	The new version is missing a property found in the old version. Was 'accountType' renamed or removed? New: Microsoft.Compute/stable/2021-08-01/disk.json#L2684:7 Old: Microsoft.Compute/preview/2016-04-30-preview/disk.json#L910:7
⚠️ 1033 - RemovedProperty	The new version is missing a property found in the old version. Was 'creationData' renamed or removed? New: Microsoft.Compute/stable/2021-08-01/disk.json#L2684:7 Old: Microsoft.Compute/preview/2016-04-30-preview/disk.json#L910:7
⚠️ 1033 - RemovedProperty	The new version is missing a property found in the old version. Was 'encryptionSettings' renamed or removed? New: Microsoft.Compute/stable/2021-08-01/disk.json#L2684:7 Old: Microsoft.Compute/preview/2016-04-30-preview/disk.json#L910:7

️️✔️CredScan succeeded [Detail] [Expand]

There is no credential detected.

️️✔️SDK Track2 Validation succeeded [Detail] [Expand]

Validation passes for SDKTrack2Validation

The following tags are being changed in this PR

️️✔️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).

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

openapi-pipeline-app · 2021-12-16T17:29:14Z

Swagger pipeline restarted successfully, please wait for status update in this comment.

haagha · 2021-12-16T17:31:58Z

@mentat9 breaking changes were approved in a previous PR #16099

openapi-workflow-bot · 2021-12-16T17:33:26Z

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

openapi-workflow-bot · 2021-12-16T17:47:21Z

Hi @haagha, 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.

mentat9 · 2021-12-17T02:25:35Z

    "getSecureVMGuestStateSAS": {

ARM recommends string enums over boolean. Generally enums make better properties than booleans. They are more descriptive, flexible and future-proof while being easier for customers to discover, understand and use. Ref: https://armwiki.azurewebsites.net/rp_onboarding/process/api_review_best_practices.html?q=boolean#common-issues-found-in-review.

In this case, you could do something more like this: "getSecureVMGuestState": [ None, SAS ].

Refers to: specification/compute/resource-manager/Microsoft.Compute/stable/2021-08-01/disk.json:3033 in 5dd4670. [](commit_id = 5dd4670, deletion_comment = False)

mentat9 · 2021-12-17T02:25:44Z

@haagha, your first commit in the new PR already has edits (version changed to 2021-11-01). When adding a new API version, please carefully follow the process for constructing your PR. This is really important to help streamline the workload for ARM reviewers and handle your PR in as timely a manner as possible. The first commit should be the files from the current API version, unmodified. Changes (including updating the version) should go into subsequent commits.

All of that notwithstanding, to avoid another round trip, I manually diffed your PR update against the most recent API version of the disk.json file checked into the public repo. Since the changes are modest and straightforward, I'll complete the review on the current PR.

mentat9 · 2021-12-17T20:42:15Z

    "getSecureVMGuestStateSAS": {
ARM recommends string enums over boolean. Generally enums make better properties than booleans. They are more descriptive, flexible and future-proof while being easier for customers to discover, understand and use. Ref: https://armwiki.azurewebsites.net/rp_onboarding/process/api_review_best_practices.html?q=boolean#common-issues-found-in-review.

In this case, you could do something more like this: "getSecureVMGuestState": [ None, SAS ].

Refers to: specification/compute/resource-manager/Microsoft.Compute/stable/2021-08-01/disk.json:3033 in 5dd4670. [](commit_id = 5dd4670, deletion_comment = False)

Note, this suggestion doesn't block ARM signoff, but you should consider making a change like this.

haagha · 2021-12-17T21:09:38Z

@mentat9 We will make note of this for future releases, but IF Possible I would like to move forward with the current boolean type because the team wants to do a private preview soon, and making this change would require re-deployment of API and ARM manifest that could cause quite long delays. Thanks.

haagha · 2021-12-17T21:12:19Z

@ArcturusZhang Are these new linting rules resulting in linting errors? Is this PR ready to be merged?

ArcturusZhang · 2021-12-22T09:30:21Z

@ArcturusZhang Are these new linting rules resulting in linting errors? Is this PR ready to be merged?

The linter errors can be ignored.

haagha · 2021-12-22T19:00:23Z

@ArcturusZhang the breaking changes are from a previous PR #16099 And ARM has signed off so I believe we can merge.

Here is the SDK PR Azure/azure-sdk-for-net#25436

* new folder and files added for diskRP 2021-08-01 * Adding Location header to LRO responses examples * Add supportedCapabilities in SnapshotUpdateProperties model (Azure#16768) * Add supportedCapabilities in SnapshotUpdateProperties model * Add an example for update acceleratedNetwork on snapshots * Fix example model * clean up * DiskRP swagger changes for TVM and CVM of version 2021-08-01 (Azure#16671) * DiskRP swagger changes for TVM and CVM of version 2021-08-01 * adding examples for CVM * fix errors * fix errors * fix unreferences example file * fix for: additional properties not allowed error * fix spell check error * fix spell check for secureVMDiskEncryptionSetId property * fix prettier check * addressing comment * addressing comments * DiskRP Swagger changes for Remote Restore Point scenarios (Azure#16636) * RRP changes * Fix prettier * including communityGallery.json in package * suppress bodytoplevelproperties Co-authored-by: Theodore Chang <[email protected]> Co-authored-by: LU WU <[email protected]> Co-authored-by: anshulsolanki21 <[email protected]> Co-authored-by: sukodava <[email protected]>

grizzlytheodore and others added 7 commits December 16, 2021 12:14

new folder and files added for diskRP 2021-08-01

1dae97b

Adding Location header to LRO responses examples

0d54b65

Add supportedCapabilities in SnapshotUpdateProperties model (#16768)

0436634

* Add supportedCapabilities in SnapshotUpdateProperties model * Add an example for update acceleratedNetwork on snapshots * Fix example model * clean up

DiskRP Swagger changes for Remote Restore Point scenarios (#16636)

2f954e5

* RRP changes * Fix prettier

including communityGallery.json in package

8e443f6

suppress bodytoplevelproperties

5dd4670

haagha requested review from dkulkarni-ms, grizzlytheodore, hyonholee, madewithsmiles, MS-syh2qs and Sandido as code owners December 16, 2021 17:29

openapi-assignment-bot bot assigned ArcturusZhang Dec 16, 2021

ghost added the Compute label Dec 16, 2021

haagha mentioned this pull request Dec 16, 2021

Compute New API version 2021-08-01 #16945

Closed

25 tasks

haagha assigned mentat9 Dec 16, 2021

openapi-workflow-bot bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Dec 16, 2021

openapi-pipeline-app bot added the CI-FixRequiredOnFailure label Dec 16, 2021

openapi-sdkautomation bot mentioned this pull request Dec 16, 2021

[AutoPR compute] [Compute] New API Version 2021-08-01 AzureSDKAutomation/azure-resource-manager-schemas#5296

Draft

openapi-sdkautomation bot mentioned this pull request Dec 16, 2021

[AutoPR track2_azure-mgmt-compute] [Compute] New API Version 2021-08-01 AzureSDKAutomation/azure-sdk-for-python#8434

Draft

openapi-pipeline-app bot added the CI-BreakingChange-Python-Track2 label Dec 16, 2021

mentat9 added the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Dec 17, 2021

mentat9 added ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review and removed WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Dec 17, 2021

ArcturusZhang approved these changes Dec 22, 2021

View reviewed changes

msyyc added the Approved-SdkBreakingChange-Python label Dec 23, 2021

ArcturusZhang merged commit 14b3b50 into main Dec 28, 2021

This was referenced Jun 1, 2022

Trusted Launch CLI Change Request - VM Disk Snapshot & Config wangzelin007/github-bot-tutorial#20

Closed

Trusted Launch CLI Change Request - VM Disk Snapshot & Config Azure/azure-cli#22275

Closed

JackTn deleted the feature/cplat-2021-08-01-new branch June 16, 2022 00:49

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Compute] New API Version 2021-08-01 #17118

[Compute] New API Version 2021-08-01 #17118

haagha commented Dec 16, 2021 •

edited

Loading

openapi-workflow-bot bot commented Dec 16, 2021

openapi-workflow-bot bot commented Dec 16, 2021

openapi-pipeline-app bot commented Dec 16, 2021 •

edited

Loading

openapi-pipeline-app bot commented Dec 16, 2021 •

edited

Loading

haagha commented Dec 16, 2021

openapi-workflow-bot bot commented Dec 16, 2021

openapi-workflow-bot bot commented Dec 16, 2021

mentat9 commented Dec 17, 2021

mentat9 commented Dec 17, 2021

mentat9 commented Dec 17, 2021

haagha commented Dec 17, 2021

haagha commented Dec 17, 2021

ArcturusZhang commented Dec 22, 2021

haagha commented Dec 22, 2021

[Compute] New API Version 2021-08-01 #17118

[Compute] New API Version 2021-08-01 #17118

Conversation

haagha commented Dec 16, 2021 • edited Loading

Changelog

Contribution checklist:

ARM API Review Checklist

Breaking Change Review Checklist

openapi-workflow-bot bot commented Dec 16, 2021

openapi-workflow-bot bot commented Dec 16, 2021

openapi-pipeline-app bot commented Dec 16, 2021 • edited Loading

Swagger Validation Report

openapi-pipeline-app bot commented Dec 16, 2021 • edited Loading

haagha commented Dec 16, 2021

openapi-workflow-bot bot commented Dec 16, 2021

openapi-workflow-bot bot commented Dec 16, 2021

mentat9 commented Dec 17, 2021

mentat9 commented Dec 17, 2021

mentat9 commented Dec 17, 2021

haagha commented Dec 17, 2021

haagha commented Dec 17, 2021

ArcturusZhang commented Dec 22, 2021

haagha commented Dec 22, 2021

haagha commented Dec 16, 2021 •

edited

Loading

openapi-pipeline-app bot commented Dec 16, 2021 •

edited

Loading

openapi-pipeline-app bot commented Dec 16, 2021 •

edited

Loading