Add AzureStack Hub Admin VPN API by iancaragol · Pull Request #17245 · Azure/azure-rest-api-specs

iancaragol · 2022-01-05T16:52:20Z

This is a new read-only API for Azure Stack Administrators. It lists all VPN resources that have been created on the stamp and enables the administrator to better manage their limited VPN capacity.

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

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.

Goal is to deploy the new api in the first Azure Stack release of next year. Probably towards late Jan/early Feb

When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.

late Jan/early Feb

If updating an existing version, please select the specific langauge SDKs and CLIs that must be refreshed after the swagger is published.
- SDK of .NET (need service team to ensure code readiness)
- SDK of Python
- SDK of Java
- SDK of Js
- SDK of Go
- PowerShell
- CLI
- Terraform
- No refresh required for updates in this PR

Contribution checklist:

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 label "WaitForARMFeedback" will be added automatically to begin ARM API Review. Failure to comply may result in delays to the manifest.
- Adding a new service
- Adding new API(s)
- Adding a new API version
  -[x] 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.
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 any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.

Removing API(s) in a stable version
Removing properties in a stable version
Removing API version(s) in a stable version
Updating API in a stable or public preview version with Breaking Change Validation errors
Updating API(s) in public preview over 1 year (refer to Retirement of Previews)

Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.

Please follow the link to find more details on PR review process.

openapi-workflow-bot · 2022-01-05T16:52:23Z

Hi, @iancaragol 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. vsswagger@microsoft.com

openapi-workflow-bot · 2022-01-05T16:52:24Z

[Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks.

openapi-pipeline-app · 2022-01-05T16:52:25Z

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]

There are no breaking changes.

️⚠️LintDiff: 2 Warnings warning [Detail]

Linted configuring files (Based on source branch, openapi-validator v1.10.1 , classic-openapi-validator v1.1.10 )
- resource-manager/network/readme.md tag:package-2022-02-01
Linted configuring files (Based on target branch, openapi-validator v1.10.1 , classic-openapi-validator v1.1.10 )
- resource-manager/network/readme.md tag:default

The following errors/warnings are introduced by current PR:

Rule	Message
⚠️ R2015 - ParameterNotDefinedInGlobalParameters	Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: azure-rest-api-specs/blob/9ada02cc3ac4bed2a8012be694eef5f56040624a/)#L1#L1)
⚠️ R4014 - AllResourcesMustHaveGetOperation	The resource 'VirtualNetworkGatewayConnection' does not have get operation, please add it. Location: Microsoft.Network.Admin/stable/2022-02-01/VirtualNetworkGatewayConnections.json#L77

The following errors/warnings exist before current PR submission:

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

Rule	Message
`❌` R4010 - RequiredDefaultResponse	The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.Network.Admin/preview/2015-06-15/Network.json#L39
`❌` R4010 - RequiredDefaultResponse	The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.Network.Admin/preview/2015-06-15/Network.json#L66
`❌` R4010 - RequiredDefaultResponse	The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.Network.Admin/preview/2015-06-15/Network.json#L96
`❌` R4010 - RequiredDefaultResponse	The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.Network.Admin/preview/2015-06-15/Network.json#L129
`❌` R4010 - RequiredDefaultResponse	The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.Network.Admin/preview/2015-06-15/Network.json#L162
`❌` R4010 - RequiredDefaultResponse	The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.Network.Admin/preview/2015-06-15/LoadBalancers.json#L54
`❌` R4010 - RequiredDefaultResponse	The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.Network.Admin/preview/2015-06-15/PublicIpAddresses.json#L54
`❌` R4010 - RequiredDefaultResponse	The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.Network.Admin/preview/2015-06-15/Quotas.json#L45
`❌` R4010 - RequiredDefaultResponse	The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.Network.Admin/preview/2015-06-15/Quotas.json#L85
`❌` R4010 - RequiredDefaultResponse	The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.Network.Admin/preview/2015-06-15/Quotas.json#L122
`❌` R4010 - RequiredDefaultResponse	The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.Network.Admin/preview/2015-06-15/Quotas.json#L162
`❌` R4010 - RequiredDefaultResponse	The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.Network.Admin/preview/2015-06-15/VirtualNetworks.json#L54
`❌` R4010 - RequiredDefaultResponse	The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.Network.Admin/preview/2015-06-15/Network.json#L39
`❌` R4010 - RequiredDefaultResponse	The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.Network.Admin/preview/2015-06-15/Network.json#L66
`❌` R4010 - RequiredDefaultResponse	The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.Network.Admin/preview/2015-06-15/Network.json#L96
`❌` R4010 - RequiredDefaultResponse	The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.Network.Admin/preview/2015-06-15/Network.json#L129
`❌` R4010 - RequiredDefaultResponse	The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.Network.Admin/preview/2015-06-15/Network.json#L162
`❌` R4010 - RequiredDefaultResponse	The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.Network.Admin/preview/2015-06-15/LoadBalancers.json#L54
`❌` R4010 - RequiredDefaultResponse	The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.Network.Admin/preview/2015-06-15/PublicIpAddresses.json#L54
`❌` R4010 - RequiredDefaultResponse	The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.Network.Admin/preview/2015-06-15/Quotas.json#L45
`❌` R4010 - RequiredDefaultResponse	The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.Network.Admin/preview/2015-06-15/Quotas.json#L85
`❌` R4010 - RequiredDefaultResponse	The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.Network.Admin/preview/2015-06-15/Quotas.json#L122
`❌` R4010 - RequiredDefaultResponse	The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.Network.Admin/preview/2015-06-15/Quotas.json#L162
`❌` R4010 - RequiredDefaultResponse	The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.Network.Admin/preview/2015-06-15/VirtualNetworks.json#L54
`❌` R4018 - OperationsApiResponseSchema	The response schema of operations API '/providers/Microsoft.Network.Admin/operations' does not match the ARM specification. Please standardize the schema. Location: Microsoft.Network.Admin/preview/2015-06-15/Network.json#L49
`❌` R4037 - MissingTypeObject	The schema 'Operation' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network.Admin/preview/2015-06-15/Network.json#L211
`❌` R4037 - MissingTypeObject	The schema 'Location' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network.Admin/preview/2015-06-15/Network.json#L226
`❌` R4037 - MissingTypeObject	The schema 'OperationResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network.Admin/preview/2015-06-15/Network.json#L236
`❌` R4037 - MissingTypeObject	The schema 'Display' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network.Admin/preview/2015-06-15/Network.json#L246
`❌` R4037 - MissingTypeObject	The schema 'LocationsList' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network.Admin/preview/2015-06-15/Network.json#L271

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

