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

VirtualNetworkGatewayConnection using key vault for authentication. #28760

Conversation

daweiwang-microsoft
Copy link
Member

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.

Note

As of January 2024 there is no PR assignee. This is expected. See https://aka.ms/azsdk/pr-arm-review.

PR review workflow diagram

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

diagram

Click here to see the details of Step 1, Breaking Changes review

If you are in purview of Step 1 of the diagram, follow the Breaking Changes review process.
IMPORTANT! This applies even if you believe your PR was mislabeled, for any reason, including tool failure.

Click here to see the details of Step 2, ARM review

See https://aka.ms/azsdk/pr-arm-review.

Click here to see the diagram footnotes

Diagram footnotes

[1] See ARM review queue (for PR merge queues, see [2]).
[2] public repo merge queue, private repo merge queue (for ARM review queue, [1])
The ARM reviewer on-call engineer visits the merge queue twice a day, so the approximate ETA for merges is 12 - 24 hours.

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 generated using OpenAPI Hub).
  • 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:
    • 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.
  • 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 PR workflow diagram Step 2 (ARM review), 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 Apr 19, 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

openapi-pipeline-app bot commented Apr 19, 2024

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 specs (v0.10.9) new version base version
virtualNetworkGateway.json 2024-01-01(15cfd7e) 2023-11-01(main)
️❌LintDiff: 1 Errors, 0 Warnings failed [Detail]
Compared specs (v2.2.2) new version base version
package-2024-01 package-2024-01(15cfd7e) package-2024-01(release-network-Microsoft.Network-2024-01-01)

[must fix]The following errors/warnings are introduced by current PR:

Rule Message Related RPC [For API reviewers]
PatchIdentityProperty The patch operation body parameter schema should contain property 'identity'.
Location: Microsoft.Network/stable/2024-01-01/virtualNetworkGateway.json#L235
RPC-Patch-V1-11


The following errors/warnings exist before current PR submission:

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

