Added v2022-04-15-preview API for ArcAppliance #19491

saisankargochhayat · 2022-06-16T23:50:55Z

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 language 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 appy to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.
- Adding a new service
- Adding new API(s)
- Adding a new API version
  -[ ] To review changes efficiently, ensure you are using OpenAPIHub to initialize the PR for adding a new version. More details, refer to the wiki.
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 · 2022-06-16T23:50:57Z

Hi, @saisankargochhayat 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. vscswagger@microsoft.com

openapi-pipeline-app · 2022-06-16T23:50:58Z

Swagger Validation Report

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

There are no breaking changes.

️⚠️Breaking Change(Cross-Version): 1 Warnings warning [Detail]

compared swaggers (via Oad v0.9.6)]	new version	base version
appliances.json	2022-04-15(c3b630b)	2021-10-31(main)

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

Rule	Message
⚠️ 1029 - ReadonlyPropertyChanged	The read only property has changed from 'true' to 'false'. New: Microsoft.ResourceConnector/preview/2022-04-15-preview/appliances.json#L964:9 Old: Microsoft.ResourceConnector/preview/2021-10-31-preview/appliances.json#L686:9

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

There is no credential detected.

️⚠️LintDiff: 2 Warnings warning [Detail]

compared tags (via openapi-validator v1.13.0)	new version	base version
package-2022-04-15-preview	package-2022-04-15-preview(c3b630b)	default(main)

The following errors/warnings are introduced by current PR:

Rule	Message
⚠️ R2001 - AvoidNestedProperties	Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.ResourceConnector/preview/2022-04-15-preview/appliances.json#L678
⚠️ R3010 - TrackedResourceListByImmediateParent	The child tracked resource, 'upgradeGraphs' with immediate parent 'appliance', must have a list by immediate parent operation. Location: Microsoft.ResourceConnector/preview/2022-04-15-preview/appliances.json#L664

The following errors/warnings exist before current PR submission:

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: isDataAction Location: Microsoft.ResourceConnector/preview/2022-04-15-preview/appliances.json#L825

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

Validation passes for Avocado.

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

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

Validation passes for ModelValidation.

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

Validation passes for SemanticValidation.

️️✔️PoliCheck succeeded [Detail] [Expand]

Validation passed for PoliCheck.

️⚠️SDK Track2 Validation: 4 Warnings warning [Detail]

The following tags are being changed in this PR

resourceconnector/resource-manager/readme.md#package-2022-04-15-preview

The following errors/warnings are introduced by current PR:

Rule	Message
⚠️ IgnoredPropertyNextToRef	"readme":"resourceconnector/resource-manager/readme.md", "tag":"package-2022-04-15-preview", "details":"Semantic violation: Sibling values alongside $ref will be ignored. See https://github.com/Azure/autorest/blob/main/docs/openapi/howto/$ref-siblings.md for allowed values (components > schemas > SupportedVersion > properties > metadata)\n keys: [ \u001b[32m'type'\u001b[39m ]"
⚠️ IgnoredPropertyNextToRef	"readme":"resourceconnector/resource-manager/readme.md", "tag":"package-2022-04-15-preview", "details":"Semantic violation: Sibling values alongside $ref will be ignored. See https://github.com/Azure/autorest/blob/main/docs/openapi/howto/$ref-siblings.md for allowed values (components > schemas > SupportedVersionCatalogVersion > properties > data)\n keys: [ \u001b[32m'type'\u001b[39m ]"
⚠️ IgnoredPropertyNextToRef	"readme":"resourceconnector/resource-manager/readme.md", "tag":"package-2022-04-15-preview", "details":"Semantic violation: Sibling values alongside $ref will be ignored. See https://github.com/Azure/autorest/blob/main/docs/openapi/howto/$ref-siblings.md for allowed values (components > schemas > SupportedVersionMetadata > properties > catalogVersion)\n keys: [ \u001b[32m'type'\u001b[39m ]"
⚠️ IgnoredPropertyNextToRef	"readme":"resourceconnector/resource-manager/readme.md", "tag":"package-2022-04-15-preview", "details":"Semantic violation: Sibling values alongside $ref will be ignored. See https://github.com/Azure/autorest/blob/main/docs/openapi/howto/$ref-siblings.md for allowed values (components > schemas > UpgradeGraph > properties > properties)\n keys: [ \u001b[32m'type'\u001b[39m ]"
💬	"readme":"resourceconnector/resource-manager/readme.md", "tag":"package-2022-04-15-preview", "details":"AutoRest core version selected from configuration: ^3.2.0."
💬	"readme":"resourceconnector/resource-manager/readme.md", "tag":"package-2022-04-15-preview", "details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.11.0 -> 1.11.0)"
💬	"readme":"resourceconnector/resource-manager/readme.md", "tag":"package-2022-04-15-preview", "details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.11.0->1.11.0)"
💬	"readme":"resourceconnector/resource-manager/readme.md", "tag":"package-2022-04-15-preview", "details":"> Installing AutoRest extension '@autorest/modelerfour' (4.21.4 -> 4.21.4)"
💬	"readme":"resourceconnector/resource-manager/readme.md", "tag":"package-2022-04-15-preview", "details":"> Installed AutoRest extension '@autorest/modelerfour' (4.21.4->4.21.4)"
💬	"readme":"resourceconnector/resource-manager/readme.md", "tag":"package-2022-04-15-preview", "details":"Autorest completed in 9.3s. 0 files generated."

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

