Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

New API version for Microsoft.Resources stable/2021-04-01 #14102

Closed
wants to merge 4 commits into from
Closed

New API version for Microsoft.Resources stable/2021-04-01 #14102

wants to merge 4 commits into from

Conversation

wwendyc
Copy link
Contributor

@wwendyc wwendyc commented Apr 23, 2021 •
edited
Loading

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.

  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 you are targeting to deploy new service/feature to public regions? Please provide date, or month to public if date is not available yet.
  3. When you expect to publish swagger? Please provide date, or month to public if date is not available yet.
  4. 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:

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
Copy link

Hi, @wwendyc 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-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Apr 23, 2021 •
    edited
    Loading

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand] 
    There are no breaking changes.
    ️🔄LintDiff inProgress [Detail]
    ️️✔️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) succeeded [Detail] [Expand] 
    There are no breaking changes.
    ️️✔️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 errors/warnings are introduced by current PR:

    |:speech_balloon: AutorestCore/Exception|"readme":"resources/resource-manager/readme.md",
    "tag":"package-resources-2021-04",
    "details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"|
    |:speech_balloon: AutorestCore/Exception|"readme":"resources/resource-manager/readme.md",
    "tag":"package-resources-2021-04",
    "details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|
    |:speech_balloon: AutorestCore/Exception|"readme":"resources/resource-manager/readme.md",
    "tag":"package-resources-2021-04",
    "details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"|
    |:speech_balloon: AutorestCore/Exception|"readme":"resources/resource-manager/readme.md",
    "tag":"package-subscriptions-2021-04",
    "details":"> Loading AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|
    |:speech_balloon: AutorestCore/Exception|"readme":"resources/resource-manager/readme.md",
    "tag":"package-subscriptions-2021-04",
    "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-workflow-bot
    Copy link

    [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
    Copy link

    openapi-pipeline-app bot commented Apr 23, 2021 •
    edited
    Loading

    Swagger Generation Artifacts

    ️❌[Staging] ApiDocPreview: 1 Errors, 0 Warnings failed [Detail]
    Rule Message
    ❌ RestBuild error "logUrl":"https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=210626&view=logs&j=fd490c07-0b22-5182-fac9-6d67fe1e939b",
    "detail":"Run.ps1 failed with exit code 1 "
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs] Generate from 95852e7da51bcf79eb76effab35e83984227b258. 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-04-24 00:07:13 INFO [VERSION][Not Found] cannot find version for "com.azure.resourcemanager:azure-resourcemanager-resources-generated"
cmderr	[generate.py] 2021-04-24 00:07:13 INFO [VERSION][Not Found] cannot find stable version, current version "1.0.0-beta.1"
cmderr	[generate.py] 2021-04-24 00:07:13 INFO autorest --version=3.1.3 --use=@autorest/java@4.0.24 --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/resources/azure-resourcemanager-resources-generated --java.namespace=com.azure.resourcemanager.resources.generated --tag=package-resources-2021-04  --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/resources/resource-manager/readme.md
cmderr	[generate.py] 2021-04-24 00:08:04 INFO [CI][Success] Write to ci.yml
cmderr	[generate.py] 2021-04-24 00:08:04 INFO [POM][Process] dealing with pom.xml
cmderr	[generate.py] 2021-04-24 00:08:04 INFO [POM][Skip] pom already has module azure-resourcemanager-resources-generated
cmderr	[generate.py] 2021-04-24 00:08:04 INFO [POM][Success] Write to pom.xml
cmderr	[generate.py] 2021-04-24 00:08:04 INFO [POM][Process] dealing with root pom
cmderr	[generate.py] 2021-04-24 00:08:04 INFO [POM][Success] Write to root pom
    • ️✔️azure-resourcemanager-resources-generated [View full logs]  [Preview SDK Changes] 
      cmderr	[Inst] 2021-04-24 00:11:43 DEBUG Got artifact_id: azure-resourcemanager-resources-generated
