Fix PublicIP Sku property names #14782

basharg · 2021-06-11T21:52:31Z

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

Rename PublicIP Sku properties. The existing names are incorrect. These are related to a new set of features that have not been GA'ed yet. There is no current customers using these properties beside our tests. The new names/schema reflects what networking swagger files have defined.

Validation missed the inconsistencies due to issues in the service layer which we are actively working to fix.

Breaking change request: https://msazure.visualstudio.com/One/_workitems/edit/10132460

Changelog

Please ensure to add changelog with 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 you are targeting to deploy new service/feature to public regions? Please provide date, or month to public if date is not available yet.
When you expect to publish swagger? Please provide date, or month to public if date is not available yet.
If it's an update to existing version, please select SDKs of specific language and CLIs that require refresh after 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, no need to refresh 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

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.
- Adding new API(s)
- Adding a new API version
- Ensure to copy the existing version into new directory structure for first commit (including refactoring) and then push new changes including version updates in separate commits. This is required to review the changes efficiently.
- Adding a new service
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 Breaking Change Review Board as defined in the Breaking Change Policy.

Removing API(s) in stable version
Removing properties in stable version
Removing API version(s) in stable version
Updating API in 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.

Merge from azure/azure-rest-api-specs

openapi-workflow-bot · 2021-06-11T21:52:33Z

Hi, @basharg 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-06-11T21:52:34Z