️️✔️CadlValidation succeeded [Detail] [Expand]

Validation passes for CadlValidation.

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

openapi-pipeline-app · 2022-06-16T23:50:58Z

Swagger Generation Artifacts

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

 Please click here to preview with your @microsoft account.

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

Breaking Changes Tracking

️✔️azure-sdk-for-go - armresourceconnector - 0.2.0

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

⚠️Warning [Logs]Release - Generate from 132c5d1. 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
cmderr	[automation_generate.sh] WARN config global `--global`, `--local` are deprecated. Use `--location=global` instead.
cmderr	[automation_generate.sh]
cmderr	[automation_generate.sh] npm notice New minor version of npm available! 8.11.0 -> 8.13.1
cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v8.13.1>
cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@8.13.1` to update!
cmderr	[automation_generate.sh] npm notice
warn	No file changes detected after generation
warn	No package detected after generation

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

️✔️Succeeded [Logs]Release - Generate from 132c5d1. 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

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

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

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

command	sh ./eng/scripts/automation_init.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
command	generator automation-v2 ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json

️✔️armresourceconnector [View full logs] [Release SDK Changes]

info	[Changelog] ### Features Added
info	[Changelog]
info	[Changelog] - New const `StatusOffline`
info	[Changelog] - New const `StatusPostUpgrade`
info	[Changelog] - New const `AccessProfileTypeClusterCustomerUser`
info	[Changelog] - New const `StatusUpdatingCluster`
info	[Changelog] - New const `SSHKeyTypeSSHCustomerUser`
info	[Changelog] - New const `StatusUpgradeClusterExtensionFailedToDelete`
info	[Changelog] - New const `StatusPreUpgrade`
info	[Changelog] - New const `StatusPreparingForUpgrade`
info	[Changelog] - New const `StatusUpgradeFailed`
info	[Changelog] - New const `StatusNone`
info	[Changelog] - New const `StatusWaitingForCloudOperator`
info	[Changelog] - New const `ProviderKubeVirt`
info	[Changelog] - New const `StatusConnecting`
info	[Changelog] - New const `StatusUpgradePrerequisitesCompleted`
info	[Changelog] - New const `ProviderOpenStack`
info	[Changelog] - New const `StatusUpdatingCAPI`
info	[Changelog] - New const `StatusUpgradeComplete`
info	[Changelog] - New const `StatusUpdatingCloudOperator`
info	[Changelog] - New function `PossibleSSHKeyTypeValues() []SSHKeyType`
info	[Changelog] - New function `*AppliancesClient.ListClusterCustomerUserCredential(context.Context, string, string, *AppliancesClientListClusterCustomerUserCredentialOptions) (AppliancesClientListClusterCustomerUserCredentialResponse, error)`
info	[Changelog] - New function `*AppliancesClient.GetUpgradeGraph(context.Context, string, string, string, *AppliancesClientGetUpgradeGraphOptions) (AppliancesClientGetUpgradeGraphResponse, error)`
info	[Changelog] - New struct `ApplianceListClusterCustomerUserCredentialResults`
info	[Changelog] - New struct `AppliancesClientGetUpgradeGraphOptions`
info	[Changelog] - New struct `AppliancesClientGetUpgradeGraphResponse`
info	[Changelog] - New struct `AppliancesClientListClusterCustomerUserCredentialOptions`
info	[Changelog] - New struct `AppliancesClientListClusterCustomerUserCredentialResponse`
info	[Changelog] - New struct `SSHKey`
info	[Changelog] - New struct `SupportedVersion`
info	[Changelog] - New struct `SupportedVersionCatalogVersion`
info	[Changelog] - New struct `SupportedVersionCatalogVersionData`
info	[Changelog] - New struct `SupportedVersionMetadata`
info	[Changelog] - New struct `UpgradeGraph`
info	[Changelog] - New struct `UpgradeGraphProperties`
info	[Changelog]
info	[Changelog] Total 0 breaking change(s), 45 additive change(s).

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

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

command	sh .scripts/automation_init.sh ../azure-sdk-for-js_tmp/initInput.json ../azure-sdk-for-js_tmp/initOutput.json
cmderr	[automation_init.sh]  deprecated read-package-tree@5.1.6: The functionality that this package provided is now in @npmcli/arborist
cmderr	[automation_init.sh]  uuid@3.4.0: Please upgrade  to version 7 or higher.  Older versions may use Math.random() in certain circumstances, which is known to be problematic.  See https://v8.dev/blog/math-random for details.
cmderr	[automation_init.sh] npm WARN deprecated @opentelemetry/types@0.2.0: Package renamed to @opentelemetry/api, see https://github.com/open-telemetry/opentelemetry-js
cmderr	[automation_init.sh] WARN deprecated @azure/storage-blob@10.5.0: This version has been deprecated, please upgrade to the version tagged as latest
cmderr	[automation_init.sh] npm WARN @octokit/plugin-request-log@1.0.4 requires a peer of @octokit/core@>=3 but none is installed. You must install peer dependencies yourself.
warn	File azure-sdk-for-js_tmp/initOutput.json not found to read
command	sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json

️✔️@azure/arm-resourceconnector [View full logs] [Release SDK Changes]
- azure-arm-resourceconnector-1.0.0-beta.1.tgz
```
info	[Changelog]
error	breakingChangeTracking is enabled, but version or changelogItem is not found in output.
```

️️✔️ azure-powershell succeeded [Detail] [Expand]

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

command	sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json
command	pwsh ./tools/SwaggerCI/psci.ps1 ../azure-powershell_tmp/generateInput.json ../azure-powershell_tmp/generateOutput.json

️✔️Az.Appliances [View full logs] [Release SDK Changes]
- Az.Appliances.0.1.0.nupkg

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

openapi-workflow-bot · 2022-06-16T23:53:12Z

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

saisankargochhayat · 2022-06-20T20:34:04Z

/azp run

azure-pipelines · 2022-06-20T22:10:55Z

Comment was made before the most recent commit for PR 19491 in repo Azure/azure-rest-api-specs

openapi-workflow-bot · 2022-06-21T03:25:49Z

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

...ctor/resource-manager/Microsoft.ResourceConnector/preview/2022-04-15-preview/appliances.json

openapi-workflow-bot · 2022-06-22T01:38:32Z

Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove ARMChangesRequested

...ctor/resource-manager/Microsoft.ResourceConnector/preview/2022-04-15-preview/appliances.json

honghr · 2022-06-27T07:53:12Z

/azp run

azure-pipelines · 2022-06-27T07:53:21Z

Azure Pipelines successfully started running 1 pipeline(s).

saisankargochhayat marked this pull request as ready for review June 16, 2022 23:52

saisankargochhayat requested review from msyyc, BigCat20196, ArcturusZhang and qiaozha as code owners June 16, 2022 23:52

openapi-assignment-bot bot assigned honghr Jun 16, 2022

openapi-pipeline-app bot added the CI-FixRequiredOnFailure label Jun 16, 2022

openapi-pipeline-app bot added CI-FixRequiredOnFailure and removed CI-FixRequiredOnFailure labels Jun 20, 2022

azure-sdk mentioned this pull request Jun 21, 2022

[AutoPR @azure/arm-resourceconnector] Added v2022-04-15-preview API for ArcAppliance azure-sdk/azure-sdk-for-js#893

Closed

openapi-workflow-bot bot added ARMReview WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Jun 21, 2022

rkmanda reviewed Jun 22, 2022

View reviewed changes

...ctor/resource-manager/Microsoft.ResourceConnector/preview/2022-04-15-preview/appliances.json Show resolved Hide resolved

rkmanda added the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Jun 22, 2022

openapi-workflow-bot bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jun 22, 2022

Fixed example on v2021-10-31-preview API

2ae215c

saisankargochhayat force-pushed the sgochhayat/appliance-2022-04-15-preview branch from f7e4f17 to 2ae215c Compare June 22, 2022 19:24

Copied v2021-10-31-preview as new API

8485b3a

Add actual v2022-04-15-preview api

55df989

azure-sdk mentioned this pull request Jun 22, 2022

[AutoPR track2_azure-mgmt-resourceconnector] Added v2022-04-15-preview API for ArcAppliance azure-sdk/azure-sdk-for-python#657

Closed

Added custom words

e5d481a

saisankargochhayat requested a review from rkmanda June 22, 2022 19:53

rkmanda removed the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Jun 22, 2022

openapi-workflow-bot bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jun 22, 2022

rkmanda reviewed Jun 22, 2022

View reviewed changes

...ctor/resource-manager/Microsoft.ResourceConnector/preview/2022-04-15-preview/appliances.json Outdated Show resolved Hide resolved

rkmanda added the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Jun 22, 2022

openapi-workflow-bot bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jun 22, 2022

Updated URL based on ARM suggestion

c3b630b

saisankargochhayat requested a review from rkmanda June 24, 2022 18:47

rkmanda added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Jun 24, 2022

openapi-workflow-bot bot removed the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Jun 24, 2022

honghr approved these changes Jun 27, 2022

View reviewed changes

honghr merged commit 132c5d1 into Azure:main Jun 27, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added v2022-04-15-preview API for ArcAppliance #19491

Added v2022-04-15-preview API for ArcAppliance #19491

saisankargochhayat commented Jun 16, 2022 •

edited by honghr

Loading

openapi-workflow-bot bot commented Jun 16, 2022

openapi-pipeline-app bot commented Jun 16, 2022 •

edited

Loading

openapi-pipeline-app bot commented Jun 16, 2022 •

edited

Loading

Breaking Changes Tracking

openapi-workflow-bot bot commented Jun 16, 2022

saisankargochhayat commented Jun 20, 2022

azure-pipelines bot commented Jun 20, 2022

openapi-workflow-bot bot commented Jun 21, 2022

openapi-workflow-bot bot commented Jun 22, 2022

honghr commented Jun 27, 2022

azure-pipelines bot commented Jun 27, 2022

Added v2022-04-15-preview API for ArcAppliance #19491

Added v2022-04-15-preview API for ArcAppliance #19491

Conversation

saisankargochhayat commented Jun 16, 2022 • edited by honghr Loading

Changelog

Contribution checklist:

ARM API Review Checklist

Breaking Change Review Checklist

openapi-workflow-bot bot commented Jun 16, 2022

openapi-pipeline-app bot commented Jun 16, 2022 • edited Loading

Swagger Validation Report

openapi-pipeline-app bot commented Jun 16, 2022 • edited Loading

Swagger Generation Artifacts

Breaking Changes Tracking

openapi-workflow-bot bot commented Jun 16, 2022

saisankargochhayat commented Jun 20, 2022

azure-pipelines bot commented Jun 20, 2022

openapi-workflow-bot bot commented Jun 21, 2022

openapi-workflow-bot bot commented Jun 22, 2022

honghr commented Jun 27, 2022

azure-pipelines bot commented Jun 27, 2022

saisankargochhayat commented Jun 16, 2022 •

edited by honghr

Loading

openapi-pipeline-app bot commented Jun 16, 2022 •

edited

Loading

openapi-pipeline-app bot commented Jun 16, 2022 •

edited

Loading