adding update management APIs

[roramc]

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:

1. 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
2. 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.
3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
4. 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
    -[ ] 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.

[openapi-workflow-bot]

Hi, @roramc 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]

[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]

Swagger Validation Report

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

• Compared Swaggers (Based on Oad v0.9.0)
  • current:preview/2020-08-15-preview/HybridCompute.json compared with base:preview/2020-08-15-preview/HybridCompute.json

Rule	Message
❌ 1038 - AddedPath	The new version is adding a path that was not found in the old version. New: Microsoft.HybridCompute/preview/2020-08-15-preview/HybridCompute.json#L263:5
❌ 1038 - AddedPath	The new version is adding a path that was not found in the old version. New: Microsoft.HybridCompute/preview/2020-08-15-preview/HybridCompute.json#L320:5

️⚠️LintDiff: 3 Warnings warning [Detail]

• Linted configuring files (Based on source branch, openapi-validator v1.10.1 , classic-openapi-validator v1.1.10 )
  • hybridcompute/resource-manager/readme.md tag:package-preview-2020-08
• Linted configuring files (Based on target branch, openapi-validator v1.10.1 , classic-openapi-validator v1.1.10 )
  • hybridcompute/resource-manager/readme.md tag:package-preview-2020-08

The following errors/warnings are introduced by current PR:

Rule	Message
⚠️ R3018 - EnumInsteadOfBoolean	Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: rebootPending Location: Microsoft.HybridCompute/preview/2020-08-15-preview/HybridCompute.json#L1165
⚠️ R3018 - EnumInsteadOfBoolean	Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: excludeKbsRequiringReboot Location: Microsoft.HybridCompute/preview/2020-08-15-preview/HybridCompute.json#L1370
⚠️ R3018 - EnumInsteadOfBoolean	Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: maintenanceWindowExceeded Location: Microsoft.HybridCompute/preview/2020-08-15-preview/HybridCompute.json#L1459

The following errors/warnings exist before current PR submission:

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