[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-06-11T21:52:35Z

Swagger Validation Report

️❌BreakingChange: 4 Errors, 0 Warnings failed [Detail]

Compared Swaggers (Based on Oad v0.8.11)
- current:stable/2021-03-01/compute.json compared with base:stable/2021-03-01/compute.json

Rule	Message
`❌` 1033 - RemovedProperty	The new version is missing a property found in the old version. Was 'publicIPAddressSkuName' renamed or removed? New: Microsoft.Compute/stable/2021-03-01/compute.json#L10399:7 Old: Microsoft.Compute/stable/2021-03-01/compute.json#L10399:7
`❌` 1033 - RemovedProperty	The new version is missing a property found in the old version. Was 'publicIPAddressSkuTier' renamed or removed? New: Microsoft.Compute/stable/2021-03-01/compute.json#L10399:7 Old: Microsoft.Compute/stable/2021-03-01/compute.json#L10399:7
`❌` 1041 - AddedPropertyInResponse	The new version has a new property 'name' in response that was not found in the old version. New: Microsoft.Compute/stable/2021-03-01/compute.json#L10399:7 Old: Microsoft.Compute/stable/2021-03-01/compute.json#L10399:7
`❌` 1041 - AddedPropertyInResponse	The new version has a new property 'tier' in response that was not found in the old version. New: Microsoft.Compute/stable/2021-03-01/compute.json#L10399:7 Old: Microsoft.Compute/stable/2021-03-01/compute.json#L10399:7

️🔄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-03-01

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

Validation passes for ModelValidation.

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

Validation passes for SemanticValidation.

️️✔️Cross-Version Breaking Changes succeeded [Detail] [Expand]

There are no breaking changes.

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

There is no credential detected.

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

The following tags are being changed in this PR

The following errors/warnings are introduced by current PR:

|:speech_balloon: AutorestCore/Exception|"readme":"compute/resource-manager/readme.md",
"tag":"package-2021-03-01",
"details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"compute/resource-manager/readme.md",
"tag":"package-2021-03-01",
"details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|

The following errors/warnings exist before current PR submission:

Rule	Message
`❌` PreCheck/DuplicateSchema	"readme":"compute/resource-manager/readme.md", "tag":"package-2021-03-01", "details":"Duplicate Schema named PurchasePlan -- properties.promotionCode: undefined => "$ref":"#/components/schemas/schemas:1441", "description":"The Offer Promotion Code." ; This error can be temporarily avoided by using the 'modelerfour.lenient-model-deduplication' setting. NOTE: This setting will be removed in a future version of @autorest/modelerfour; schemas should be updated to fix this issue sooner than that."
`❌` AutorestCore/Exception	"readme":"compute/resource-manager/readme.md", "tag":"package-2021-03-01", "details":"Error: Plugin prechecker reported failure."
💬 AutorestCore/Exception	"readme":"compute/resource-manager/readme.md", "tag":"package-2021-03-01", "details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"
💬 AutorestCore/Exception	"readme":"compute/resource-manager/readme.md", "tag":"package-2021-03-01-only", "details":"> Loading AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"
💬 AutorestCore/Exception	"readme":"compute/resource-manager/readme.md", "tag":"package-2021-03-01-only", "details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"

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

Validation passes for PrettierCheck.

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

Validation passes for SpellCheck.

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

Validation passes for Lint(RPaaS).

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

openapi-pipeline-app · 2021-06-11T21:52:35Z

Swagger Generation Artifacts

️️✔️[Staging] ApiDocPreview succeeded [Detail] [Expand]

 Please click here to preview with your @microsoft account.

️❌[Staging] SDK Breaking Change Tracking failed [Detail]

Breaking Changes Tracking

❌azure-sdk-for-python-track2 - track2_azure-mgmt-compute - 21.0.0

+	Model PublicIPAddressSku has a new signature

️✔️azure-sdk-for-go - profiles/2020-09-01/compute/mgmt/compute - Approved - v55.3.0
️✔️azure-sdk-for-go - containerservice/mgmt/2017-01-31/containerservice - Approved - v55.3.0
️✔️azure-sdk-for-go - containerservice/mgmt/2016-09-30/containerservice - Approved - v55.3.0
️✔️azure-sdk-for-go - containerservice/mgmt/2016-03-30/containerservice - Approved - v55.3.0
❌azure-sdk-for-go - compute/mgmt/2021-03-01/compute - Approved - v55.3.0

+	Field `PublicIPAddressSkuName` of struct `PublicIPAddressSku` has been removed
+	Field `PublicIPAddressSkuTier` of struct `PublicIPAddressSku` has been removed

❌azure-sdk-for-go - compute/mgmt/2020-12-01/compute - Approved - v55.3.0

+	Type of `OrchestrationServiceStateInput.ServiceName` has been changed from `OrchestrationServiceNames` to `*string`

❌azure-sdk-for-go - compute/mgmt/2020-06-30/compute - Approved - v55.3.0

+	Field `ContentType` of struct `GalleryApplicationVersionPublishingProfile` has been removed
+	Field `FileName` of struct `UserArtifactSource` has been removed
+	Type of `OrchestrationServiceStateInput.ServiceName` has been changed from `OrchestrationServiceNames` to `*string`

❌azure-sdk-for-go - compute/mgmt/2020-06-01/compute - Approved - v55.3.0

+	Field `ContentType` of struct `GalleryApplicationVersionPublishingProfile` has been removed
+	Field `FileName` of struct `UserArtifactSource` has been removed
+	Type of `OrchestrationServiceStateInput.ServiceName` has been changed from `OrchestrationServiceNames` to `*string`

❌azure-sdk-for-go - compute/mgmt/2019-12-01/compute - Approved - v55.3.0

+	Field `ContentType` of struct `GalleryApplicationVersionPublishingProfile` has been removed
+	Field `FileName` of struct `UserArtifactSource` has been removed
+	Type of `OrchestrationServiceStateInput.ServiceName` has been changed from `OrchestrationServiceNames` to `*string`

❌azure-sdk-for-go - compute/mgmt/2019-07-01/compute - Approved - v55.3.0

+	Field `ContentType` of struct `GalleryApplicationVersionPublishingProfile` has been removed
+	Field `FileName` of struct `UserArtifactSource` has been removed

❌azure-sdk-for-go - compute/mgmt/2019-03-01/compute - Approved - v55.3.0

+	Field `ContentType` of struct `GalleryApplicationVersionPublishingProfile` has been removed
+	Field `FileName` of struct `UserArtifactSource` has been removed

️✔️azure-sdk-for-go - compute/mgmt/2018-10-01/compute - Approved - v55.3.0
️✔️azure-sdk-for-go - compute/mgmt/2018-06-01/compute - Approved - v55.3.0
️✔️azure-sdk-for-go - compute/mgmt/2018-04-01/compute - Approved - v55.3.0
️✔️azure-sdk-for-go - compute/mgmt/2017-12-01/compute - Approved - v55.3.0
️✔️azure-sdk-for-go - compute/mgmt/2017-09-01/skus - Approved - v55.3.0
️✔️azure-sdk-for-go - compute/mgmt/2017-03-30/compute - Approved - v55.3.0
️✔️azure-sdk-for-go - compute/mgmt/2016-03-30/compute - Approved - v55.3.0
️✔️azure-sdk-for-go - compute/mgmt/2015-06-15/compute - Approved - v55.3.0
️✔️azure-sdk-for-go - preview/containerservice/mgmt/2015-11-01-preview/containerservice - Approved - v55.3.0
❌azure-sdk-for-go - preview/compute/mgmt/2020-10-01-preview/compute - Approved - v55.3.0

+	Type of `OrchestrationServiceStateInput.ServiceName` has been changed from `OrchestrationServiceNames` to `*string`

️✔️azure-sdk-for-go - preview/compute/mgmt/2016-04-30-preview/compute - Approved - v55.3.0

️️✔️ azure-sdk-for-net succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from d920475. SDK Automation 14.0.0

warn	Skip initScript due to not configured
command	sudo apt-get install -y dotnet-sdk-5.0
command	autorest --version=V2 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION [email protected]/[email protected] --csharp-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/compute/resource-manager/readme.md
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied

️✔️Microsoft.Azure.Management.Compute [View full logs] [Release SDK Changes]
- Microsoft.Azure.Management.Compute.47.0.0.nupkg
- Microsoft.Azure.Management.Compute.47.0.0.snupkg

️⚠️ azure-sdk-for-python-track2 warning [Detail]

⚠️Warning [Logs]Release - Generate from d920475. SDK Automation 14.0.0

command	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

️✔️track2_azure-mgmt-compute [View full logs] [Release SDK Changes] Breaking Change Detected

info	[Changelog] **Features**
info	[Changelog]
info	[Changelog]   - Added operation DiskRestorePointOperations.begin_grant_access
info	[Changelog]   - Added operation DiskRestorePointOperations.begin_revoke_access
info	[Changelog]
info	[Changelog] **Breaking changes**
info	[Changelog]
info	[Changelog]   - Model PublicIPAddressSku has a new signature

️⚠️ azure-sdk-for-java warning [Detail]

⚠️Warning [Logs]Release - Generate from d920475. SDK Automation 14.0.0

command	./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json
command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
cmderr	[generate.py] 2021-06-21 02:49:00 INFO [VERSION][Not Found] cannot find version for "com.azure.resourcemanager:azure-resourcemanager-compute-generated"
cmderr	[generate.py] 2021-06-21 02:49:00 INFO [VERSION][Not Found] cannot find stable version, current version "1.0.0-beta.1"
cmderr	[generate.py] 2021-06-21 02:49:00 INFO autorest --version=3.1.3 --use=@autorest/[email protected] --java.azure-libraries-for-java-folder=/home/vsts/work/1/s/azure-sdk-for-java --java.output-folder=/home/vsts/work/1/s/azure-sdk-for-java/sdk/compute/azure-resourcemanager-compute-generated --java.namespace=com.azure.resourcemanager.compute.generated   --java --pipeline.modelerfour.additional-checks=false --pipeline.modelerfour.lenient-model-deduplication=true --azure-arm --verbose --sdk-integration --fluent=lite --java.fluent=lite --java.license-header=MICROSOFT_MIT_SMALL ../azure-rest-api-specs/specification/compute/resource-manager/readme.md
cmderr	[generate.py] 2021-06-21 02:50:40 INFO [CI][Success] Write to ci.yml
cmderr	[generate.py] 2021-06-21 02:50:40 INFO [POM][Process] dealing with pom.xml
cmderr	[generate.py] 2021-06-21 02:50:40 INFO [POM][Skip] pom already has module azure-resourcemanager-compute-generated
cmderr	[generate.py] 2021-06-21 02:50:40 INFO [POM][Success] Write to pom.xml
cmderr	[generate.py] 2021-06-21 02:50:40 INFO [POM][Process] dealing with root pom
cmderr	[generate.py] 2021-06-21 02:50:40 INFO [POM][Success] Write to root pom

️✔️azure-resourcemanager-compute-generated [View full logs] [Release SDK Changes]

cmderr	[Inst] 2021-06-21 02:55:48 DEBUG Got artifact_id: azure-resourcemanager-compute-generated
cmderr	[Inst] 2021-06-21 02:55:48 DEBUG Got artifact: pom.xml
cmderr	[Inst] 2021-06-21 02:55:48 DEBUG Got artifact: azure-resourcemanager-compute-generated-1.0.0-beta.1-sources.jar
cmderr	[Inst] 2021-06-21 02:55:48 DEBUG Got artifact: azure-resourcemanager-compute-generated-1.0.0-beta.1.jar
cmderr	[Inst] 2021-06-21 02:55:48 DEBUG Match jar package: azure-resourcemanager-compute-generated-1.0.0-beta.1.jar
cmderr	[Inst] 2021-06-21 02:55:48 DEBUG output: {"full": "```sh\ncurl -L \"https://portal.azure-devex-tools.com/api/sdk-dl-pub?p=Azure/14782/azure-sdk-for-java/azure-resourcemanager-compute-generated/azure-resourcemanager-compute-generated-1.0.0-beta.1.jar\" -o azure-resourcemanager-compute-generated-1.0.0-beta.1.jar\nmvn install:install-file -DgroupId=com.azure.resourcemanager -DartifactId=azure-resourcemanager-compute-generated -Dversion=1.0.0-beta.0 -Dfile=azure-resourcemanager-compute-generated-1.0.0-beta.1.jar -Dpackaging=jar -DgeneratePom=true
```"}

️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from d920475. SDK Automation 14.0.0

warn	Skip initScript due to not configured
command	autorest --version=V2 --typescript --license-header=MICROSOFT_MIT_NO_VERSION [email protected]/[email protected] --typescript-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-js/azure-sdk-for-js ../../azure-rest-api-specs/specification/compute/resource-manager/readme.md

️✔️@azure/arm-compute [View full logs] [Release SDK Changes]

azure-arm-compute-16.2.0.tgz

cmderr	[npmPack] loaded rollup.config.js with warnings
cmderr	[npmPack] (!) Unused external imports
cmderr	[npmPack] default imported from external module 'rollup' but never used
cmderr	[npmPack] ./esm/computeManagementClient.js → ./dist/arm-compute.js...
cmderr	[npmPack] created ./dist/arm-compute.js in 1.6s

️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from d920475. SDK Automation 14.0.0

command	sh ./initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
command	generator automation ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json

️✔️profiles/2020-09-01/compute/mgmt/compute [View full logs] [Release SDK Changes]
```
info	[Changelog] This is a new package
```
️✔️containerservice/mgmt/2017-01-31/containerservice [View full logs] [Release SDK Changes]
```
info	[Changelog] No exported changes
```
️✔️containerservice/mgmt/2016-09-30/containerservice [View full logs] [Release SDK Changes]
```
info	[Changelog] No exported changes
```
️✔️containerservice/mgmt/2016-03-30/containerservice [View full logs] [Release SDK Changes]
```
info	[Changelog] No exported changes
```

️✔️compute/mgmt/2021-03-01/compute [View full logs] [Release SDK Changes] Breaking Change Detected