Add AdminState Property to Virtual Network Gateway Resource Properties #23978

nimaller · 2023-05-13T01:08:40Z

Adding property AdminState to Virtual Network Gateway. This will allow users to choose which Express Route gw to use to serve traffic during Express Route gateway migration.

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:

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
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.
When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
This release is managed by networking team.
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):

I commit to follow the Breaking Change Policy of "no breaking changes"
I have reviewed the documentation for the workflow.
Validation tools were run on swagger spec(s) and errors have all been fixed in this PR. How to fix?

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 · 2023-05-13T01:08:43Z

Hi, @nimaller 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 · 2023-05-13T01:08:44Z

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 swaggers (via Oad v0.10.4)]	new version	base version
virtualNetworkGateway.json	2023-02-01(bd3a3da)	2022-11-01(main)

️⚠️LintDiff: 0 Warnings warning [Detail]

compared tags (via openapi-validator v2.1.2)	new version	base version
package-2023-02	package-2023-02(bd3a3da)	package-2023-02(release-network-Microsoft.Network-official-2023-02-01)

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/2023-02-01/virtualNetworkGateway.json#L37
`❌` LroErrorContent	Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.Network/stable/2023-02-01/virtualNetworkGateway.json#L91
`❌` LroLocationHeader	A 202 response should include an Location response header. Location: Microsoft.Network/stable/2023-02-01/virtualNetworkGateway.json#L185
`❌` LroErrorContent	Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.Network/stable/2023-02-01/virtualNetworkGateway.json#L194
`❌` LroLocationHeader	A 202 response should include an Location response header. Location: Microsoft.Network/stable/2023-02-01/virtualNetworkGateway.json#L246
`❌` LroErrorContent	Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.Network/stable/2023-02-01/virtualNetworkGateway.json#L258
`❌` ResourceNameRestriction	The resource name parameter 'virtualNetworkGatewayName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/stable/2023-02-01/virtualNetworkGateway.json#L319
`❌` ResourceNameRestriction	The resource name parameter 'virtualNetworkGatewayName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/stable/2023-02-01/virtualNetworkGateway.json#L372
`❌` ParametersInPost	gatewayVip is a query parameter. Post operation must not contain any query parameter other than api-version. Location: Microsoft.Network/stable/2023-02-01/virtualNetworkGateway.json#L379
`❌` LroLocationHeader	A 202 response should include an Location response header. Location: Microsoft.Network/stable/2023-02-01/virtualNetworkGateway.json#L409
`❌` LroErrorContent	Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.Network/stable/2023-02-01/virtualNetworkGateway.json#L421
`❌` ResourceNameRestriction	The resource name parameter 'virtualNetworkGatewayName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/stable/2023-02-01/virtualNetworkGateway.json#L436
`❌` LroPostReturn	200 response for a LRO POST operation must have a response schema specified. Location: Microsoft.Network/stable/2023-02-01/virtualNetworkGateway.json#L437
`❌` LroLocationHeader	A 202 response should include an Location response header. Location: Microsoft.Network/stable/2023-02-01/virtualNetworkGateway.json#L469
`❌` LroErrorContent	Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.Network/stable/2023-02-01/virtualNetworkGateway.json#L475
`❌` ResourceNameRestriction	The resource name parameter 'virtualNetworkGatewayName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/stable/2023-02-01/virtualNetworkGateway.json#L490
`❌` LroLocationHeader	A 202 response should include an Location response header. Location: Microsoft.Network/stable/2023-02-01/virtualNetworkGateway.json#L535
`❌` LroErrorContent	Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.Network/stable/2023-02-01/virtualNetworkGateway.json#L541
`❌` ResourceNameRestriction	The resource name parameter 'virtualNetworkGatewayName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/stable/2023-02-01/virtualNetworkGateway.json#L556
`❌` LroLocationHeader	A 202 response should include an Location response header. Location: Microsoft.Network/stable/2023-02-01/virtualNetworkGateway.json#L601
`❌` LroErrorContent	Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.Network/stable/2023-02-01/virtualNetworkGateway.json#L607
`❌` ResourceNameRestriction	The resource name parameter 'virtualNetworkGatewayName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/stable/2023-02-01/virtualNetworkGateway.json#L622
`❌` LroLocationHeader	A 202 response should include an Location response header. Location: Microsoft.Network/stable/2023-02-01/virtualNetworkGateway.json#L658
`❌` LroErrorContent	Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.Network/stable/2023-02-01/virtualNetworkGateway.json#L664
`❌` ResourceNameRestriction	The resource name parameter 'virtualNetworkGatewayName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/stable/2023-02-01/virtualNetworkGateway.json#L679
`❌` ParametersInPost	peer is a query parameter. Post operation must not contain any query parameter other than api-version. Location: Microsoft.Network/stable/2023-02-01/virtualNetworkGateway.json#L686
`❌` LroLocationHeader	A 202 response should include an Location response header. Location: Microsoft.Network/stable/2023-02-01/virtualNetworkGateway.json#L722
`❌` LroErrorContent	Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.Network/stable/2023-02-01/virtualNetworkGateway.json#L728
`❌` ResourceNameRestriction	The resource name parameter 'virtualNetworkGatewayName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/stable/2023-02-01/virtualNetworkGateway.json#L743
`❌` ResourceNameRestriction	The resource name parameter 'virtualNetworkGatewayName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/stable/2023-02-01/virtualNetworkGateway.json#L793

️️✔️Avocado succeeded [Detail] [Expand]

Validation passes for Avocado.

️❌SwaggerAPIView: 0 Errors, 0 Warnings failed [Detail]

️️✔️CadlAPIView succeeded [Detail] [Expand]

️️✔️TypeSpecAPIView succeeded [Detail] [Expand]

️️✔️ModelValidation succeeded [Detail] [Expand]

Validation passes for ModelValidation.

️️✔️SemanticValidation succeeded [Detail] [Expand]

Validation passes for SemanticValidation.

️️✔️PrettierCheck succeeded [Detail] [Expand]

Validation passes for PrettierCheck.

️️✔️SpellCheck succeeded [Detail] [Expand]

Validation passes for SpellCheck.

️️✔️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 · 2023-05-13T01:08:45Z