Rule	Message
❌ R4009 - RequiredReadOnlySystemData	The response of operation:'Machines_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.HybridCompute/preview/2020-08-15-preview/HybridCompute.json#L200
❌ R4009 - RequiredReadOnlySystemData	The response of operation:'MachineExtensions_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.HybridCompute/preview/2020-08-15-preview/HybridCompute.json#L649
❌ R4009 - RequiredReadOnlySystemData	The response of operation:'PrivateLinkScopes_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.HybridCompute/preview/2020-08-15-preview/privateLinkScopes.json#L157
❌ R4009 - RequiredReadOnlySystemData	The response of operation:'PrivateLinkResources_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.HybridCompute/preview/2020-08-15-preview/privateLinkScopes.json#L342
❌ R4009 - RequiredReadOnlySystemData	The response of operation:'PrivateEndpointConnections_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.HybridCompute/preview/2020-08-15-preview/privateLinkScopes.json#L387
❌ R4009 - RequiredReadOnlySystemData	The response of operation:'PrivateLinkScopedResources_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.HybridCompute/preview/2020-08-15-preview/privateLinkScopes.json#L591
❌ R4009 - RequiredReadOnlySystemData	The response of operation:'Machines_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.HybridCompute/preview/2020-08-15-preview/HybridCompute.json#L38
❌ R4009 - RequiredReadOnlySystemData	The response of operation:'MachineExtensions_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.HybridCompute/preview/2020-08-15-preview/HybridCompute.json#L472
❌ R4009 - RequiredReadOnlySystemData	The response of operation:'PrivateLinkScopes_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.HybridCompute/preview/2020-08-15-preview/privateLinkScopes.json#L194
❌ R4009 - RequiredReadOnlySystemData	The response of operation:'PrivateEndpointConnections_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.HybridCompute/preview/2020-08-15-preview/privateLinkScopes.json#L434
❌ R4009 - RequiredReadOnlySystemData	The response of operation:'PrivateLinkScopedResources_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.HybridCompute/preview/2020-08-15-preview/privateLinkScopes.json#L638
❌ R4009 - RequiredReadOnlySystemData	The response of operation:'Machines_Update' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.HybridCompute/preview/2020-08-15-preview/HybridCompute.json#L95
❌ R4009 - RequiredReadOnlySystemData	The response of operation:'MachineExtensions_Update' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.HybridCompute/preview/2020-08-15-preview/HybridCompute.json#L534
❌ R4009 - RequiredReadOnlySystemData	The response of operation:'PrivateLinkScopes_UpdateTags' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.HybridCompute/preview/2020-08-15-preview/privateLinkScopes.json#L249
❌ R4010 - RequiredDefaultResponse	The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.HybridCompute/preview/2020-08-15-preview/HybridCompute.json#L516
❌ R4010 - RequiredDefaultResponse	The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.HybridCompute/preview/2020-08-15-preview/HybridCompute.json#L578
❌ R4010 - RequiredDefaultResponse	The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.HybridCompute/preview/2020-08-15-preview/HybridCompute.json#L631
❌ R4010 - RequiredDefaultResponse	The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.HybridCompute/preview/2020-08-15-preview/HybridCompute.json#L684
❌ R4010 - RequiredDefaultResponse	The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.HybridCompute/preview/2020-08-15-preview/HybridCompute.json#L735
❌ R4018 - OperationsApiResponseSchema	The response schema of operations API '/providers/Microsoft.HybridCompute/operations' does not match the ARM specification. Please standardize the schema. Location: Microsoft.HybridCompute/preview/2020-08-15-preview/HybridCompute.json#L753
❌ R4037 - MissingTypeObject	The schema 'OperationListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.HybridCompute/preview/2020-08-15-preview/HybridCompute.json#L786
❌ R4037 - MissingTypeObject	The schema 'OperationValue' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.HybridCompute/preview/2020-08-15-preview/HybridCompute.json#L799
❌ R4037 - MissingTypeObject	The schema 'OperationValueDisplay' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.HybridCompute/preview/2020-08-15-preview/HybridCompute.json#L823
❌ R4037 - MissingTypeObject	The schema 'OSProfile' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.HybridCompute/preview/2020-08-15-preview/HybridCompute.json#L848
❌ R4037 - MissingTypeObject	The schema 'MachineProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.HybridCompute/preview/2020-08-15-preview/HybridCompute.json#L859
❌ R4037 - MissingTypeObject	The schema 'MachineUpdateProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.HybridCompute/preview/2020-08-15-preview/HybridCompute.json#L985
❌ R4037 - MissingTypeObject	The schema 'Machine' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.HybridCompute/preview/2020-08-15-preview/HybridCompute.json#L993
❌ R4037 - MissingTypeObject	The schema 'MachineUpdate' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.HybridCompute/preview/2020-08-15-preview/HybridCompute.json#L1019
❌ R4037 - MissingTypeObject	The schema 'MachineListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.HybridCompute/preview/2020-08-15-preview/HybridCompute.json#L1047
❌ R4037 - MissingTypeObject	The schema 'UpdateResource' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.HybridCompute/preview/2020-08-15-preview/HybridCompute.json#L1066

️️✔️Avocado succeeded [Detail] [Expand]

Validation passes for Avocado.

️️✔️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
• hybridcompute/resource-manager/readme.md#package-preview-2020-08

The following errors/warnings are introduced by current PR:

|:speech_balloon: AutorestCore/Exception|"readme":"hybridcompute/resource-manager/readme.md",
"tag":"package-preview-2020-08",
"details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"hybridcompute/resource-manager/readme.md",
"tag":"package-preview-2020-08",
"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
❌ AutorestCore/Exception	"readme":"hybridcompute/resource-manager/readme.md", "tag":"package-preview-2020-08", "details":"Error: Plugin pre-namer reported failure."
💬 AutorestCore/Exception	"readme":"hybridcompute/resource-manager/readme.md", "tag":"package-preview-2020-08", "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]

Swagger Generation Artifacts

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

Only 0 items are rendered, please refer to log for more details.

️️✔️[Staging] SDK Breaking Change Tracking succeeded [Detail] [Expand]

Only 0 items are rendered, please refer to log for more details.

️❌ azure-powershell failed [Detail]

Only 0 items are rendered, please refer to log for more details.

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