cmderr	[Inst] 2021-04-24 00:11:43 DEBUG Got artifact: pom.xml
cmderr	[Inst] 2021-04-24 00:11:43 DEBUG Got artifact: azure-resourcemanager-resources-generated-1.0.0-beta.1.jar
cmderr	[Inst] 2021-04-24 00:11:43 DEBUG Match jar package: azure-resourcemanager-resources-generated-1.0.0-beta.1.jar
cmderr	[Inst] 2021-04-24 00:11:43 DEBUG output: {"full": "```sh\ncurl -L \"https://portal.azure-devex-tools.com/api/sdk-dl-pub?p=Azure/14102/azure-sdk-for-java/azure-resourcemanager-resources-generated/azure-resourcemanager-resources-generated-1.0.0-beta.1.jar\" -o azure-resourcemanager-resources-generated-1.0.0-beta.1.jar\nmvn install:install-file -DgroupId=com.azure.resourcemanager -DartifactId=azure-resourcemanager-resources-generated -Dversion=1.0.0-beta.0 -Dfile=azure-resourcemanager-resources-generated-1.0.0-beta.1.jar -Dpackaging=jar -DgeneratePom=true
```"}
    ️️✔️ azure-sdk-for-net succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from 95852e7da51bcf79eb76effab35e83984227b258. SDK Automation 14.0.0 
      warn	Skip initScript due to not configured
command	sudo apt-get install -y dotnet-sdk-5.0
command	autorest --version=V2 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.csharp@2.3.82 --csharp-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/resources/resource-manager/readme.md
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
    • ️✔️Microsoft.Azure.Management.ResourceManager [View full logs]  [Preview SDK Changes]
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs] Generate from 95852e7da51bcf79eb76effab35e83984227b258. 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-resource [View full logs]  [Preview SDK Changes] Breaking Change Detected
      info	[Changelog] **Features**
info	[Changelog]
info	[Changelog]   - Model TemplateSpecVersion has a new parameter main_template
info	[Changelog]   - Model TemplateSpecVersion has a new parameter ui_form_definition
info	[Changelog]   - Model TemplateSpecVersion has a new parameter metadata
info	[Changelog]   - Model TemplateSpecVersion has a new parameter linked_templates
info	[Changelog]   - Model TemplateSpec has a new parameter metadata
info	[Changelog]
info	[Changelog] **Breaking changes**
info	[Changelog]
info	[Changelog]   - Model TemplateSpecVersion no longer has parameter artifacts
info	[Changelog]   - Model TemplateSpecVersion no longer has parameter template
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from 95852e7da51bcf79eb76effab35e83984227b258. 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/resources/resource-manager/readme.md
    • ️✔️@azure/arm-features [View full logs]  [Preview SDK Changes] 
      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/featureClient.js → ./dist/arm-features.js...
cmderr	[npmPack] created ./dist/arm-features.js in 158ms
    • ️✔️@azure/arm-links [View full logs]  [Preview SDK Changes] 
      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/managementLinkClient.js → ./dist/arm-links.js...
cmderr	[npmPack] created ./dist/arm-links.js in 161ms
    • ️✔️@azure/arm-locks [View full logs]  [Preview SDK Changes] 
      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/managementLockClient.js → ./dist/arm-locks.js...
cmderr	[npmPack] created ./dist/arm-locks.js in 217ms
    • ️✔️@azure/arm-managedapplications [View full logs]  [Preview SDK Changes] 
      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/applicationClient.js → ./dist/arm-managedapplications.js...
cmderr	[npmPack] created ./dist/arm-managedapplications.js in 292ms
    • ️✔️@azure/arm-policy [View full logs]  [Preview SDK Changes] 
      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/policyClient.js → ./dist/arm-policy.js...
cmderr	[npmPack] created ./dist/arm-policy.js in 402ms
    • ️✔️@azure/arm-resources [View full logs]  [Preview SDK Changes] 
      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/resourceManagementClient.js → ./dist/arm-resources.js...
cmderr	[npmPack] created ./dist/arm-resources.js in 608ms
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs] Generate from 95852e7da51bcf79eb76effab35e83984227b258. 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 read-shrinkwrap This version of npm is compatible with lockfileVersion@1, but package-lock.json was generated for lockfileVersion@2. I'll try to do my best with it!
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
cmderr	[generateScript.sh] (node:2909) UnhandledPromiseRejectionWarning: Error: ENOENT: no such file or directory, unlink '/home/vsts/work/1/s/azure-resource-manager-schemas/schemas/2020-08-01/Microsoft.Resources.json'
cmderr	[generateScript.sh] (Use `node --trace-warnings ...` to show where the warning was created)
cmderr	[generateScript.sh] (node:2909) UnhandledPromiseRejectionWarning: Unhandled promise rejection. This error originated either by throwing inside of an async function without a catch block, or by rejecting a promise which was not handled with .catch(). To terminate the node process on unhandled promise rejection, use the CLI flag `--unhandled-rejections=strict` (see https://nodejs.org/api/cli.html#cli_unhandled_rejections_mode). (rejection id: 1)
cmderr	[generateScript.sh] (node:2909) [DEP0018] DeprecationWarning: Unhandled promise rejections are deprecated. In the future, promise rejections that are not handled will terminate the Node.js process with a non-zero exit code.
warn	No file changes detected after generation
    • ️✔️resources [View full logs]  [Preview Schema Changes]
    Posted by Swagger Pipeline | How to fix these errors?

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

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

    @openapi-workflow-bot
    Copy link

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

    TaskHow to fixPrioritySupport (Microsoft alias)
    AvocadoFix-AvocadoHighruowan
    Semantic validationFix-SemanticValidation-ErrorHighraychen, jianyxi
    Model validationFix-ModelValidation-ErrorHighraychen,jianyxi
    LintDiffFix-LintDiffhighjianyxi, ruoxuan
     If you need further help, please feedback via swagger feedback."

    This was referenced Apr 23, 2021
    Draft
    Draft
    Draft
    Draft
    Draft
    Draft
    Draft
    This was referenced Apr 24, 2021
    Draft
    Draft
    Draft
    @chiragg4u
    Copy link
    Contributor

    As captured in the ARM review checklist
    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.

    This is a must before the review can be continued, please create new PR with these changes.

    @wwendyc
    Copy link
    Contributor Author

    wwendyc commented Apr 26, 2021 •
    edited
    Loading

    Opened new PR with stepped commits #14132

    @wwendyc wwendyc closed this Apr 26, 2021
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Reviewers

    @fwanggg fwanggg fwanggg left review comments

    Assignees

    @raych1 raych1

    Labels
    CI-BreakingChange-Go WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required
    Projects
    None yet
    Milestone
    No milestone
    Development

    Successfully merging this pull request may close these issues.
    4 participants
    @wwendyc @chiragg4u @fwanggg @raych1