ADP: Introduce api version 2021-11-01-preview #16526

liabadi · 2021-10-25T08:20:44Z

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

- Add new version to readme.md

openapi-workflow-bot · 2021-10-25T08:20:47Z

Hi, @liabadi 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-pipeline-app · 2021-10-25T08:20:48Z

Swagger Validation Report

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

There are no breaking changes.

️️✔️LintDiff succeeded [Detail] [Expand]

Validation passes for LintDiff.

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

Validation passes for Avocado.

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

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

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

Validation passes for SDKTrack2Validation

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

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

openapi-workflow-bot · 2021-10-25T08:20:49Z

[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-10-25T08:20:49Z

Swagger Generation Artifacts

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

️⌛SDK Breaking Change Tracking pending [Detail]

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

⚠️Warning [Logs]Release - Generate from b81af69. 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]
cmderr	[automation_generate.sh] npm notice New minor version of npm available! 8.1.2 -> 8.3.0
cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v8.3.0>
cmderr	[automation_generate.sh] npm notice Run `npm install -g [email protected]` to update!
cmderr	[automation_generate.sh] npm notice

️✔️track2_azure-mgmt-adp [View full logs] [Release SDK Changes]
- azure_mgmt_adp-1.0.0b1-py3-none-any.whl
- azure-mgmt-adp-1.0.0b1.zip
```
info	[Changelog]   - Initial Release
```

️🔄 azure-sdk-for-java inProgress [Detail]

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

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

command	sh ./eng/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

️✔️preview/adp/mgmt/2021-11-01-preview/adp [View full logs] [Release SDK Changes]
```
info	[Changelog] This is a new package
info	[Changelog]
```
️✔️preview/adp/mgmt/2021-02-01-preview/adp [View full logs]
```
info	[Changelog] This is a new package
info	[Changelog]
```
️✔️preview/adp/mgmt/2020-07-01-preview/adp [View full logs]
```
info	[Changelog] This is a new package
info	[Changelog]
```

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

⚠️Warning [Logs]Release - Generate from b81af69. 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]  WARN deprecated [email protected]: 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]  @opentelemetry/[email protected]: Package renamed to @opentelemetry/api, see https://github.com/open-telemetry/opentelemetry-js
cmderr	[automation_init.sh] notice created a lockfile as package-lock.json. You should commit this file.
cmderr	[automation_init.sh] npm WARN @octokit/[email protected] 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

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

info	[Changelog]
error	breakingChangeTracking is enabled, but version or changelogItem is not found in output.

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

⚠️Warning [Logs]Release - Generate from b81af69. Schema Automation 14.0.0

command	.sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json
cmderr	[initScript.sh] WARN old lockfile
cmderr	[initScript.sh] npm WARN old lockfile The package-lock.json file was created with an old version of npm,
cmderr	[initScript.sh] npm WARN old lockfile so supplemental metadata must be fetched from the registry.
cmderr	[initScript.sh] npm WARN old lockfile
cmderr	[initScript.sh] npm WARN old lockfile This is a one-time fix-up, please be patient...
cmderr	[initScript.sh] npm WARN old lockfile
warn	File azure-resource-manager-schemas_tmp/initOutput.json not found to read
command	.sdkauto/generateScript.sh ../azure-resource-manager-schemas_tmp/generateInput.json ../azure-resource-manager-schemas_tmp/generateOutput.json
warn	No file changes detected after generation

️✔️adp [View full logs]

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

openapi-workflow-bot · 2021-10-25T08:21:23Z

Hi, @liabadi your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]).

openapi-workflow-bot · 2021-10-25T08:22:54Z

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

MiYanni · 2021-10-26T20:10:26Z

@liabadi You just pinged 157 people. Don't do that.

specification/adp/resource-manager/readme.python.md

filizt · 2021-10-28T20:08:12Z

LGTM.

ruowan · 2021-11-02T09:25:26Z

/azp run

azure-pipelines · 2021-11-02T09:25:38Z

Azure Pipelines successfully started running 1 pipeline(s).

