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

update(acns): advanced networking profile to note addition costs #29146

Conversation

snguyen64
Copy link
Contributor

ARM (Control Plane) API Specification Update Pull Request

Tip

Overwhelmed by all this guidance? See the Getting help section at the bottom of this PR description.

PR review workflow diagram

Please understand this diagram before proceeding. It explains how to get your PR approved & merged.

spec_pr_review_workflow_diagram

Purpose of this PR

What's the purpose of this PR? Check the specific option that applies. This is mandatory!

  • New resource provider.
  • New API version for an existing resource provider. (If API spec is not defined in TypeSpec, the PR should have been created in adherence to OpenAPI specs PR creation guidance).
  • Update existing version for a new feature. (This is applicable only when you are revising a private preview API version.)
  • Update existing version to fix OpenAPI spec quality issues in S360.
  • Other, please clarify:
    • update description of advanced networking to note to user that enabling this may incur additional costs

Due diligence checklist

To merge this PR, you must go through the following checklist and confirm you understood
and followed the instructions by checking all the boxes:

  • I confirm this PR is modifying Azure Resource Manager (ARM) related specifications, and not data plane related specifications.
  • I have reviewed following Resource Provider guidelines, including
    ARM resource provider contract and
    REST guidelines (estimated time: 4 hours).
    I understand this is required before I can proceed to the diagram Step 2, "ARM API changes review", for this PR.

Additional information

Viewing API changes

For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the Generated ApiView comment added to this PR. You can use ApiView to show API versions diff.

Suppressing failures

If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
suppressions guide to get approval.

Getting help

  • First, please carefully read through this PR description, from top to bottom. Please fill out the Purpose of this PR and Due diligence checklist.
  • To understand what you must do next to merge this PR, see the Next Steps to Merge comment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.
  • For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure
    and https://aka.ms/ci-fix.
  • For help with ARM review (PR workflow diagram Step 2), see https://aka.ms/azsdk/pr-arm-review.
  • If the PR CI checks appear to be stuck in queued state, please add a comment with contents /azp run.
    This should result in a new comment denoting a PR validation pipeline has started and the checks should be updated after few minutes.
  • If the help provided by the previous points is not enough, post to https://aka.ms/azsdk/support/specreview-channel and link to this PR.

Copy link

openapi-pipeline-app bot commented May 17, 2024

Next Steps to Merge

✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge.

Copy link

