Skip to content

added quota request example for Azure Lab Services#23328

Merged
XiaofeiCao merged 1 commit intoAzure:mainfrom
rajaharish:Als_quota_doc_updates
Apr 4, 2023
Merged

added quota request example for Azure Lab Services#23328
XiaofeiCao merged 1 commit intoAzure:mainfrom
rajaharish:Als_quota_doc_updates

Conversation

@rajaharish
Copy link
Contributor

@rajaharish rajaharish commented Mar 28, 2023 •
edited by openapi-workflow-bot bot
Loading

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

openapi-workflow-bot bot commented Mar 28, 2023

Hi, @rajaharish 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 Mar 28, 2023 •
    edited
    Loading

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand] 
    There are no breaking changes.
    compared swaggers (via Oad v0.10.4)] new version base version
    support.json 2020-04-01(98cf5a1) 2020-04-01(main)
    ️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand] 
    There are no breaking changes.
    ️️✔️CredScan succeeded [Detail] [Expand] 
    There is no credential detected.
    ️⚠️LintDiff: 0 Warnings warning [Detail]
    compared tags (via openapi-validator v2.0.0) new version base version
    package-2020-04 package-2020-04(98cf5a1) package-2020-04(main)

    The following errors/warnings exist before current PR submission:

    Rule Message
    ❌ OperationsApiResponseSchema The response schema of operations API '/providers/Microsoft.Support/operations' does not match the ARM specification. Please standardize the schema.
    Location: Microsoft.Support/stable/2020-04-01/support.json#L52
    ❌ ResourceNameRestriction The resource name parameter 'serviceName' should be defined with a 'pattern' restriction.
    Location: Microsoft.Support/stable/2020-04-01/support.json#L109
    ❌ ResourceNameRestriction The resource name parameter 'serviceName' should be defined with a 'pattern' restriction.
    Location: Microsoft.Support/stable/2020-04-01/support.json#L149
    ❌ ResourceNameRestriction The resource name parameter 'serviceName' should be defined with a 'pattern' restriction.
    Location: Microsoft.Support/stable/2020-04-01/support.json#L192
    ❌ ResourceNameRestriction The resource name parameter 'problemClassificationName' should be defined with a 'pattern' restriction.
    Location: Microsoft.Support/stable/2020-04-01/support.json#L192
    ❌ AllResourcesMustHaveDelete The resource SupportTicketDetails does not have a corresponding delete operation.
    Location: Microsoft.Support/stable/2020-04-01/support.json#L350
    ❌ PathForPutOperation The path for 'put' operation must be under a subscription and resource group.
    Location: Microsoft.Support/stable/2020-04-01/support.json#L350
    ❌ ResourceNameRestriction The resource name parameter 'supportTicketName' should be defined with a 'pattern' restriction.
    Location: Microsoft.Support/stable/2020-04-01/support.json#L350
    ❌ ConsistentPatchProperties The property 'severity' in the request body either not apppear in the resource model or has the wrong level.
    Location: Microsoft.Support/stable/2020-04-01/support.json#L411
    ❌ ConsistentPatchProperties The property 'status' in the request body either not apppear in the resource model or has the wrong level.
    Location: Microsoft.Support/stable/2020-04-01/support.json#L411
    ❌ ConsistentPatchProperties The property 'contactDetails' in the request body either not apppear in the resource model or has the wrong level.
    Location: Microsoft.Support/stable/2020-04-01/support.json#L411
    ❌ CreateOperationAsyncResponseValidation An async PUT operation must return 201.
    Location: Microsoft.Support/stable/2020-04-01/support.json#L478
    ❌ CreateOperationAsyncResponseValidation Only 201 is the supported response code for PUT async response.
    Location: Microsoft.Support/stable/2020-04-01/support.json#L485
    ❌ LroLocationHeader A 202 response should include an Location response header.
    Location: Microsoft.Support/stable/2020-04-01/support.json#L485
    ❌ ResourceNameRestriction The resource name parameter 'supportTicketName' should be defined with a 'pattern' restriction.
    Location: Microsoft.Support/stable/2020-04-01/support.json#L557
    ❌ ResourceNameRestriction The resource name parameter 'supportTicketName' should be defined with a 'pattern' restriction.
    Location: Microsoft.Support/stable/2020-04-01/support.json#L609
    ❌ PathForPutOperation The path for 'put' operation must be under a subscription and resource group.
    Location: Microsoft.Support/stable/2020-04-01/support.json#L676
    ❌ ResourceNameRestriction The resource name parameter 'supportTicketName' should be defined with a 'pattern' restriction.
    Location: Microsoft.Support/stable/2020-04-01/support.json#L676
    ❌ ResourceNameRestriction The resource name parameter 'communicationName' should be defined with a 'pattern' restriction.
    Location: Microsoft.Support/stable/2020-04-01/support.json#L676
    ❌ CreateOperationAsyncResponseValidation An async PUT operation must return 201.
    Location: Microsoft.Support/stable/2020-04-01/support.json#L762
    ❌ CreateOperationAsyncResponseValidation Only 201 is the supported response code for PUT async response.
    Location: Microsoft.Support/stable/2020-04-01/support.json#L769
    ❌ LroLocationHeader A 202 response should include an Location response header.
    Location: Microsoft.Support/stable/2020-04-01/support.json#L769
    ❌ MissingTypeObject The schema 'OperationsListResult' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Support/stable/2020-04-01/support.json#L792
    ❌ MissingTypeObject The schema 'display' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Support/stable/2020-04-01/support.json#L816
    ❌ XmsParameterLocation The parameter 'SubscriptionIdParameter' is defined in global parameters section without 'x-ms-parameter-location' extension. This would add the parameter as the client property. Please ensure that this is exactly you want. If so, apply the extension 'x-ms-parameter-location': 'client'. Else, apply the extension 'x-ms-parameter-location': 'method'.
    Location: Microsoft.Support/stable/2020-04-01/support.json#L1544
    ❌ XmsParameterLocation The parameter 'ApiVersionParameter' is defined in global parameters section without 'x-ms-parameter-location' extension. This would add the parameter as the client property. Please ensure that this is exactly you want. If so, apply the extension 'x-ms-parameter-location': 'client'. Else, apply the extension 'x-ms-parameter-location': 'method'.
    Location: Microsoft.Support/stable/2020-04-01/support.json#L1551
    ⚠️ EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
    Location: Microsoft.Support/stable/2020-04-01/support.json#L978
    ⚠️ EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
    Location: Microsoft.Support/stable/2020-04-01/support.json#L1185
    ️️✔️Avocado succeeded [Detail] [Expand] 
    Validation passes for Avocado.
    ️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
    ️⚠️~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]

    API Test is not triggered due to precheck failure. Check pipeline log for details.

    ️️✔️SwaggerAPIView succeeded [Detail] [Expand]
    ️️✔️CadlAPIView succeeded [Detail] [Expand]
    ️️✔️TypeSpecAPIView 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.
    ️️✔️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.
    ️️✔️TypeSpec Validation succeeded [Detail] [Expand] 
    Validation passes for TypeSpec Validation.
    ️️✔️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 Mar 28, 2023 •
    edited
    Loading

    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 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from fc55500. 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! 9.5.0 -> 9.6.3
cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.6.3>
cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@9.6.3` to update!
cmderr	[automation_generate.sh] npm notice
    • ️✔️track2_azure-mgmt-support [View full logs]  [Release SDK Changes] 
      info	[Changelog]
    ️️✔️ azure-sdk-for-java succeeded [Detail] [Expand]
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from fc55500. 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] Cannot generate changelog because the codes of local and npm may be the same.
    • ️✔️@azure/arm-support [View full logs]  [Release SDK Changes] 
      info	[Changelog]
error	breakingChangeTracking is enabled, but version or changelogItem is not found in output.
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from fc55500. 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
    • ️✔️sdk/resourcemanager/support/armsupport [View full logs]  [Release SDK Changes] 
      info	[Changelog] ### Other Changes
info	[Changelog]
info	[Changelog] Total 0 breaking change(s), 0 additive change(s).
    ️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from fc55500. SDK Automation 14.0.0 
      command	pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json
command	pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json
    • ️✔️Azure.ResourceManager.Support [View full logs]  [Release SDK Changes] 
      info	[Changelog]
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from fc55500. 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
    • ️✔️support [View full logs] 
    ️️✔️ azure-powershell succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from fc55500. 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.support.DefaultTag [View full logs]  [Release SDK Changes]
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Mar 28, 2023 •
    edited
    Loading

    Generated ApiView

    Language Package Name ApiView Link
    Go sdk/resourcemanager/support/armsupport https://apiview.dev/Assemblies/Review/e8c5250fba2a45959b4f1c04acf2c0c6
    .Net Azure.ResourceManager.Support There is no API change compared with the previous version
    Java azure-resourcemanager-support There is no API change compared with the previous version
    JavaScript @azure/arm-support https://apiview.dev/Assemblies/Review/413740f1453b4587ac23bfe7e5b264ed

    @azure-sdk azure-sdk mentioned this pull request Mar 28, 2023
    Closed
    This was referenced Mar 28, 2023
    Closed
    Closed
    Closed
    Closed
    Closed
    @XiaofeiCao XiaofeiCao merged commit fc55500 into Azure:main Apr 4, 2023
    This was referenced Apr 4, 2023
    Closed
    Closed
    Closed
    Closed
    Closed
    Closed
    JoshLove-msft pushed a commit to JoshLove-msft/azure-rest-api-specs that referenced this pull request Apr 25, 2023
    @rajaharish @JoshLove-msft
    added quota request example for Azure Lab Services (Azure#23328)
    800ff5d
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Reviewers

    @XiaofeiCao XiaofeiCao XiaofeiCao approved these changes

    Assignees

    @XiaofeiCao XiaofeiCao

    Labels

    resource-manager

    Projects

    None yet

    Milestone

    No milestone

    Development

    Successfully merging this pull request may close these issues.

    3 participants

    @rajaharish @XiaofeiCao @AzureRestAPISpecReview

    Comments