liabadi · 2021-11-02T13:59:55Z

@ruowan , the API Readines check fails since the CheckAvailability resource is not available in the version introduced by this PR. That doesn't make sense to me - how would I register the resource without the PR being approved?
My original plan was to get this PR approved, and then register all of our resources with the latest api version.

specification/adp/resource-manager/readme.python.md

akning-ms · 2021-11-03T09:09:48Z

@ruowan , the API Readines check fails since the CheckAvailability resource is not available in the version introduced by this PR. That doesn't make sense to me - how would I register the resource without the PR being approved? My original plan was to get this PR approved, and then register all of our resources with the latest api version.

Hi @liabadi, Normally RPaaS RP should be onboard to RPaasMaster branch first to ensure if you swagger no issue, Is this version is already in RPaaSMaster? if yes. API readiness should be able to pass.

liabadi · 2021-11-16T18:54:20Z

@ruowan , the API Readines check fails since the CheckAvailability resource is not available in the version introduced by this PR. That doesn't make sense to me - how would I register the resource without the PR being approved? My original plan was to get this PR approved, and then register all of our resources with the latest api version.

Hi @liabadi, Normally RPaaS RP should be onboard to RPaasMaster branch first to ensure if you swagger no issue, Is this version is already in RPaaSMaster? if yes. API readiness should be able to pass.

@akning-ms, we're not using RPaaSMaster to publish our schemas, only RPaasDev and main.

The validation error this PR gets is for the "operations" resource not being available in version 2021-11-01-preview. The thing is we were planning to roll out the new versioned resources only once the schema change is approved...

In any case, I have started to roll out the api change now with the new version added to most of the resources. Two questions about it:

The Account and DataPool registrations failed due to the 2021-11-01 schema not being available, however other resources succeeded, ie: operations, operationstatuses, checknameavailability and locations. Would this be enough for the readiness check to pass?
The manifest rollout will take 5 days to complete according to SDP. It seems that the API readiness check is done against a non-location specific ARM endpoint, meaning that it might take the full 5 days to get a feedback. Doesn't it make more sense to do the test against the canary endpoint which is rolled out immediately?

akning-ms · 2021-11-17T02:55:31Z

@ruowan , the API Readines check fails since the CheckAvailability resource is not available in the version introduced by this PR. That doesn't make sense to me - how would I register the resource without the PR being approved? My original plan was to get this PR approved, and then register all of our resources with the latest api version.

Hi @liabadi, Normally RPaaS RP should be onboard to RPaasMaster branch first to ensure if you swagger no issue, Is this version is already in RPaaSMaster? if yes. API readiness should be able to pass.

@akning-ms, we're not using RPaaSMaster to publish our schemas, only RPaasDev and main.

The validation error this PR gets is for the "operations" resource not being available in version 2021-11-01-preview. The thing is we were planning to roll out the new versioned resources only once the schema change is approved...

In any case, I have started to roll out the api change now with the new version added to most of the resources. Two questions about it:

The Account and DataPool registrations failed due to the 2021-11-01 schema not being available, however other resources succeeded, ie: operations, operationstatuses, checknameavailability and locations. Would this be enough for the readiness check to pass?

The manifest rollout will take 5 days to complete according to SDP. It seems that the API readiness check is done against a non-location specific ARM endpoint, meaning that it might take the full 5 days to get a feedback. Doesn't it make more sense to do the test against the canary endpoint which is rolled out immediately?

Hi @liabadi, not sure what is the reason not to use RPaaSMaster? normally, you should have your testing in RPaaSMaster first before go to main branch. if so, there should be no issue for API readiness check.

ruowan · 2021-11-17T02:59:43Z

Hi, @liabadi For your questions.

Currently it's enough, current apiReadinessCheck only check operations list. But in the future, we will check resource type.
Here ApiReadinessCheck should check prod not canary. For canary check, we have shiftleft https://aka.ms/shiftleft process.

I have another two questions:

