update comments for UserData #14191

roipmsft · 2021-04-29T14:48:31Z

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.

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.

openapi-workflow-bot · 2021-04-29T14:48:34Z

Hi, @roipmsft 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. vsswagger@microsoft.com

openapi-workflow-bot · 2021-04-29T14:48:35Z

[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-04-29T14:48:35Z

Swagger Validation Report

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

There are no breaking changes.

️⚠️LintDiff: 0 Warnings warning [Detail]

Linted configuring files (Based on source branch, openapi-validator v1.9.2 , classic-openapi-validator v1.1.6 )
- compute/resource-manager/readme.md tag:package-2021-03-01
Linted configuring files (Based on target branch, openapi-validator v1.9.2 , classic-openapi-validator v1.1.6 )
- compute/resource-manager/readme.md tag:package-2021-03-01

The following errors/warnings exist before current PR submission:

Only 10 items are listed, please refer to log for more details.

Rule	Message
`❌` D5001 - XmsExamplesRequired	Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations. Location: Microsoft.Compute/stable/2021-03-01/compute.json#L36
`❌` D5001 - XmsExamplesRequired	Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations. Operation: 'Disks_Delete' Location: Microsoft.Compute/stable/2020-12-01/disk.json#L223
`❌` D5001 - XmsExamplesRequired	Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations. Operation: 'Disks_GrantAccess' Location: Microsoft.Compute/stable/2020-12-01/disk.json#L327
`❌` D5001 - XmsExamplesRequired	Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations. Operation: 'Disks_RevokeAccess' Location: Microsoft.Compute/stable/2020-12-01/disk.json#L374
`❌` D5001 - XmsExamplesRequired	Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations. Operation: 'Snapshots_Update' Location: Microsoft.Compute/stable/2020-12-01/disk.json#L465
`❌` D5001 - XmsExamplesRequired	Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations. Operation: 'Snapshots_Delete' Location: Microsoft.Compute/stable/2020-12-01/disk.json#L544
`❌` D5001 - XmsExamplesRequired	Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations. Operation: 'Snapshots_GrantAccess' Location: Microsoft.Compute/stable/2020-12-01/disk.json#L648
`❌` D5001 - XmsExamplesRequired	Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations. Operation: 'Snapshots_RevokeAccess' Location: Microsoft.Compute/stable/2020-12-01/disk.json#L695
`❌` R2020 - RequiredPropertiesMissingInResourceModel	Model definition 'SubResourceWithColocationStatus' must have the properties 'name', 'id' and 'type' in its hierarchy and these properties must be marked as readonly. Location: Microsoft.Compute/stable/2021-03-01/compute.json#L7941
`❌` R2026 - AvoidAnonymousTypes	Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models. Location: Microsoft.Compute/stable/2021-03-01/compute.json#L10795

️⚠️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 BreakingChange (Base on preview version): 12 Errors, 4 Warnings failed [Detail]

Compared Swaggers (Based on Oad v0.8.9)
- original: preview/2016-04-30-preview/compute.json <---> new: stable/2021-03-01/compute.json

Only 10 items are listed, please refer to log for more details.

Rule	Message
`❌` 1008 - ModifiedOperationId	The operation id has been changed from 'VirtualMachines_GetExtensions' to 'VirtualMachineExtensions_List'. This will impact generated code. New: Microsoft.Compute/stable/2021-03-01/compute.json#L1826:7 Old: Microsoft.Compute/preview/2016-04-30-preview/compute.json#L646:7
`❌` 1033 - RemovedProperty	The new version is missing a property found in the old version. Was 'managed' renamed or removed? New: Microsoft.Compute/stable/2021-03-01/compute.json#L7841:7 Old: Microsoft.Compute/preview/2016-04-30-preview/compute.json#L3160: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-03-01/compute.json#L9382:7 Old: Microsoft.Compute/preview/2016-04-30-preview/compute.json#L3687:7
`❌` 1033 - RemovedProperty	The new version is missing a property found in the old version. Was 'overProvision' renamed or removed? New: Microsoft.Compute/stable/2021-03-01/compute.json#L12505:7 Old: Microsoft.Compute/preview/2016-04-30-preview/compute.json#L5144:7
`❌` 1037 - ConstraintIsWeaker	The new version has a less constraining 'enum' value than the previous one. New: Microsoft.Compute/stable/2021-03-01/compute.json#L9438:9 Old: Microsoft.Compute/preview/2016-04-30-preview/compute.json#L3723:9
`❌` 1037 - ConstraintIsWeaker	The new version has a less constraining 'enum' value than the previous one. New: Microsoft.Compute/stable/2021-03-01/compute.json#L9819:9 Old: Microsoft.Compute/preview/2016-04-30-preview/compute.json#L3925:9
`❌` 1037 - ConstraintIsWeaker	The new version has a less constraining 'enum' value than the previous one. New: Microsoft.Compute/stable/2021-03-01/compute.json#L10779:9 Old: Microsoft.Compute/preview/2016-04-30-preview/compute.json#L4400:9
`❌` 1037 - ConstraintIsWeaker	The new version has a less constraining 'enum' value than the previous one. New: Microsoft.Compute/stable/2021-03-01/compute.json#L3266:11 Old: Microsoft.Compute/preview/2016-04-30-preview/compute.json#L1443:11
`❌` 1037 - ConstraintIsWeaker	The new version has a less constraining 'enum' value than the previous one. New: Microsoft.Compute/stable/2021-03-01/compute.json#L11176:9 Old: Microsoft.Compute/preview/2016-04-30-preview/compute.json#L4579:9
`❌` 1037 - ConstraintIsWeaker	The new version has a less constraining 'enum' value than the previous one. New: Microsoft.Compute/stable/2021-03-01/compute.json#L11584:9 Old: Microsoft.Compute/preview/2016-04-30-preview/compute.json#L4834:9

️❌Cross Version BreakingChange (Base on stable version): 4 Errors, 0 Warnings failed [Detail]

Compared Swaggers (Based on Oad v0.8.9)
- original: stable/2020-12-01/compute.json <---> new: stable/2021-03-01/compute.json

Rule	Message
`❌` 1037 - ConstraintIsWeaker	The new version has a less constraining 'enum' value than the previous one. New: Microsoft.Compute/stable/2021-03-01/compute.json#L785:11 Old: Microsoft.Compute/stable/2020-12-01/compute.json#L785:11
`❌` 1037 - ConstraintIsWeaker	The new version has a less constraining 'enum' value than the previous one. New: Microsoft.Compute/stable/2021-03-01/compute.json#L1081:11 Old: Microsoft.Compute/stable/2020-12-01/compute.json#L1080:11
`❌` 1037 - ConstraintIsWeaker	The new version has a less constraining 'enum' value than the previous one. New: Microsoft.Compute/stable/2021-03-01/compute.json#L3266:11 Old: Microsoft.Compute/stable/2020-12-01/compute.json#L3243:11
`❌` 1037 - ConstraintIsWeaker	The new version has a less constraining 'enum' value than the previous one. New: Microsoft.Compute/stable/2021-03-01/compute.json#L6808:11 Old: Microsoft.Compute/stable/2020-12-01/compute.json#L6277:11

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

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

openapi-pipeline-app · 2021-04-29T14:48:36Z

Swagger Generation Artifacts

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

 Please click here to preview with your @microsoft account.

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

️✔️Succeeded [Logs] Generate from 232fb20f03c8b397beff48b694724e2da7425a81. SDK Automation 14.0.0

command	sh ./initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
command	go run ./tools/generator/main.go ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json

️✔️containerservice/mgmt/2017-01-31/containerservice [View full logs] [Preview SDK Changes]
```
info	[Changelog] No exported changes
```
️✔️containerservice/mgmt/2016-09-30/containerservice [View full logs] [Preview SDK Changes]
```
info	[Changelog] No exported changes
```
️✔️containerservice/mgmt/2016-03-30/containerservice [View full logs] [Preview SDK Changes]
```
info	[Changelog] No exported changes
```

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