Validation passes for Avocado.

️️✔️~[Staging] ApiReadinessCheck succeeded [Detail] [Expand]

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

Validation passes for ModelValidation.

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

Validation passes for SemanticValidation.

️️✔️Cross-Version Breaking Changes succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️CredScan succeeded [Detail] [Expand]

There is no credential detected.

️️✔️SDK Track2 Validation succeeded [Detail] [Expand]

Validation passes for SDKTrack2Validation

The following tags are being changed in this PR

azsadmin/resource-manager/network/readme.md#package-2022-02-01

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

Validation passes for PrettierCheck.

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

Validation passes for SpellCheck.

️️✔️Lint(RPaaS) succeeded [Detail] [Expand]

Validation passes for Lint(RPaaS).

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-pipeline-app · 2022-01-05T16:52:26Z

Swagger pipeline restarted successfully, please wait for status update in this comment.

openapi-workflow-bot · 2022-01-05T16:52:26Z

Hi, @iancaragol your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com).

openapi-workflow-bot · 2022-01-05T16:55:10Z

Hi @iancaragol, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff. If you have any questions, please post your questions in this channel https://aka.ms/swaggersupport.

Task	How to fix	Priority
Avocado	Fix-Avocado	High
Semantic validation	Fix-SemanticValidation-Error	High
Model validation	Fix-ModelValidation-Error	High
LintDiff	Fix-LintDiff	high

If you need further help, please feedback via swagger feedback.

iancaragol · 2022-01-05T16:56:29Z

Overview & Documentation

This API + new UI will enable Azure Stack Administrators to see all VPN resources that have been created on the stamp. Using this information they will be able to:

Identify useless or disconnected VPN tunnels that are consuming capacity
Work with tenants to manage the stamp's VPN capacity
Work with CSS to more quickly and easily diagnose VPN issues

Targeting the first Azure Stack release of 2022

Example UI Mockups:

RamyasreeChakka

RamyasreeChakka · 2022-01-12T05:45:05Z

@iancaragol Signed off from ARM side.

* Add AzSAdmin VPN API * Addressed lint diff R4041 * Address prettier check * Addressed comments, changed ProvisioningState to enum

Add AzSAdmin VPN API

01314e2

openapi-workflow-bot Bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jan 5, 2022

openapi-pipeline-app Bot added the CI-FixRequiredOnFailure label Jan 5, 2022

Addressed lint diff R4041

05ba042

openapi-pipeline-app Bot removed the CI-FixRequiredOnFailure label Jan 5, 2022

Address prettier check

a724679

bganapa approved these changes Jan 5, 2022

View reviewed changes

bganapa changed the title ~~Add AzSAdmin VPN API~~ Add AzureStack Hub Admin VPN API Jan 5, 2022

RamyasreeChakka reviewed Jan 7, 2022

View reviewed changes