Why you do not have RPaaSMaster? I think the process should be RPaaSDev=>RPaaSMaster=>Main. If you have RPaaSMaster you could register resource type by using RPaaSMaster schema.
If no schema, why only register operations can be succeed? and why need take 5 days to get feedback? Do you have any doc about this?

liabadi · 2021-11-18T09:08:07Z

@ruowan Thanks for the info!

As for your questions:

To my understanding (based on the armwiki), RPaaSMaster does not support "-preview" api versions like the one I'd like to publish in this PR.
The 5 days deployment is a standard which follows the SDP guidelines. It applies to any ARM manifest rollout (link).

liabadi · 2021-11-22T07:32:51Z

/azp run

azure-pipelines · 2021-11-22T07:32:57Z

Commenter does not have sufficient privileges for PR 16526 in repo Azure/azure-rest-api-specs

liabadi · 2021-11-22T08:12:12Z

@ruowan, @akning-ms, are we good to go with this PR?
I see the Python sdk build was skipped though required.

ruowan · 2021-11-22T08:49:12Z

LGTM. Will merge it. How do you fix apiReadinessCheck?

liabadi · 2021-11-22T12:55:42Z

@ruowan the ApiReadinessCheck was fixed by rolling out the operations list.
Once this PR is merged, I'll roll out the resources that use it (namely, Accounts and DataPools).

Create to sync Azure/azure-rest-api-specs#16526 [ReCreate this PR](https://github.com/azure-resource-manager-schemas/compare/main...AzureSDKAutomation:sdkAuto/adp?expand=1)

msyyc · 2022-01-05T03:49:54Z

/azp run

* - Copy version 2021-11-01 from 2021-02-01 - Add new version to readme.md * Update api version references to 2021-11-01 * Add api changes * Fix validation * Fix the rest of the validations and other readme's * Prettier fix * Fix python sdk generation * Use multiapiscript instead of multiapi * Try using only multiapi * Fix python * Align readmes * Align python with sample * Change to create mode * Revert mode * Update readme.python.md * New data pool * Add Access URI and use KeyVaultProperties for encryption * Revert New data pool * Remove the deduplication flag Co-authored-by: Lior Abadi <[email protected]> Co-authored-by: Eli Arbel <[email protected]> Co-authored-by: Yuchao Yan <[email protected]>

- Copy version 2021-11-01 from 2021-02-01

40cf6cd

- Add new version to readme.md

openapi-workflow-bot bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Oct 25, 2021

openapi-pipeline-app bot added the CI-FixRequiredOnFailure label Oct 25, 2021

Update api version references to 2021-11-01

0f894f5

openapi-sdkautomation bot mentioned this pull request Oct 25, 2021

[AutoPR adp] ADP: Introduce api version 2021-11-01-preview AzureSDKAutomation/azure-sdk-for-js#6458

Closed

Add api changes

a361438

openapi-sdkautomation bot mentioned this pull request Oct 25, 2021

[AutoPR azure-resourcemanager-adp] ADP: Introduce api version 2021-11-01-preview AzureSDKAutomation/azure-sdk-for-java#11250

Closed

Fix validation

29409b8

openapi-pipeline-app bot added CI-FixRequiredOnFailure and removed CI-FixRequiredOnFailure labels Oct 25, 2021

openapi-sdkautomation bot mentioned this pull request Oct 25, 2021

[AutoPR adp] ADP: Introduce api version 2021-11-01-preview AzureSDKAutomation/azure-resource-manager-schemas#4941

Closed

Fix the rest of the validations and other readme's

e231354

openapi-pipeline-app bot removed the CI-FixRequiredOnFailure label Oct 25, 2021

Prettier fix

e06beab

liabadi marked this pull request as ready for review October 26, 2021 18:14

liabadi requested review from 00Kai0, ArcturusZhang, jsntcy, msyyc and RAY-316 as code owners October 26, 2021 18:14

openapi-assignment-bot bot assigned akning-ms Oct 26, 2021

iscai-msft reviewed Oct 26, 2021

View reviewed changes

specification/adp/resource-manager/readme.python.md Outdated Show resolved Hide resolved

Fix python sdk generation

5209137

