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 IPAM, VNV, AVNM Security Admin spec and change Vnet swagger spec #30271

Conversation

arjun-d-patel
Copy link
Contributor

…ationPrefixes to vnet and subnet properties

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.
  • Convert existing OpenAPI spec to TypeSpec spec (do not combine this with implementing changes for a new API version).
  • Other, please clarify:
    • edit this with your clarification

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.
  • If you don't have permissions to remove or add labels to the PR, request write access per aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositories
  • 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 Aug 20, 2024

Next Steps to Merge

Next steps that must be taken to merge this PR:
  • ❌ Your PR requires an API stewardship board review as it introduces a new API version (label: new-api-version). Schedule the review by following aka.ms/azsdk/onboarding/restapischedule.
  • ❌ This PR is in purview of the ARM review (label: ARMReview). This PR must get ARMSignedOff label from an ARM reviewer.
    This PR has ARMChangesRequested label. Please address or respond to feedback from the ARM API reviewer.
    When you are ready to continue the ARM API review, please remove the ARMChangesRequested label.
    Automation should then add WaitForARMFeedback label.
    ❗If you don't have permissions to remove the label, request write access per aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositories.
    For details of the ARM review, see aka.ms/azsdk/pr-arm-review

Copy link

openapi-pipeline-app bot commented Aug 20, 2024

Generated ApiView

Language Package Name ApiView Link
Go sdk/resourcemanager/azurestackhci/armazurestackhci https://apiview.dev/Assemblies/Review/714a234c6e7b41d7b2defde3b6cbdecb?revisionId=c664461aefb94d8b91fdaeece5d1d473
Go sdk/resourcemanager/computefleet/armcomputefleet https://apiview.dev/Assemblies/Review/d735ff32937b476cb8320846d8f090fb?revisionId=f27542ee9507434a90b93aa2c4ddf5c7
Go sdk/resourcemanager/network/armnetwork https://apiview.dev/Assemblies/Review/1b263a329090477991c0a7b7b0ae21d7?revisionId=8f2c85d7b2df45ac94c6287dd67168e0
Go sdk/resourcemanager/playwrighttesting/armplaywrighttesting https://apiview.dev/Assemblies/Review/4b3f831082c643c4b0b73ef97037b5e9?revisionId=ca8083200d754fe8ae780a1154995b73
Go sdk/resourcemanager/security/armsecurity https://apiview.dev/Assemblies/Review/88de20a29c604e9cbb6f756102580913?revisionId=80967563934240c59fc7c2d2d401d877
Java azure-resourcemanager-azurefleet https://apiview.dev/Assemblies/Review/fcbbab29b49f487c94ede09c53937db1?revisionId=8cd5f3f9afbd4986976383a48a908cf5
Java azure-resourcemanager-azurestackhci https://apiview.dev/Assemblies/Review/edc81aded3464d2aa74b65e7a3e87057?revisionId=de80ca3816e4433981942c625ac5d50d
Java azure-resourcemanager-computefleet There is no API change compared with the previous version
Java azure-resourcemanager-playwrighttesting https://apiview.dev/Assemblies/Review/1bd459ec74cb4a53a4d19cdb7e9db406?revisionId=c877884df0194f66b4668a327c907571
Java azure-resourcemanager-security https://apiview.dev/Assemblies/Review/4bbce61669f64b1bb4b00043576ed1e7?revisionId=c0bc80889e204eb98c95dbe965c0c0ed
JavaScript @azure/arm-azurestackhci https://apiview.dev/Assemblies/Review/9cb6b13668c54359adf4531a56933de1?revisionId=f426f8a82b784679a17ca024d4286516
JavaScript @azure/arm-computefleet https://apiview.dev/Assemblies/Review/188df6dd79f149f6b31814188a80ea1e?revisionId=0f9c42e8da7c4b12960fecb58bf3d755
JavaScript @azure/arm-network https://apiview.dev/Assemblies/Review/c13fd66ecbcc4c2a9995c8a1f4187240?revisionId=e969c7f57e22437b9f7e86056666eb23
JavaScript @azure/arm-playwrighttesting https://apiview.dev/Assemblies/Review/3a5ef77675cd496b8ea7476458ea8d4b?revisionId=ce4430ed1f7b4bcdacffeb425d1593a2
JavaScript @azure/arm-security https://apiview.dev/Assemblies/Review/7b0611da161f46f58e9bb08f96d69207?revisionId=b2392ef662f441a7a82713dc1081fb43
.Net Azure.AI.Language.Documents https://apiview.dev/Assemblies/Review/a0b17597d1d74d83ba2cdf9fcf4ab555?revisionId=bf3856728554463085e03c45d3fde846
.Net Azure.ResourceManager.SecurityCenter https://apiview.dev/Assemblies/Review/74fbb1c9067c4827bd67f3e2cffb4080?revisionId=4ab68ff8ccd14a1899dbd7fef51e69e7
Swagger Language https://apiview.dev/Assemblies/Review/d940fcb06e874adebca52d9bf9e40221?revisionId=1689920893f6488c879ac4bc80bff900
Swagger Microsoft.AzureFleet https://apiview.dev/Assemblies/Review/b2d4ceed52e5406dadbe817bea6e5e16?revisionId=743e6dabd28441849f9dc23a8477be2a
Swagger Microsoft.AzurePlaywrightService https://apiview.dev/Assemblies/Review/39085ca5f9b54ca18e7d6b912ff27b2b?revisionId=469f3fb14707494eae6185762ae19cf6
Swagger Microsoft.AzureStackHCI https://apiview.dev/Assemblies/Review/99a5bdd4697547b4bbe812f2c58e5c8d?revisionId=273d37385ffe4c9da69f1392fe3ad8a0
Swagger Microsoft.Network https://apiview.dev/Assemblies/Review/9a91f46aa0a846acaae91aba821517fb?revisionId=531d0fa84d7f402caedebe580e78d9b2
TypeSpec AzureFleet.Management https://apiview.dev/Assemblies/Review/196f76e0371549da806d8c057f4c2169?revisionId=3619af98755c473c8e9b4e5d02007de3
TypeSpec AzureStackHCI.StackHCIVM.Management https://apiview.dev/Assemblies/Review/b3ac630ce9324be38f24c2c26a57a6e4?revisionId=64990bb4b7c5401fb73715fd71f0229c
TypeSpec Language.AnalyzeDocuments https://apiview.dev/Assemblies/Review/cb261544dcb741c68ee038f89117fea2?revisionId=057f2e90b1d941b0bb6d4709d2c504c1
TypeSpec PlaywrightTesting.Management https://apiview.dev/Assemblies/Review/8d7e4b8460bd4874b59430d6790390d8?revisionId=1e1235c3511a41039f6e02b29883b51c
TypeSpec Workloads.SAPVirtualInstance.Management https://apiview.dev/Assemblies/Review/9004f4662e1f4595937ad857dbc7adec?revisionId=0dd40aecdfa04a54be1b46f5583583c3