Rule Message
ResourceNameRestriction The resource name parameter 'virtualNetworkGatewayName' should be defined with a 'pattern' restriction.
Location: Microsoft.Network/stable/2024-01-01/virtualNetworkGateway.json#L37
DeleteResponseCodes Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes.
Location: Microsoft.Network/stable/2024-01-01/virtualNetworkGateway.json#L159
LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.Network/stable/2024-01-01/virtualNetworkGateway.json#L191
LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.Network/stable/2024-01-01/virtualNetworkGateway.json#L252
ResourceNameRestriction The resource name parameter 'virtualNetworkGatewayName' should be defined with a 'pattern' restriction.
Location: Microsoft.Network/stable/2024-01-01/virtualNetworkGateway.json#L325
ResourceNameRestriction The resource name parameter 'virtualNetworkGatewayName' should be defined with a 'pattern' restriction.
Location: Microsoft.Network/stable/2024-01-01/virtualNetworkGateway.json#L378
ParametersInPost gatewayVip is a query parameter. Post operation must not contain any query parameter other than api-version.
Location: Microsoft.Network/stable/2024-01-01/virtualNetworkGateway.json#L385
LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.Network/stable/2024-01-01/virtualNetworkGateway.json#L415
ResourceNameRestriction The resource name parameter 'virtualNetworkGatewayName' should be defined with a 'pattern' restriction.
Location: Microsoft.Network/stable/2024-01-01/virtualNetworkGateway.json#L442
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: Microsoft.Network/stable/2024-01-01/virtualNetworkGateway.json#L443
LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.Network/stable/2024-01-01/virtualNetworkGateway.json#L475
ResourceNameRestriction The resource name parameter 'virtualNetworkGatewayName' should be defined with a 'pattern' restriction.
Location: Microsoft.Network/stable/2024-01-01/virtualNetworkGateway.json#L496
LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.Network/stable/2024-01-01/virtualNetworkGateway.json#L541
ResourceNameRestriction The resource name parameter 'virtualNetworkGatewayName' should be defined with a 'pattern' restriction.
Location: Microsoft.Network/stable/2024-01-01/virtualNetworkGateway.json#L562
LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.Network/stable/2024-01-01/virtualNetworkGateway.json#L607
ResourceNameRestriction The resource name parameter 'virtualNetworkGatewayName' should be defined with a 'pattern' restriction.
Location: Microsoft.Network/stable/2024-01-01/virtualNetworkGateway.json#L628
LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.Network/stable/2024-01-01/virtualNetworkGateway.json#L664
ResourceNameRestriction The resource name parameter 'virtualNetworkGatewayName' should be defined with a 'pattern' restriction.
Location: Microsoft.Network/stable/2024-01-01/virtualNetworkGateway.json#L685
ParametersInPost peer is a query parameter. Post operation must not contain any query parameter other than api-version.
Location: Microsoft.Network/stable/2024-01-01/virtualNetworkGateway.json#L692
LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.Network/stable/2024-01-01/virtualNetworkGateway.json#L728
ResourceNameRestriction The resource name parameter 'virtualNetworkGatewayName' should be defined with a 'pattern' restriction.
Location: Microsoft.Network/stable/2024-01-01/virtualNetworkGateway.json#L749
ResourceNameRestriction The resource name parameter 'virtualNetworkGatewayName' should be defined with a 'pattern' restriction.
Location: Microsoft.Network/stable/2024-01-01/virtualNetworkGateway.json#L799
LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.Network/stable/2024-01-01/virtualNetworkGateway.json#L835
ResourceNameRestriction The resource name parameter 'virtualNetworkGatewayName' should be defined with a 'pattern' restriction.
Location: Microsoft.Network/stable/2024-01-01/virtualNetworkGateway.json#L856
ParametersInPost peer is a query parameter. Post operation must not contain any query parameter other than api-version.
Location: Microsoft.Network/stable/2024-01-01/virtualNetworkGateway.json#L863
LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.Network/stable/2024-01-01/virtualNetworkGateway.json#L899
ResourceNameRestriction The resource name parameter 'virtualNetworkGatewayName' should be defined with a 'pattern' restriction.
Location: Microsoft.Network/stable/2024-01-01/virtualNetworkGateway.json#L920
LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.Network/stable/2024-01-01/virtualNetworkGateway.json#L959
ResourceNameRestriction The resource name parameter 'virtualNetworkGatewayName' should be defined with a 'pattern' restriction.
Location: Microsoft.Network/stable/2024-01-01/virtualNetworkGateway.json#L986
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: Microsoft.Network/stable/2024-01-01/virtualNetworkGateway.json#L987
️️✔️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.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️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 Apr 19, 2024

Swagger Generation Artifacts

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

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

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

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-sdk-for-python warning [Detail]

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

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

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

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

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-resource-manager-schemas failed [Detail]

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

️⚠️ azure-powershell warning [Detail]

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

Posted by Swagger Pipeline | How to fix these errors?

@ramoka178
Copy link
Contributor

Please fix LintDiff errors at https://github.com/Azure/azure-rest-api-specs/pull/28760/checks?check_run_id=24164949911 at place it back in ARM queue

@ramoka178 ramoka178 added the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Apr 23, 2024
Copy link

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.
This will notify the reviewer to have another look.
If the feedback provided needs further discussion, please use this Teams channel to post your questions - aka.ms/azsdk/support/specreview-channel.
Please include [ARM Query] in the title of your question to indicate that it is ARM-related.

@openapi-workflow-bot openapi-workflow-bot bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Apr 23, 2024
@microsoft-github-policy-service microsoft-github-policy-service bot added no-recent-activity There has been no recent activity on this issue. and removed no-recent-activity There has been no recent activity on this issue. labels May 13, 2024
@Khushboo-Baheti Khushboo-Baheti removed the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label May 14, 2024
@openapi-workflow-bot openapi-workflow-bot bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label May 14, 2024
@razvanbadea-msft razvanbadea-msft removed the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label May 21, 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 May 21, 2024
@razvanbadea-msft razvanbadea-msft added the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label May 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 May 22, 2024
@daweiwang-microsoft
Copy link
Member Author