This was referenced Oct 29, 2021

Compare the impact of this on the SDK BigCat20196/azure-sdk-for-python#12

Closed

Compare the impact of this on the SDK BigCat20196/azure-sdk-for-python#13

Draft

lmazuel reviewed Nov 2, 2021

View reviewed changes

specification/adp/resource-manager/readme.python.md Outdated Show resolved Hide resolved

Remove the deduplication flag

e6264eb

ruowan approved these changes Nov 22, 2021

View reviewed changes

ruowan merged commit b81af69 into Azure:main Nov 23, 2021

openapi-sdkautomation bot mentioned this pull request Nov 23, 2021

[ReleasePR azure-resourcemanager-adp] update readme Azure/azure-sdk-for-java#25618

Closed

openapi-sdkautomation bot mentioned this pull request Jan 5, 2022

[ReleasePR track2_adp] Adding x-ms identifiers for adp Azure/azure-sdk-for-js#19643

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ADP: Introduce api version 2021-11-01-preview #16526

ADP: Introduce api version 2021-11-01-preview #16526

liabadi commented Oct 25, 2021 •

edited

Loading

openapi-workflow-bot bot commented Oct 25, 2021

openapi-pipeline-app bot commented Oct 25, 2021 •

edited

Loading

openapi-workflow-bot bot commented Oct 25, 2021

openapi-pipeline-app bot commented Oct 25, 2021 •

edited

Loading

openapi-workflow-bot bot commented Oct 25, 2021

openapi-workflow-bot bot commented Oct 25, 2021

MiYanni commented Oct 26, 2021

filizt commented Oct 28, 2021

ruowan commented Nov 2, 2021

azure-pipelines bot commented Nov 2, 2021

liabadi commented Nov 2, 2021

akning-ms commented Nov 3, 2021

liabadi commented Nov 16, 2021

akning-ms commented Nov 17, 2021

ruowan commented Nov 17, 2021 •

edited

Loading

liabadi commented Nov 18, 2021

liabadi commented Nov 22, 2021

azure-pipelines bot commented Nov 22, 2021

liabadi commented Nov 22, 2021 •

edited

Loading

ruowan commented Nov 22, 2021

liabadi commented Nov 22, 2021

msyyc commented Jan 5, 2022

ADP: Introduce api version 2021-11-01-preview #16526

ADP: Introduce api version 2021-11-01-preview #16526

Conversation

liabadi commented Oct 25, 2021 • edited Loading

Changelog

Contribution checklist:

ARM API Review Checklist

Breaking Change Review Checklist

openapi-workflow-bot bot commented Oct 25, 2021

openapi-pipeline-app bot commented Oct 25, 2021 • edited Loading

Swagger Validation Report

openapi-workflow-bot bot commented Oct 25, 2021

openapi-pipeline-app bot commented Oct 25, 2021 • edited Loading

Swagger Generation Artifacts

openapi-workflow-bot bot commented Oct 25, 2021

openapi-workflow-bot bot commented Oct 25, 2021

MiYanni commented Oct 26, 2021

filizt commented Oct 28, 2021

ruowan commented Nov 2, 2021

azure-pipelines bot commented Nov 2, 2021

liabadi commented Nov 2, 2021

akning-ms commented Nov 3, 2021

liabadi commented Nov 16, 2021

akning-ms commented Nov 17, 2021

ruowan commented Nov 17, 2021 • edited Loading

liabadi commented Nov 18, 2021

liabadi commented Nov 22, 2021

azure-pipelines bot commented Nov 22, 2021

liabadi commented Nov 22, 2021 • edited Loading

ruowan commented Nov 22, 2021

liabadi commented Nov 22, 2021

msyyc commented Jan 5, 2022

liabadi commented Oct 25, 2021 •

edited

Loading

openapi-pipeline-app bot commented Oct 25, 2021 •

edited

Loading

openapi-pipeline-app bot commented Oct 25, 2021 •

edited

Loading

ruowan commented Nov 17, 2021 •

edited

Loading

liabadi commented Nov 22, 2021 •

edited

Loading