Only 0 items are rendered, please refer to log for more details.

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

Only 0 items are rendered, please refer to log for more details.

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

Only 0 items are rendered, please refer to log for more details.

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

Only 0 items are rendered, please refer to log for more details.

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

Only 0 items are rendered, please refer to log for more details.

️❌ azure-cli-extensions failed [Detail]

Only 0 items are rendered, please refer to log for more details.

️⚠️ azure-resource-manager-schemas warning [Detail]

Only 0 items are rendered, please refer to log for more details.

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

[openapi-workflow-bot]

Hi @roramc, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff.

Task	How to fix	Priority	Support (Microsoft alias)
Avocado	Fix-Avocado	High	ruowan
Semantic validation	Fix-SemanticValidation-Error	High	raychen, jianyxi
Model validation	Fix-ModelValidation-Error	High	raychen,jianyxi
LintDiff	Fix-LintDiff	high	jianyxi, ruoxuan

If you need further help, please feedback via swagger feedback."

[openapi-workflow-bot]

NewApiVersionRequired reason:

A service’s API is a contract with customers and is represented by using the api-version query parameter. Changes such as adding an optional property to a request/response or introducing a new operation is a change to the service’s contract and therefore requires a new api-version value. This is critically important for documentation, client libraries, and customer support.

EXAMPLE: if a customer calls a service in the public cloud using api-version=2020-07-27, the new property or operation may exist but if they call the service in a government cloud, air-gapped cloud, or Azure Stack Hub cloud using the same api-version, the property or operation may not exist. Because there is no clear relationship between the service api-version and the new property/operation, customers can’t trust the documentation and Azure customer have difficulty helping customers diagnose issues. In addition, each client library version documents the service version it supports. When an optional property or new operation is added to a service and its Swagger, new client libraries must be produced to expose this functionality to customers. Without updating the api-version, it is unclear to customers which version of a client library supports these new features.

[raych1]

@roramc , adding new path to existed swagger needs breaking change review approval or it can be added in new api version.

[roramc]

@roramc , adding new path to existed swagger needs breaking change review approval or it can be added in new api version.

These APIs already exist in the given version, we were in private preview for these APIs. That's why the public repo was not updated. We had raised a PR for the same in the private repo, here is the link: https://github.com/Azure/azure-rest-api-specs-pr/pull/1907
Few additional properties are added as part of this PR.

[raych1]

@roramc , adding new path to existed swagger needs breaking change review approval or it can be added in new api version.

These APIs already exist in the given version, we were in private preview for these APIs. That's why the public repo was not updated. We had raised a PR for the same in the private repo, here is the link: Azure/azure-rest-api-specs-pr#1907
Few additional properties are added as part of this PR.

They should not be added to public repo if it's still in private preview. Please go thru the ARM API Review Checklist and check on the appropriate items so that ARM can review this PR.

[roramc]

@roramc , adding new path to existed swagger needs breaking change review approval or it can be added in new api version.

These APIs already exist in the given version, we were in private preview for these APIs. That's why the public repo was not updated. We had raised a PR for the same in the private repo, here is the link: Azure/azure-rest-api-specs-pr#1907
Few additional properties are added as part of this PR.

They should not be added to public repo if it's still in private preview. Please go thru the ARM API Review Checklist and check on the appropriate items so that ARM can review this PR.

We were going to private preview in last Dec when we added it to private repo. Now we are going public preview by end of this month, hence this PR is created to make the API documentation public. The private repo PR is just a link for reference.

[openapi-workflow-bot]

Hi, @roramc your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com).

[roramc]

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:

1. 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

2. 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.

3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.

4. 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
    -[ ] 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.

I'm unable to fix the prettier check. I get this error when I run the command:

[openapi-workflow-bot]

Hi @roramc, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review.
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.
If you want to know the production traffic statistic, please see ARM Traffic statistic.
If you think it is false positive breaking change, please provide the reasons in the PR comment, report to Swagger Tooling Team via https://aka.ms/swaggerfeedback.

[zhenglaizhang]

/azp run

[azure-pipelines]

Azure Pipelines successfully started running 1 pipeline(s).