@arjun-d-patel
Copy link
Contributor Author

All the changes are from these 2 PRs which have been reviewed and approved:
https://github.com/Azure/azure-rest-api-specs-pr/pull/19000
https://github.com/Azure/azure-rest-api-specs-pr/pull/18922

@arjun-d-patel
Copy link
Contributor Author

LintDiff errors are from this open issue: Azure/azure-openapi-validator#722

@arjun-d-patel arjun-d-patel marked this pull request as ready for review August 21, 2024 15:11
…01' into arjun/add-ipam-vnv-vnet-avnmsa-changes
@AzureRestAPISpecReview AzureRestAPISpecReview added ARMReview WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Aug 21, 2024
@mentat9
Copy link
Member

mentat9 commented Aug 22, 2024

    "networkIdentifier": {

Looks like this property was added after ARM signed off on previous PRs. Consider naming this property "networkResourceId" or similar, indicating it is a resource ID. Also consider changing it to string type with format: arm-id and the x-ms-arm-id-details extension. Ref: https://github.com/Azure/autorest/blob/main/docs/extensions/readme.md#x-ms-arm-id-details.

In current form, using the common definition object it violates the rule against duplicating ARM top-level properties (id) within the property bag. In addition, you couldn't add x-ms-arm-details, since the definition is most likely used many places and the details would vary depending on where it is used. You probably could add format: arm-id to the common definition, but with the size and complexity of NRP, it would be hard to verify how safe that is.


Refers to: specification/network/resource-manager/Microsoft.Network/stable/2024-03-01/virtualNetwork.json:1700 in 915d52d. [](commit_id = 915d52d, deletion_comment = False)

@mentat9 mentat9 added the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Aug 22, 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 Aug 22, 2024
@arjun-d-patel
Copy link
Contributor Author

    "networkIdentifier": {

Looks like this property was added after ARM signed off on previous PRs. Consider naming this property "networkResourceId" or similar, indicating it is a resource ID. Also consider changing it to string type with format: arm-id and the x-ms-arm-id-details extension. Ref: https://github.com/Azure/autorest/blob/main/docs/extensions/readme.md#x-ms-arm-id-details.

In current form, using the common definition object it violates the rule against duplicating ARM top-level properties (id) within the property bag. In addition, you couldn't add x-ms-arm-details, since the definition is most likely used many places and the details would vary depending on where it is used. You probably could add format: arm-id to the common definition, but with the size and complexity of NRP, it would be hard to verify how safe that is.

Refers to: specification/network/resource-manager/Microsoft.Network/stable/2024-03-01/virtualNetwork.json:1700 in 915d52d. [](commit_id = 915d52d, deletion_comment = False)

Hi @mentat9, this last commit (915d52d) was a merge with base branch commit that was done. I am not making these changes so don't have the context here of what should be the fix.

@sssharma24 sssharma24 removed the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Aug 22, 2024
@openapi-pipeline-app openapi-pipeline-app bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Aug 22, 2024
This was referenced Aug 29, 2024
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.