Hi @snguyen64, this service has enabled ShiftLeft Toolset. All spec updates MUST be initiated from service ADO project repo, so that to guarantee it to be the source of truth., please review this pull request if it is intentional or reject it if it is not expected. Normally, all the specification or example changes should start with PR created in ADO.

  • You can refer to ShiftLeft Toolset Introduction for details.
  • Please contact service focal contacts or ShiftLeft Toolset Support Channel if need further help.
  • Copy link

    openapi-pipeline-app bot commented May 17, 2024

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    Compared specs (v0.10.9) new version base version
    managedClusters.json 2024-03-02-preview(16056d7) 2024-03-02-preview(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 specs (v2.2.2) new version base version
    package-preview-2024-03 package-preview-2024-03(16056d7) package-preview-2024-03(main)

    The following errors/warnings exist before current PR submission:

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

    Rule Message
    OperationsApiResponseSchema The response schema of operations API '/providers/Microsoft.ContainerService/operations' does not match the ARM specification. Please standardize the schema.
    Location: aks/preview/2024-03-02-preview/managedClusters.json#L52
    OperationsApiSchemaUsesCommonTypes Operations API path must follow the schema provided in the common types.
    Location: aks/preview/2024-03-02-preview/managedClusters.json#L53
    ParametersInPointGet Query parameter resource-type should be removed. Point Get's MUST not have query parameters other than api version.
    Location: aks/preview/2024-03-02-preview/managedClusters.json#L80
    XmsPageableForListCalls x-ms-pageable extension must be specified for LIST APIs.
    Location: aks/preview/2024-03-02-preview/managedClusters.json#L116
    GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
    Location: aks/preview/2024-03-02-preview/managedClusters.json#L137
    ResourceNameRestriction The resource name parameter 'roleName' should be defined with a 'pattern' restriction.
    Location: aks/preview/2024-03-02-preview/managedClusters.json#L278
    ParametersInPost server-fqdn is a query parameter. Post operation must not contain any query parameter other than api-version.
    Location: aks/preview/2024-03-02-preview/managedClusters.json#L336
    ParametersInPost server-fqdn is a query parameter. Post operation must not contain any query parameter other than api-version.
    Location: aks/preview/2024-03-02-preview/managedClusters.json#L381
    ParametersInPost format is a query parameter. Post operation must not contain any query parameter other than api-version.
    Location: aks/preview/2024-03-02-preview/managedClusters.json#L381
    ParametersInPost server-fqdn is a query parameter. Post operation must not contain any query parameter other than api-version.
    Location: aks/preview/2024-03-02-preview/managedClusters.json#L429
    LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
    Location: aks/preview/2024-03-02-preview/managedClusters.json#L569
    PatchResponseCodes Long-running PATCH operations must have responses with 200, 202 and default return codes. They also must not have other response codes.
    Location: aks/preview/2024-03-02-preview/managedClusters.json#L676
    PatchIdentityProperty The patch operation body parameter schema should contain property 'identity'.
    Location: aks/preview/2024-03-02-preview/managedClusters.json#L695
    LroPatch202 The async patch operation should return 202.
    Location: aks/preview/2024-03-02-preview/managedClusters.json#L713
    LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
    Location: aks/preview/2024-03-02-preview/managedClusters.json#L723
    LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
    Location: aks/preview/2024-03-02-preview/managedClusters.json#L781
    ResourceNameRestriction The resource name parameter 'configName' should be defined with a 'pattern' restriction.
    Location: aks/preview/2024-03-02-preview/managedClusters.json#L841
    PostResponseCodes Long-running POST operations must have responses with 202 and default return codes. They must also have a 200 return code if only if the final response is intended to have a schema, if not the 200 return code must not be specified. They also must not have other response codes.
    Location: aks/preview/2024-03-02-preview/managedClusters.json#L1011
    LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
    Location: aks/preview/2024-03-02-preview/managedClusters.json#L1055
    LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
    Location: aks/preview/2024-03-02-preview/managedClusters.json#L1223
    LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
    Location: aks/preview/2024-03-02-preview/managedClusters.json#L1347
    XmsPageableForListCalls x-ms-pageable extension must be specified for LIST APIs.
    Location: aks/preview/2024-03-02-preview/managedClusters.json#L1562
    OperationIdNounVerb Per the Noun_Verb convention for Operation Ids, the noun 'AgentPools' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: aks/preview/2024-03-02-preview/managedClusters.json#L1566
    GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
    Location: aks/preview/2024-03-02-preview/managedClusters.json#L1586
    PostResponseCodes 200 return code does not have a schema specified. LRO POST must have a 200 return code if only if the final response is intended to have a schema, if not the 200 return code must not be specified.
    Location: aks/preview/2024-03-02-preview/managedClusters.json#L1605
    LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
    Location: aks/preview/2024-03-02-preview/managedClusters.json#L1651
    PostResponseCodes 200 return code does not have a schema specified. LRO POST must have a 200 return code if only if the final response is intended to have a schema, if not the 200 return code must not be specified.
    Location: aks/preview/2024-03-02-preview/managedClusters.json#L1667
    LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
    Location: aks/preview/2024-03-02-preview/managedClusters.json#L1714
    PostResponseCodes Long-running POST operations must have responses with 202 and default return codes. They must also have a 200 return code if only if the final response is intended to have a schema, if not the 200 return code must not be specified. They also must not have other response codes.
    Location: aks/preview/2024-03-02-preview/managedClusters.json#L1730
    LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
    Location: aks/preview/2024-03-02-preview/managedClusters.json#L1771
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️SwaggerAPIView 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.
    ️️✔️SpellCheck succeeded [Detail] [Expand]
    Validation passes for SpellCheck.
    ️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
    Validation passes for Lint(RPaaS).
    ️️✔️PR Summary succeeded [Detail] [Expand]
    Validation passes for Summary.
    ️️✔️Automated merging requirements met succeeded [Detail] [Expand]
    Posted by Swagger Pipeline | How to fix these errors?

    Copy link

    openapi-pipeline-app bot commented May 17, 2024

    Swagger Generation Artifacts

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

    Only 0 items are rendered, please refer to log for more details.

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

    Only 0 items are rendered, please refer to log for more details.

    ️❌ azure-sdk-for-java failed [Detail]

    Only 0 items are rendered, please refer to log for more details.

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

    Only 0 items are rendered, please refer to log for more details.

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

    Only 0 items are rendered, please refer to log for more details.

    ️❌ azure-sdk-for-net-track2 failed [Detail]

    Only 0 items are rendered, please refer to log for more details.

    ️❌ azure-resource-manager-schemas failed [Detail]

    Only 0 items are rendered, please refer to log for more details.

    ️️✔️ azure-powershell succeeded [Detail] [Expand]

    Only 0 items are rendered, please refer to log for more details.

    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-workflow-bot openapi-workflow-bot bot added ShiftLeftViolation DoNotMerge <valid label in PR review process> use to hold merge after approval labels May 17, 2024
    Copy link

    openapi-pipeline-app bot commented May 17, 2024

    @snguyen64 snguyen64 force-pushed the retina-advanced-networking-api-update-2024-03-02-preview branch from 5f56037 to 30db5d1 Compare May 28, 2024 14:24
    @gary-x-li gary-x-li added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label May 30, 2024
    @openapi-pipeline-app openapi-pipeline-app bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label May 30, 2024
    @FumingZhang
    Copy link
    Member

    /pr RequestMerge

    @microsoft-github-policy-service microsoft-github-policy-service bot added the MergeRequested Part of the ARM PR review workflow label Jun 6, 2024
    @FumingZhang FumingZhang removed the DoNotMerge <valid label in PR review process> use to hold merge after approval label Jun 6, 2024
    @rkmanda rkmanda merged commit c2f037e into Azure:main Jun 9, 2024
    28 of 32 checks passed
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review MergeRequested Part of the ARM PR review workflow ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test resource-manager ShiftLeftViolation
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    None yet

    6 participants