Need PR suppression for Swagger LintDiff failure "PatchIdentityProperty" according to suggestions from ARM office hour.
Reason: My service design forces this behavior. This API already existed for a long time and the new added property "identity" should only be modified by PUT operation rather than PATCH.

@razvanbadea-msft razvanbadea-msft added WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required Approved-LintDiff labels May 24, 2024
@razvanbadea-msft
Copy link
Contributor

Approved lintdiff check supppresion based on #28760 (comment)

@razvanbadea-msft razvanbadea-msft added ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review and removed ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review labels May 24, 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 24, 2024
@daweiwang-microsoft daweiwang-microsoft removed the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label May 29, 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 May 29, 2024
@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 29, 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 29, 2024
@daweiwang-microsoft
Copy link
Member Author

/pr RequestMerge

@daweiwang-microsoft
Copy link
Member Author

The SDK failures are not related to my change. Please merge this PR.

@gary-x-li
Copy link
Contributor

/azp run

Copy link

Azure Pipelines successfully started running 4 pipeline(s).

@gary-x-li gary-x-li merged commit c37ec24 into Azure:release-network-Microsoft.Network-2024-01-01 May 31, 2024
24 of 29 checks passed
@daweiwang-microsoft daweiwang-microsoft deleted the daweiwang/certauthconn branch May 31, 2024 17:34
GuptaVertika added a commit that referenced this pull request Jun 6, 2024
rkmanda pushed a commit that referenced this pull request Jun 19, 2024
…29302)

* Adds base for updating Microsoft.Network from version stable/2023-11-01 to version 2024-01-01

* Updates readme

* Updates API version in new specs and examples

