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.

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

Add Kind for managed environment #21554

Conversation

Juliehzl
Copy link
Contributor

@Juliehzl Juliehzl commented Nov 15, 2022

ARM API Information (Control Plane)

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.

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. By default, Azure SDKs of all languages (.NET/Python/Java/JavaScript for both management-plane SDK and data-plane SDK, Go for management-plane SDK only ) MUST be refreshed with/after swagger of new version is published. If you prefer NOT to refresh any specific SDK language upon swagger updates in the current PR, please leave details with justification here.

Contribution checklist (MS Employees Only):

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 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 copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. You can use OpenAPIHub to initialize the PR for adding a new version. For 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 you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.

Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.

NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)

Please follow the link to find more details on PR review process.

@openapi-workflow-bot
Copy link

Hi, @Juliehzl 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
    Copy link

    openapi-pipeline-app bot commented Nov 15, 2022

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
    There are no breaking changes.
    compared swaggers (via Oad v0.10.2)] new version base version
    ManagedEnvironments.json 2022-11-01-preview(c0d9f7c) 2022-03-01(main)
    ManagedEnvironments.json 2022-11-01-preview(c0d9f7c) 2022-06-01-preview(main)
    ️️✔️LintDiff succeeded [Detail] [Expand]
    Validation passes for LintDiff.
    compared tags (via openapi-validator v2.0.0) new version base version
    package-preview-2022-11 package-preview-2022-11(c0d9f7c) package-preview-2022-11(release-app-Microsoft.App-2022-11-01-preview)
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️~[Staging] SwaggerAPIView succeeded [Detail] [Expand]
    ️️✔️ModelValidation succeeded [Detail] [Expand]
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand]
    Validation passes for SemanticValidation.
    ️️✔️PrettierCheck succeeded [Detail] [Expand]
    Validation passes for PrettierCheck.
    ️️✔️SpellCheck succeeded [Detail] [Expand]
    Validation passes for SpellCheck.
    ️️✔️CadlValidation succeeded [Detail] [Expand]
    Validation passes for CadlValidation.
    ️️✔️PR Summary succeeded [Detail] [Expand]
    Validation passes for Summary.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Nov 15, 2022

    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-python-track2 failed [Detail]
    • Failed [Logs] Generate from 6c6e0157ae089485fcd56966c8867011f269b0bc. 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]  notice
      cmderr	[automation_generate.sh] npm notice New major version of npm available! 8.19.2 -> 9.1.1
      cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.1.1>
      cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@9.1.1` to update!
      cmderr	[automation_generate.sh] npm notice
      cmdout	[automation_generate.sh] [Autorest]  494 |             "modelAsString": true
      cmdout	[automation_generate.sh] [Autorest]  495 |           },
      cmdout	[automation_generate.sh] [Autorest]  496 |           "default": "Single"
      cmdout	[automation_generate.sh] [Autorest] -----------------^
      cmdout	[automation_generate.sh] [Autorest]  497 |         },
      cmdout	[automation_generate.sh] [Autorest]  498 |         "ingress": {
      cmdout	[automation_generate.sh] [Autorest] error   | Autorest completed with an error. If you think the error message is unclear, or is a bug, please declare an issues at https://github.com/Azure/autorest/issues with the error message you are seeing.
      cmdout	[automation_generate.sh] [Autorest]  494 |             "modelAsString": true
      cmdout	[automation_generate.sh] [Autorest]  495 |           },
      cmdout	[automation_generate.sh] [Autorest]  496 |           "default": "Single"
      cmdout	[automation_generate.sh] [Autorest] -----------------^
      cmdout	[automation_generate.sh] [Autorest]  497 |         },
      cmdout	[automation_generate.sh] [Autorest]  498 |         "ingress": {
      cmdout	[automation_generate.sh] [Autorest] error   | Autorest completed with an error. If you think the error message is unclear, or is a bug, please declare an issues at https://github.com/Azure/autorest/issues with the error message you are seeing.
      cmdout	[automation_generate.sh] [Autorest]/mnt/vss/_work/1/s/azure-sdk-for-python_tmp/venv-sdk/auto_temp.json does not exist!!!Error happened during codegen
      error	Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-python]: sh scripts/automation_generate.sh
      warn	Skip package processing as generation is failed
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs] Generate from 6c6e0157ae089485fcd56966c8867011f269b0bc. 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
      cmderr	[init.sh] [notice] A new release of pip available: 22.3 -> 22.3.1
      cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
      cmderr	[init.sh] [notice] A new release of pip available: 22.3 -> 22.3.1
      cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
      command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
      warn	No file changes detected after generation
      warn	No package detected after generation
    ️❌ azure-sdk-for-go failed [Detail]
    • Failed [Logs] Generate from 6c6e0157ae089485fcd56966c8867011f269b0bc. 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
      cmderr	[generator automation-v2] [ERROR] total 1 error(s):
      cmderr	[generator automation-v2] [ERROR] failed to execute `go generate` '�[33;1mWARNING: Unable to find version for /mnt/vss/_work/1/s/azure-sdk-for-go/src/github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appcontainers/armappcontainers�[0m
      cmderr	[generator automation-v2] [ERROR] Cannot find go module under resourcemanager/appcontainers/armappcontainers, try to build in /mnt/vss/_work/1/s/azure-sdk-for-go/src/github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appcontainers/armappcontainers
      cmderr	[generator automation-v2] [ERROR] ##[command]Cleaning auto-generated files in /mnt/vss/_work/1/s/azure-sdk-for-go/src/github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appcontainers/armappcontainers
      cmderr	[generator automation-v2] [ERROR] ##[command]Executing autorest.go in  /mnt/vss/_work/1/s/azure-sdk-for-go/src/github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appcontainers/armappcontainers
      cmderr	[generator automation-v2] [ERROR] autorest --version=3.8.2 --use=@autorest/go@4.0.0-preview.44 --go --track2 --output-folder=/mnt/vss/_work/1/s/azure-sdk-for-go/src/github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appcontainers/armappcontainers --clear-output-folder=false --go.clear-output-folder=false --honor-body-placement=true --remove-unreferenced-types=false ./autorest.md
      cmderr	[generator automation-v2] [ERROR] AutoRest code generation utility [cli version: 3.6.1; node: v16.17.1]
      cmderr	[generator automation-v2] [ERROR] (C) 2018 Microsoft Corporation.
      cmderr	[generator automation-v2] [ERROR] https://aka.ms/autorest
      cmderr	[generator automation-v2] [ERROR] info    | AutoRest core version selected from configuration: 3.8.2.
      cmderr	[generator automation-v2] [ERROR] There is a new version of AutoRest available (3.6.2).
      cmderr	[generator automation-v2] [ERROR] > You can install the newer version with with npm install -g autorest@latest
      cmderr	[generator automation-v2] [ERROR] info    |    Loading AutoRest core      '/home/cloudtest/.autorest/@autorestcore@3.8.2/nodemodules/@autorest/core/dist' (3.8.2)
      cmderr	[generator automation-v2] [ERROR] warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future.
      cmderr	[generator automation-v2] [ERROR] warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future.
      cmderr	[generator automation-v2] [ERROR] warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future.
      cmderr	[generator automation-v2] [ERROR] warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future.
      cmderr	[generator automation-v2] [ERROR] warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future.
      cmderr	[generator automation-v2] [ERROR] warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future.
      cmderr	[generator automation-v2] [ERROR] warning | DeprecatedConfig | Using directive.2.suppress which is deprecated and will be removed in the future.
      cmderr	[generator automation-v2] [ERROR] warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and will be removed in the future.
      cmderr	[generator automation-v2] [ERROR] warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future.
      cmderr	[generator automation-v2] [ERROR] warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future.
      cmderr	[generator automation-v2] [ERROR] warning | DeprecatedConfig | Using directive.6.suppress which is deprecated and will be removed in the future.
      cmderr	[generator automation-v2] [ERROR] warning | DeprecatedConfig | Using directive.7.suppress which is deprecated and will be removed in the future.
      cmderr	[generator automation-v2] [ERROR] warning | DeprecatedConfig | Using directive.8.suppress which is deprecated and will be removed in the future.
      cmderr	[generator automation-v2] [ERROR] warning | DeprecatedConfig | Using directive.9.suppress which is deprecated and will be removed in the future.
      cmderr	[generator automation-v2] [ERROR] warning | DeprecatedConfig | Using directive.10.suppress which is deprecated and will be removed in the future.
      cmderr	[generator automation-v2] [ERROR] info    |    Installing AutoRest extension '@autorest/go' (4.0.0-preview.44 -> 4.0.0-preview.44)
      cmderr	[generator automation-v2] [ERROR] info    |    Installed AutoRest extension '@autorest/go' (4.0.0-preview.44->4.0.0-preview.44)
      cmderr	[generator automation-v2] [ERROR] info    |    Installing AutoRest extension '@autorest/modelerfour' (4.23.1 -> 4.23.1)
      cmderr	[generator automation-v2] [ERROR] info    |    Installed AutoRest extension '@autorest/modelerfour' (4.23.1->4.23.1)
      cmderr	[generator automation-v2] [ERROR] fatal   | Process() cancelled due to failure
      cmderr	[generator automation-v2] [ERROR] error   |   YAMLException: duplicated mapping key (496:11)
      cmderr	[generator automation-v2] [ERROR] 493 |             "name": "ActiveRevisionsMode",
      cmderr	[generator automation-v2] [ERROR] 494 |             "modelAsString": true
      cmderr	[generator automation-v2] [ERROR] 495 |           },
      cmderr	[generator automation-v2] [ERROR] 496 |           "default": "Single"
      cmderr	[generator automation-v2] [ERROR] -----------------^
      cmderr	[generator automation-v2] [ERROR] 497 |         },
      cmderr	[generator automation-v2] [ERROR] 498 |         "ingress": {
      cmderr	[generator automation-v2] [ERROR] error   | Autorest completed with an error. If you think the error message is unclear, or is a bug, please declare an issues at https://github.com/Azure/autorest/issues with the error message you are seeing.
      cmderr	[generator automation-v2] [ERROR] ##[error]Error running autorest.go
      cmderr	[generator automation-v2] [ERROR] build.go:5: running "pwsh": exit status 1
      cmderr	[generator automation-v2] [ERROR] ': exit status 1
      error	Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-go/src/github.com/Azure/azure-sdk-for-go]: generator automation-v2
      warn	Skip package processing as generation is failed
    ️❌ azure-sdk-for-js failed [Detail]
    • Failed [Logs] Generate from 6c6e0157ae089485fcd56966c8867011f269b0bc. 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
      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
      cmderr	[automation_generate.sh] [ERROR] An error occurred while generating codes for readme file: "specification/app/resource-manager/readme.md":
      cmderr	[automation_generate.sh] [ERROR] Err: Error: Command failed: autorest --version=3.8.4 --typescript --modelerfour.lenient-model-deduplication --azure-arm --head-as-boolean=true --license-header=MICROSOFT_MIT_NO_VERSION --generate-test --typescript-sdks-folder=/mnt/vss/_work/1/s/azure-sdk-for-js ../azure-rest-api-specs/specification/app/resource-manager/readme.md --use=@autorest/typescript@6.0.0-rc.2
      cmderr	[automation_generate.sh] [ERROR] Stderr: "null"
      cmderr	[automation_generate.sh] [ERROR] Stdout: "null"
      cmderr	[automation_generate.sh] [ERROR] ErrorStack: "Error: Command failed: autorest --version=3.8.4 --typescript --modelerfour.lenient-model-deduplication --azure-arm --head-as-boolean=true --license-header=MICROSOFT_MIT_NO_VERSION --generate-test --typescript-sdks-folder=/mnt/vss/_work/1/s/azure-sdk-for-js ../azure-rest-api-specs/specification/app/resource-manager/readme.md --use=@autorest/typescript@6.0.0-rc.2
      cmderr	[automation_generate.sh] [ERROR]     at checkExecSyncError (node:child_process:841:11)
      cmderr	[automation_generate.sh] [ERROR]     at Object.execSync (node:child_process:912:15)
      cmderr	[automation_generate.sh] [ERROR]     at Object.<anonymous> (/opt/hostedtoolcache/node/16.17.1/x64/lib/node_modules/@azure-tools/js-sdk-release-tools/dist/hlc/generateMgmt.js:39:33)
      cmderr	[automation_generate.sh] [ERROR]     at Generator.next (<anonymous>)
      cmderr	[automation_generate.sh] [ERROR]     at /opt/hostedtoolcache/node/16.17.1/x64/lib/node_modules/@azure-tools/js-sdk-release-tools/node_modules/tslib/tslib.js:115:75
      cmderr	[automation_generate.sh] [ERROR]     at new Promise (<anonymous>)
      cmderr	[automation_generate.sh] [ERROR]     at Object.__awaiter (/opt/hostedtoolcache/node/16.17.1/x64/lib/node_modules/@azure-tools/js-sdk-release-tools/node_modules/tslib/tslib.js:111:16)
      cmderr	[automation_generate.sh] [ERROR]     at Object.generateMgmt (/opt/hostedtoolcache/node/16.17.1/x64/lib/node_modules/@azure-tools/js-sdk-release-tools/dist/hlc/generateMgmt.js:20:20)
      cmderr	[automation_generate.sh] [ERROR]     at /opt/hostedtoolcache/node/16.17.1/x64/lib/node_modules/@azure-tools/js-sdk-release-tools/dist/autoGenerateInPipeline.js:43:34"
      error	Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-js]: sh .scripts/automation_generate.sh
      warn	Skip package processing as generation is failed
    ️❌ azure-resource-manager-schemas failed [Detail]
    • Failed [Logs] Generate from 6c6e0157ae089485fcd56966c8867011f269b0bc. 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
    • app/resource-manager [View full logs]  [Preview Schema Changes]
    ️❌ azure-powershell failed [Detail]
    • Failed [Logs] Generate from 6c6e0157ae089485fcd56966c8867011f269b0bc. 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
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Nov 15, 2022

    Generated ApiView

    Language Package Name ApiView Link
    swagger Microsoft.App Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.

    "kind": {
    "type": "string",
    "description": "Kind of the Environment."
    },
    Copy link
    Contributor

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    Should we update the sample files to include this property?

    Copy link
    Contributor Author

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    Yes, we can. But as it is optional, it is not required to add in examples.

    @leniatgh leniatgh merged commit 843dd69 into Azure:release-app-Microsoft.App-2022-11-01-preview Nov 22, 2022
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    4 participants