Update VirtualMachineSizeTypes enum description to add deprecation note and recommended usage to get up-to-date sizes using APIs #11598
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
avinashakka
requested review from
dkulkarni-ms,
grizzlytheodore,
haagha,
hyonholee,
madewithsmiles,
MS-syh2qs and
Sandido
as code owners
Swagger Validation Report
|
| Rule | Message |
|---|---|
| The default tag contains multiple API versions swaggers. readme: specification/compute/resource-manager/readme.md tag: specification/compute/resource-manager/readme.md#tag-package-2020-12-01 |
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️⚠️[Staging] Cross Version BreakingChange (Base on preview version): 71 Warnings warning [Detail]
Only 10 items are listed, please refer to log for more details.
- Compared Swaggers (Based on Oad v0.8.1)
- original: preview/2016-04-30-preview/compute.json <---> new: stable/2020-12-01/compute.json
| Rule | Message |
|---|---|
| The operation id has been changed from 'VirtualMachines_GetExtensions' to 'VirtualMachineExtensions_List'. This will impact generated code. New: Microsoft.Compute/stable/2020-12-01/compute.json#L1824:7 Old: Microsoft.Compute/preview/2016-04-30-preview/compute.json#L646:7 |
|
| The new version is adding enum value(s) 'Standard_A1_v2, Standard_A2_v2, Standard_A4_v2, Standard_A8_v2, Standard_A2m_v2, Standard_A4m_v2, Standard_A8m_v2, Standard_B1s, Standard_B1ms, Standard_B2s, Standard_B2ms, Standard_B4ms, Standard_B8ms, Standard_D2_v3, Standard_D4_v3, Standard_D8_v3, Standard_D16_v3, Standard_D32_v3, Standard_D64_v3, Standard_D2s_v3, Standard_D4s_v3, Standard_D8s_v3, Standard_D16s_v3, Standard_D32s_v3, Standard_D64s_v3, Standard_DS13-4_v2, Standard_DS13-2_v2, Standard_DS14-8_v2, Standard_DS14-4_v2, Standard_E2_v3, Standard_E4_v3, Standard_E8_v3, Standard_E16_v3, Standard_E32_v3, Standard_E64_v3, Standard_E2s_v3, Standard_E4s_v3, Standard_E8s_v3, Standard_E16s_v3, Standard_E32s_v3, Standard_E64s_v3, Standard_E32-16_v3, Standard_E32-8s_v3, Standard_E64-32s_v3, Standard_E64-16s_v3, Standard_F1, Standard_F2, Standard_F4, Standard_F8, Standard_F16, Standard_F1s, Standard_F2s, Standard_F4s, Standard_F8s, Standard_F16s, Standard_F2s_v2, Standard_F4s_v2, Standard_F8s_v2, Standard_F16s_v2, Standard_F32s_v2, Standard_F64s_v2, Standard_F72s_v2, Standard_GS4-8, Standard_GS4-4, Standard_GS5-16, Standard_GS5-8, Standard_H8, Standard_H16, Standard_H8m, Standard_H16m, Standard_H16r, Standard_H16mr, Standard_L4s, Standard_L8s, Standard_L16s, Standard_L32s, Standard_M64s, Standard_M64ms, Standard_M128s, Standard_M128ms, Standard_M64-32ms, Standard_M64-16ms, Standard_M128-64ms, Standard_M128-32ms, Standard_NC6, Standard_NC12, Standard_NC24, Standard_NC24r, Standard_NC6s_v2, Standard_NC12s_v2, Standard_NC24s_v2, Standard_NC24rs_v2, Standard_NC6s_v3, Standard_NC12s_v3, Standard_NC24s_v3, Standard_NC24rs_v3, Standard_ND6s, Standard_ND12s, Standard_ND24s, Standard_ND24rs, Standard_NV6, Standard_NV12, Standard_NV24' from the old version. New: Microsoft.Compute/stable/2020-12-01/compute.json#L8502:9 Old: Microsoft.Compute/preview/2016-04-30-preview/compute.json#L3723:9 |
|
| The new version has a different 'allOf' property than the previous one. New: Microsoft.Compute/stable/2020-12-01/compute.json#L10035:5 Old: Microsoft.Compute/preview/2016-04-30-preview/compute.json#L4594:5 |
|
| The new version has a different 'allOf' property than the previous one. New: Microsoft.Compute/stable/2020-12-01/compute.json#L10152:11 Old: Microsoft.Compute/preview/2016-04-30-preview/compute.json#L4708:11 |
|
| The new version has a different 'allOf' property than the previous one. New: Microsoft.Compute/stable/2020-12-01/compute.json#L10146:9 Old: Microsoft.Compute/preview/2016-04-30-preview/compute.json#L4702:9 |
|
| The new version has a different 'allOf' property than the previous one. New: Microsoft.Compute/stable/2020-12-01/compute.json#L10083:5 Old: Microsoft.Compute/preview/2016-04-30-preview/compute.json#L4657:5 |
|
| The new version is missing a property found in the old version. Was 'managed' renamed or removed? New: Microsoft.Compute/stable/2020-12-01/compute.json#L6984:7 Old: Microsoft.Compute/preview/2016-04-30-preview/compute.json#L3160:7 |
|
| The new version is missing a property found in the old version. Was 'caching' renamed or removed? New: Microsoft.Compute/stable/2020-12-01/compute.json#L10084:7 Old: Microsoft.Compute/preview/2016-04-30-preview/compute.json#L4658:7 |
|
| The new version is missing a property found in the old version. Was 'diskSizeGB' renamed or removed? New: Microsoft.Compute/stable/2020-12-01/compute.json#L10036:7 Old: Microsoft.Compute/preview/2016-04-30-preview/compute.json#L4595:7 |
|
| The new version is missing a property found in the old version. Was 'snapshot' renamed or removed? New: Microsoft.Compute/stable/2020-12-01/compute.json#L10084:7 Old: Microsoft.Compute/preview/2016-04-30-preview/compute.json#L4658:7 |
️⚠️[Staging] Cross Version BreakingChange (Base on stable version): 67 Warnings warning [Detail]
Only 10 items are listed, please refer to log for more details.
- Compared Swaggers (Based on Oad v0.8.1)
- original: stable/2020-06-01/compute.json <---> new: stable/2020-12-01/compute.json
Swagger Generation Artifacts
|
|
Azure Pipelines successfully started running 1 pipeline(s). |
azure-sdk-for-java
|
azure-resource-manager-schemas
|
azure-sdk-for-go
|
Azure CLI Extension Generation
No readme.md specification configuration files were found that are associated with the files modified in this pull request, or swagger_to_sdk section in readme.md is not configured
|
azure-sdk-for-python
|
azure-sdk-for-js
|
azure-sdk-for-net
|
Trenton Generation
No readme.md specification configuration files were found that are associated with the files modified in this pull request, or swagger_to_sdk section in readme.md is not configured
|
This was referenced Nov 9, 2020
This was referenced Nov 9, 2020
@changlong-liu hardwareProfile.properties.vmSize was defined as a string type previously and that remains unchanged. Previously provided enum for the possible values is being deprecated. Can you please elaborate on "I think changing type from enum to string is a breaking change"? |
pilor
added
the
ARMSignedOff
pilor
approved these changes
Nov 19, 2020
|
Hi @avinashakka , Previous defined enum in swagger brings enum definitions in SDK (for instance for Python: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/compute/azure-mgmt-compute/azure/mgmt/compute/v2020_06_01/models/_compute_management_client_enums.py#L374). Deleting the definition of that enum will break custom code which use these enum values. So it's a breaking change in theory. |
|
/azp run |
|
Hi @avinashakka any updates? |
|
Azure Pipelines successfully started running 2 pipeline(s). |
This was referenced Dec 9, 2020
avinashakka
changed the title
smotwani
reviewed
Dec 11, 2020
specification/compute/resource-manager/Microsoft.Compute/stable/2020-12-01/compute.json
Outdated
Show resolved
Hide resolved
smotwani
approved these changes
Dec 14, 2020
JeffreyRichter
added
the
Approved-BreakingChange
JeffreyRichter
requested review from
JeffreyRichter
and removed request for
JeffreyRichter
25 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Changelog
Please ensure to add changelog with this PR by answering the following questions.
Contribution checklist:
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.
Please 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 there are following updates in the PR, ensure to request an approval from API Review Board as defined in the Breaking Change Policy.
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.