* Add examples for Subnet peering and v6 Subnet peering. (#28827)

Add examples for Subnet peering and v6 Subnet peering.
---------

Co-authored-by: saurabh83 <[email protected]>

* Init (#29127)

Co-authored-by: Abhishek Shah <[email protected]>

* Adding the new response code to the 2024-01-01 version release of swagger to match the bugfix in 2023-11-01 (#29048)

Co-authored-by: Arsheen Khatib (from Dev Box) <[email protected]>

* Added NoHealthyBackendsBehavior (#28868)

Added the property "NoHealthyBackendsBehavior" to the Probe properties.

* VirtualNetworkGatewayConnection using key vault for authentication. (#28760)

* Add parameters for cert based auth connection

* retrigger checks

* retrigger checks

* lintDiff

* Trigger Build

* revert PATCH changes

* fix

* change managed identity to v5

* add format and description

* rresolving conflict

* resolving readme file

* Revert "VirtualNetworkGatewayConnection using key vault for authentication. (#28760)"

This reverts commit c37ec24.

* Lint diff error suppress

* Guptavertika/release network microsoft.network official 2024 01 01 (#29367)

* added networkidentifier under vnet->subet->serviceendpoint

* added format :armid and updated description

* corrected the type

* fixed response

* response type fixed example

---------

Co-authored-by: Bhupesh Bhatt <[email protected]>

* Adding GET operaton for Network Virtual Appliance Inbound Secuirty Rule (#29339) (#29375)

* Fix for PR VirtualNetworkGatewayConnection using key vault for authentication. (#29357) (#29376)

* Fix

* Fix2

---------

Co-authored-by: Khushboo Baheti <[email protected]>

* Add CrossConnection Name as an optional query parameter in List ExpressRoute CrossConnection (#29251)

* Add CrossConnection name as an optional query parameter for List CrossConnection

* update example

* Addressing comments

* Change to OData filtering

* Fix the parameter reference

* Update

---------

Co-authored-by: Jianqi Zhao <[email protected]>

* initial changes (#29235)

* Changed type of networkIdentifier from PublicIPAddress to SubResource (#29469)

* added networkidentifier under vnet->subet->serviceendpoint

* added format :armid and updated description

* corrected the type

* fixed response

* response type fixed example

* Changed type of networkIdentifier from ./publicIpAddress.json#/definitions/PublicIPAddress to ./network.json#/definitions/SubResource

---------

Co-authored-by: Bhupesh Bhatt <[email protected]>

---------

Co-authored-by: saurabh83 <[email protected]>
Co-authored-by: saurabh83 <[email protected]>
Co-authored-by: Abhishek Shah <[email protected]>
Co-authored-by: Abhishek Shah <[email protected]>
Co-authored-by: AFK1194 <[email protected]>
Co-authored-by: Arsheen Khatib (from Dev Box) <[email protected]>
Co-authored-by: Eugenio Peña García <[email protected]>
Co-authored-by: daweiwang-microsoft <[email protected]>
Co-authored-by: Bhupesh Kumar Bhatt <[email protected]>
Co-authored-by: Bhupesh Bhatt <[email protected]>
Co-authored-by: Ashutosh Mishra <[email protected]>
Co-authored-by: Khushboo Baheti <[email protected]>
Co-authored-by: Khushboo Baheti <[email protected]>
Co-authored-by: jianzhao1992 <[email protected]>
Co-authored-by: Jianqi Zhao <[email protected]>
Co-authored-by: nimaller <[email protected]>
mentat9 pushed a commit that referenced this pull request Jun 21, 2024
#29473)

* Adds base for updating Microsoft.Network from version stable/2023-11-01 to version 2024-01-01

* Updates readme

* Updates API version in new specs and examples

* Add examples for Subnet peering and v6 Subnet peering. (#28827)

Add examples for Subnet peering and v6 Subnet peering.
---------

Co-authored-by: saurabh83 <[email protected]>

* Init (#29127)

Co-authored-by: Abhishek Shah <[email protected]>

* Adding the new response code to the 2024-01-01 version release of swagger to match the bugfix in 2023-11-01 (#29048)

Co-authored-by: Arsheen Khatib (from Dev Box) <[email protected]>

* Added NoHealthyBackendsBehavior (#28868)

Added the property "NoHealthyBackendsBehavior" to the Probe properties.

* VirtualNetworkGatewayConnection using key vault for authentication. (#28760)

* Add parameters for cert based auth connection

* retrigger checks

* retrigger checks

* lintDiff

* Trigger Build

* revert PATCH changes

* fix

* change managed identity to v5

* add format and description

* added networkidentifier under vnet->subet->serviceendpoint (#29292)

* added networkidentifier under vnet->subet->serviceendpoint

* resolving conflict (#29343)

* Fix for PR VirtualNetworkGatewayConnection using key vault for authentication. (#29357)

* Fix

* Fix2

---------

Co-authored-by: Khushboo Baheti <[email protected]>

* Adding GET operaton for Network Virtual Appliance Inbound Secuirty Rule (#29339)

* Moving missed changes from 2023-11-01 packet capture swagger fix to latest api version

* Add CrossConnection Name as an optional query parameter in List ExpressRoute CrossConnection (#29251)

* Add CrossConnection name as an optional query parameter for List CrossConnection

* update example

* Addressing comments

* Change to OData filtering

* Fix the parameter reference

* Update

---------

Co-authored-by: Jianqi Zhao <[email protected]>

* initial changes (#29235)

* adding supression for the breaking change in azure-sdk-for-go

* adding correct package for this supression

---------

Co-authored-by: GuptaVertika <[email protected]>
Co-authored-by: saurabh83 <[email protected]>
Co-authored-by: saurabh83 <[email protected]>
Co-authored-by: Abhishek Shah <[email protected]>
Co-authored-by: Abhishek Shah <[email protected]>
Co-authored-by: AFK1194 <[email protected]>
Co-authored-by: Arsheen Khatib (from Dev Box) <[email protected]>
Co-authored-by: Eugenio Peña García <[email protected]>
Co-authored-by: daweiwang-microsoft <[email protected]>
Co-authored-by: Bhupesh Kumar Bhatt <[email protected]>
Co-authored-by: Khushboo Baheti <[email protected]>
Co-authored-by: Khushboo Baheti <[email protected]>
Co-authored-by: Ashutosh Mishra <[email protected]>
Co-authored-by: jianzhao1992 <[email protected]>
Co-authored-by: Jianqi Zhao <[email protected]>
Co-authored-by: nimaller <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Approved-LintDiff ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review resource-manager
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants