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 APIs to Get/Put/List shared key of vpn link connection for vwan VpnGateway #30074

Conversation

shengliumsft
Copy link
Contributor

@shengliumsft shengliumsft commented Aug 5, 2024

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:
    • Add APIs to Get/Put/List shared key of vpn link connection for vwan VpnGateway

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 5, 2024

Next Steps to Merge

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

@shengliumsft shengliumsft changed the title Add spec for shared key API of VpnGateway vpn link connection Add APIs to Get/Put/List shared key of vpn link connection for vwan VpnGateway Aug 6, 2024
@shengliumsft shengliumsft marked this pull request as ready for review August 6, 2024 06:28
@AzureRestAPISpecReview AzureRestAPISpecReview added ARMReview WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Aug 6, 2024
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/vpnConnections/{connectionName}/vpnLinkConnections/{linkConnectionName}/sharedKeys": {
"get": {
"operationId": "VpnLinkConnections_GetAllSharedKeys",
"description": "Lists all shared keys of VpnLink connection specified.",
Copy link
Member

Choose a reason for hiding this comment

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

Make this a part of a new API version

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@rkmanda , 2024-03-01 is the latest API version for Microsoft.Network. Can we use 2024-03-01 for our APIs?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@rkmanda, I understand your concern about breaking change on this version (2024-03-01). The manifest rollout may already be completed, allowing users to use this version in production. Unfortunately, we cannot control the swagger release process, since NRP team is driving the release. But, this issue does not seem to be specific to our PR. Technically, any change in the 2024-03-01 Swagger release PR might be considered a breaking change, right? Also, our new APIs do not have public documentation yet, so users are not aware of them. Can you please help us work out a plan? I am happy to jump on a call. Thanks!

@shengliumsft shengliumsft force-pushed the liusheng/vwanvpngatewaysharedkey_newapi branch 2 times, most recently from 3a616e0 to 3e081e2 Compare August 9, 2024 07:23
@rkmanda rkmanda added Approved-Suppression ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review labels Aug 13, 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 13, 2024
Copy link
Member

@rkmanda rkmanda left a comment

Choose a reason for hiding this comment

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

:shipit:

@rkmanda rkmanda merged commit 3d6e80e into Azure:guptavertika/release-network-Microsoft.Network-2024-03-01 Aug 13, 2024
21 of 27 checks passed
dtuCloud pushed a commit to dtuCloud/azure-rest-api-specs that referenced this pull request Aug 26, 2024
…pnGateway (Azure#30074)

* first commit

* run prettier

* fix checks

* fix checks

* resolve comments

* suppress error
GuptaVertika pushed a commit that referenced this pull request Sep 10, 2024
…pnGateway (#30074)

* first commit

* run prettier

* fix checks

* fix checks

* resolve comments

* suppress error
jaskisin pushed a commit to jaskisin/azure-rest-api-specs that referenced this pull request Sep 16, 2024
…pnGateway (Azure#30074)

* first commit

* run prettier

* fix checks

* fix checks

* resolve comments

* suppress error
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Approved-Suppression ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review Network resource-manager SuppressionReviewRequired
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants