StoragePool RP New Preview API #13970

harshitha-akkaraju · 2021-04-15T23:46:09Z

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-15T23:46:11Z

Hi, @harshitha-akkaraju 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-15T23:46:12Z

[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-15T23:46:13Z

Swagger Validation Report

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

There are no breaking changes.

️⚠️LintDiff: 1 Warnings warning [Detail]

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

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: isAccessible Location: Microsoft.StoragePool/preview/2021-04-01-preview/storagepool.json#L1045

The following errors/warnings exist before current PR submission:

Rule	Message
⚠️ R3010 - TrackedResourceListByImmediateParent	The child tracked resource, 'iscsiTargets' with immediate parent 'DiskPool', must have a list by immediate parent operation. Location: Microsoft.StoragePool/preview/2021-04-01-preview/storagepool.json#L889
⚠️ 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.StoragePool/preview/2021-04-01-preview/storagepool.json#L933

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

Compared Swaggers (Based on Oad v0.8.9)
- original: preview/2020-03-15-preview/storagepool.json <---> new: preview/2021-04-01-preview/storagepool.json

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

Rule	Message
`❌` 1023 - TypeFormatChanged	The new version has a different format than the previous one. New: Microsoft.StoragePool/preview/2021-04-01-preview/storagepool.json#L1697:9 Old: Microsoft.StoragePool/preview/2020-03-15-preview/storagepool.json#L1496:9
`❌` 1023 - TypeFormatChanged	The new version has a different format than the previous one. New: Microsoft.StoragePool/preview/2021-04-01-preview/storagepool.json#L1720:9 Old: Microsoft.StoragePool/preview/2020-03-15-preview/storagepool.json#L1508:9
`❌` 1024 - ConstraintIsStronger	The new version has a more constraining 'enum' value than the previous one. New: Microsoft.StoragePool/preview/2021-04-01-preview/storagepool.json#L1683:9 Old: Microsoft.StoragePool/preview/2020-03-15-preview/storagepool.json#L1492:9
`❌` 1024 - ConstraintIsStronger	The new version has a more constraining 'enum' value than the previous one. New: Microsoft.StoragePool/preview/2021-04-01-preview/storagepool.json#L1706:9 Old: Microsoft.StoragePool/preview/2020-03-15-preview/storagepool.json#L1504:9
`❌` 1029 - ReadonlyPropertyChanged	The read only property has changed from 'false' to 'true'. New: Microsoft.StoragePool/preview/2021-04-01-preview/storagepool.json#L1131:9 Old: Microsoft.StoragePool/preview/2020-03-15-preview/storagepool.json#L836:9
`❌` 1029 - ReadonlyPropertyChanged	The read only property has changed from 'false' to 'true'. New: Microsoft.StoragePool/preview/2021-04-01-preview/storagepool.json#L1674:5 Old: Microsoft.StoragePool/preview/2020-03-15-preview/storagepool.json#L1484:5
`❌` 1033 - RemovedProperty	The new version is missing a property found in the old version. Was 'tier' renamed or removed? New: Microsoft.StoragePool/preview/2021-04-01-preview/storagepool.json#L1239:7 Old: Microsoft.StoragePool/preview/2020-03-15-preview/storagepool.json#L939:7
`❌` 1033 - RemovedProperty	The new version is missing a property found in the old version. Was 'tier' renamed or removed? Old: Microsoft.StoragePool/preview/2020-03-15-preview/storagepool.json#L174:9
`❌` 1033 - RemovedProperty	The new version is missing a property found in the old version. Was 'tpgs' renamed or removed? New: Microsoft.StoragePool/preview/2021-04-01-preview/storagepool.json#L1442:7 Old: Microsoft.StoragePool/preview/2020-03-15-preview/storagepool.json#L1151:7
`❌` 1033 - RemovedProperty	The new version is missing a property found in the old version. Was 'tpgs' renamed or removed? Old: Microsoft.StoragePool/preview/2020-03-15-preview/storagepool.json#L414:9

️️✔️Cross Version BreakingChange (Base on stable version) succeeded [Detail] [Expand]

There are no breaking changes.

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

There is no credential detected.

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

Validation passes for SDKTrack2Validation

The following tags are being changed in this PR

storagepool/resource-manager/readme.md#package-2021-04-01-preview

The following errors/warnings are introduced by current PR:

|:speech_balloon: AutorestCore/Exception|"readme":"storagepool/resource-manager/readme.md",
"tag":"package-2021-04-01-preview",
"details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"storagepool/resource-manager/readme.md",
"tag":"package-2021-04-01-preview",
"details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"storagepool/resource-manager/readme.md",
"tag":"package-2021-04-01-preview",
"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-15T23:46:14Z

Swagger Generation Artifacts

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

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

️✔️preview/storagepool/mgmt/2021-04-01-preview/storagepool [View full logs] [Release SDK Changes]
```
info	[Changelog] This is a new package
```
️✔️preview/storagepool/mgmt/2020-03-15-preview/storagepool [View full logs] [Release SDK Changes] Breaking Change Detected
```
info	[Changelog] This package was removed
```

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

⚠️Warning [Logs]Release - Generate from 3ae1665. 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-05-06 01:54:04 INFO [VERSION][Not Found] cannot find version for "com.azure.resourcemanager:azure-resourcemanager-storagepool"
cmderr	[generate.py] 2021-05-06 01:54:04 INFO [VERSION][Not Found] cannot find stable version, current version "1.0.0-beta.1"
cmderr	[generate.py] 2021-05-06 01:54:04 INFO autorest --version=3.1.3 --use=@autorest/java@4.0.25 --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/storagepool/azure-resourcemanager-storagepool --java.namespace=com.azure.resourcemanager.storagepool   --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/storagepool/resource-manager/readme.md
cmderr	[generate.py] 2021-05-06 01:54:33 INFO [CI][Success] Write to ci.yml
cmderr	[generate.py] 2021-05-06 01:54:33 INFO [POM][Process] dealing with pom.xml
cmderr	[generate.py] 2021-05-06 01:54:33 INFO [POM][Skip] pom already has module azure-resourcemanager-storagepool
cmderr	[generate.py] 2021-05-06 01:54:33 INFO [POM][Success] Write to pom.xml
cmderr	[generate.py] 2021-05-06 01:54:33 INFO [POM][Process] dealing with root pom
cmderr	[generate.py] 2021-05-06 01:54:33 INFO [POM][Success] Write to root pom

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

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

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

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

warn	Skip initScript due to not configured
command	autorest --version=V2 --typescript --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.typescript@4.4.4 --typescript-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-js/azure-sdk-for-js ../../azure-rest-api-specs/specification/storagepool/resource-manager/readme.md

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

azure-arm-storagepool-1.0.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/storagePoolManagement.js → ./dist/arm-storagepool.js...
cmderr	[npmPack] created ./dist/arm-storagepool.js in 352ms

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

⚠️Warning [Logs]Release - Generate from 3ae1665. 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-storagepool [View full logs] [Release SDK Changes]
- azure-mgmt-storagepool-1.0.0b1.zip
- azure_mgmt_storagepool-1.0.0b1-py2.py3-none-any.whl
```
info	[Changelog]   - Initial Release
```

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

 Please click here to preview with your @microsoft account.

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

openapi-workflow-bot · 2021-04-15T23:46:15Z

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

openapi-workflow-bot · 2021-04-15T23:47:59Z

Hi @harshitha-akkaraju, 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 · 2021-04-16T01:55:35Z

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

...oragepool/resource-manager/Microsoft.StoragePool/preview/2021-04-01-preview/storagepool.json

...rce-manager/Microsoft.StoragePool/preview/2021-04-01-preview/examples/DiskPoolSkus_List.json

...urce-manager/Microsoft.StoragePool/preview/2021-04-01-preview/examples/IscsiTargets_Put.json

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

* Update readme.md * Update readme.python.md

azure-pipelines · 2021-04-29T06:24:36Z

Pull request contains merge conflicts.

…m/Azure/azure-rest-api-specs into dev/hakkaraj/storagepoolv2preview

akning-ms · 2021-05-03T01:14:18Z

/azp run

azure-pipelines · 2021-05-03T01:14:29Z

Azure Pipelines successfully started running 1 pipeline(s).

* No changes -- new version directory with old specs * New API version Changes * Validation errors * revisions * Fixes * Revisions * Revisions * Revisions * Updates * Annotating required property * Availability zone is not required during Disk Pool Creation * Fixing swagger route typo * Fixes Avocado errors due to swagger file not being referenced * Updated python readme * [python] Update readme.md (Azure#14184) * Update readme.md * Update readme.python.md * Fix merge conflicts * Swagger linting errors Co-authored-by: Harshitha Akkaraju <hakkaraj@microsoft.com> Co-authored-by: msyyc <70930885+msyyc@users.noreply.github.com>

Harshitha Akkaraju added 2 commits April 15, 2021 14:58

No changes -- new version directory with old specs

45e2b46

New API version Changes

937a1c2

harshitha-akkaraju requested review from 00Kai0, ArcturusZhang, jsntcy, msyyc, RAY-316 and zhangyan133 as code owners April 15, 2021 23:46

openapi-assignment-bot bot assigned ChenTanyi Apr 15, 2021

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

openapi-pipeline-app bot added the CI-FixRequiredOnFailure label Apr 15, 2021

This was referenced Apr 15, 2021

[AutoPR @azure/arm-storagepool] StoragePool RP New Preview API AzureSDKAutomation/azure-sdk-for-js#4393

Closed

[AutoPR azure-resourcemanager-storagepool] StoragePool RP New Preview API AzureSDKAutomation/azure-sdk-for-java#8303

Closed

ChenTanyi added the BreakingChangeReviewRequired label Apr 16, 2021

Validation errors

1a4e399

openapi-pipeline-app bot added CI-FixRequiredOnFailure and removed CI-FixRequiredOnFailure labels Apr 18, 2021

j5lim self-requested a review April 19, 2021 17:11