Swagger changes for Vwan Express Route Gateway Failover and Insights

[shubhika1795]

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.

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.
• A release plan has been created. If not, please create one as it will help guide you through the REST API and SDK creation process.

Additional information

These changes were already merged in previously shared release branch #39841
And #40797

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.
• For guidance on SDK breaking change review, refer to https://aka.ms/ci-fix.

[github-actions]

Next Steps to Merge

Next steps that must be taken to merge this PR:

• ❌ 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
  
• ❌ The required check named TypeSpec Validation has failed. Refer to the check in the PR's 'Checks' tab for details on how to fix it and consult the aka.ms/ci-fix guide

Important checks have failed. As of today they are not blocking this PR, but in near future they may.
Addressing the following failures is highly recommended:

• ⚠️ The check named SDK Validation Status has failed. Refer to the check in the PR's 'Checks' tab for details on how to fix it and consult the aka.ms/ci-fix guide

Comment generated by summarize-checks workflow run.

[ravimeda]

ARM API Review: Microsoft.Network / virtualWan / 2025-07-01 -- VWAN ExpressRoute Gateway Failover and Insights

Previous version: Same 2025-07-01 version on release-microsoft-network-2025-07-01 branch (additive changes only)

Blocking Issues (on virtualWan.json -- diff too large for inline comments)

1. [NEW] 🔴 Blocking -- Incorrect $ref paths in all 6 new POST operations

All 6 new operations (getFailoverAllTestsDetails, getFailoverSingleTestDetails, startSiteFailoverTest, stopSiteFailoverTest, getResiliencyInformation, getRoutesInformation) use ../../../../../../../common-types/resource-management/v5/types.json (7 levels of ../) for $ref paths. The correct depth for this file is ../../../../../../common-types/... (6 levels), which all existing operations use. The extra ../ will break $ref resolution.

Fix: Change all $ref paths in the 6 new operations from 7 ../ to 6 ../.

2. [NEW] 🔴 Blocking -- Wrong 202 response description in all 6 new POST operations

The 202 response description in all 6 new operations says "Resource deletion accepted." These are not delete operations -- they are failover test and resiliency retrieval actions. This is a copy-paste error.

Fix: Change to "Request accepted for processing." in all 6 operations.

3. [NEW] 🔴 Blocking -- Timestamp properties missing format: date-time in schema definitions

Properties startTime, endTime, lastUpdatedTime, lastComputedTime, nextEligibleComputeTime in the new model definitions are plain "type": "string" without "format": "date-time". Temporal properties MUST specify the date-time format for correct SDK generation. (See inline comments on example files for the corresponding non-ISO 8601 example values.)

Fix: Add "format": "date-time" to all temporal string properties.

Warnings (on virtualWan.json)

4. [NEW] 🟡 Warning -- Numeric scores typed as strings

In VwanExpressRouteGatewayResiliencyInformation, overallScore, scoreChange, minScoreFromRecommendations, maxScoreFromRecommendations and similar properties are string but represent numeric values (examples: "20", "0", "-"). Consider using integer type with nullable support instead of strings.

Summary

• Files reviewed: 9
• New blocking issues: 3 (incorrect $ref paths, wrong 202 descriptions, missing date-time format)
• New warnings: 2 (suppression scope, numeric-as-string types)
• See inline comments on example files and readme.md for additional details.

Please address the blocking issues before merge.

[ravimeda]

[NEW] 🔴 Blocking [EX-FORMAT / Section 6 - Types & Formats]

Issue: Timestamps in this example use non-ISO 8601 format: "2/11/2026 7:37:04 AM" (line 28), "2/11/2026 8:41:50 AM" (line 29), "2/11/2026 8:41:49 AM" (line 35). Azure guidelines require date/time values to use ISO 8601/RFC 3339 format.

Additionally, in the schema definitions in virtualWan.json, the startTime, endTime, and lastUpdatedTime properties are typed as plain "type": "string" without "format": "date-time". Temporal properties MUST use "format": "date-time" to enable correct SDK type generation.

Fix for examples: Use ISO 8601 format consistently:

"startTime": "2026-02-11T07:37:04Z",
"endTime": "2026-02-11T08:41:50Z",
"lastUpdatedTime": "2026-02-11T08:41:49Z"

Fix for schema: Add "format": "date-time" to startTime, endTime, lastUpdatedTime, lastComputedTime, and nextEligibleComputeTime in all VwanExpressRouteGatewayFailoverTestDetails, VwanExpressRouteGatewayFailoverSingleTestDetails, VwanExpressRouteFailoverConnectionResourceDetails, and VwanExpressRouteGatewayResiliencyInformation definitions.

[ravimeda]

[NEW] 🔴 Blocking [EX-FORMAT]

Issue: Same timestamp format issue: "2/11/2026 8:44:21 AM UTC" (line 21) and "2/11/2026 9:44:21 AM UTC" (line 22). These MUST use ISO 8601/RFC 3339 format.

Fix:

"lastComputedTime": "2026-02-11T08:44:21Z",
"nextEligibleComputeTime": "2026-02-11T09:44:21Z"

[ravimeda]

[NEW] 🔴 Blocking [EX-FORMAT]

Issue: Same non-ISO 8601 timestamp format: "2/11/2026 8:44:21 AM UTC" and "2/11/2026 9:44:21 AM UTC" at lines 17-18.

Fix: Use "2026-02-11T08:44:21Z" and "2026-02-11T09:44:21Z"

[ravimeda]

[NEW] 🟡 Warning [RPC-SUPPRESS-SCOPE]

Issue: Both new suppressions lack where clauses. Blanket suppressions on the entire virtualWan.json file will mask future violations introduced in other definitions. The suppression should be scoped to the specific JSON paths where additionalProperties is used.

Fix: Add where clauses to scope the suppressions:

  - suppress: AvoidAdditionalProperties
    from: virtualWan.json
    where:
      - $.definitions.VwanExpressRouteGatewayRouteSetsInformation.properties.circuitsMetadataMap
      - $.definitions.VwanExpressRouteGatewayRouteSet.properties.details
    reason: Dictionaries used by Gateway Resiliency route set APIs.
  - suppress: ParametersInPost
    from: virtualWan.json
    where:
      - $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteGateways/{expressRouteGatewayName}/getFailoverAllTestsDetails'].post
      - $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteGateways/{expressRouteGatewayName}/getFailoverSingleTestDetails'].post
      - $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteGateways/{expressRouteGatewayName}/startSiteFailoverTest'].post
      - $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteGateways/{expressRouteGatewayName}/stopSiteFailoverTest'].post
      - $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteGateways/{expressRouteGatewayName}/getResiliencyInformation'].post
      - $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteGateways/{expressRouteGatewayName}/getRoutesInformation'].post
    reason: New Express Route Gateway failover and resiliency POST operations use query parameters following existing NRP patterns.

[mentat9]

@Shubhika-1795 - Please address the Swagger Avocado failure before ARM review.

[github-actions]

API Change Check

APIView identified API level changes in this PR and created the following API reviews

Language	API Review for Package
Go	sdk/resourcemanager/network/armnetwork
Java	com.azure.resourcemanager:azure-resourcemanager-network
JavaScript	@azure/arm-network

[shubhika1795]

@Shubhika-1795 - Please address the Swagger Avocado failure before ARM review.
For Avocado failure, please use this release PR as reference to provide suppression
#41904

[psah434]

There are bunch of unresolved comments from previous reviewers. Please address them and mention individually if they are resolved and how. Also the pr that is linked for suppression, it had avocado checks failing but here the sdk validation is failing. Please address it

[microsoft-github-policy-service]

@shubhika1795 please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

• (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.

@microsoft-github-policy-service agree

• (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.

@microsoft-github-policy-service agree company="Microsoft"

Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”),
and conveys certain license rights to Microsoft Corporation and its affiliates (“Microsoft”) for Your
contributions to Microsoft open source projects. This Agreement is effective as of the latest signature
date below.

1. Definitions.
   “Code” means the computer software code, whether in human-readable or machine-executable form,
   that is delivered by You to Microsoft under this Agreement.
   “Project” means any of the projects owned or managed by Microsoft and offered under a license
   approved by the Open Source Initiative (www.opensource.org).
   “Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any
   Project, including but not limited to communication on electronic mailing lists, source code control
   systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of
   discussing and improving that Project, but excluding communication that is conspicuously marked or
   otherwise designated in writing by You as “Not a Submission.”
   “Submission” means the Code and any other copyrightable material Submitted by You, including any
   associated comments and documentation.
2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any
   Project. This Agreement covers any and all Submissions that You, now or in the future (except as
   described in Section 4 below), Submit to any Project.
3. Originality of Work. You represent that each of Your Submissions is entirely Your original work.
   Should You wish to Submit materials that are not Your original work, You may Submit them separately
   to the Project if You (a) retain all copyright and license information that was in the materials as You
   received them, (b) in the description accompanying Your Submission, include the phrase “Submission
   containing materials of a third party:” followed by the names of the third party and any licenses or other
   restrictions of which You are aware, and (c) follow any other instructions in the Project’s written
   guidelines concerning Submissions.
4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else
   for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your
   Submission is made in the course of Your work for an employer or Your employer has intellectual
   property rights in Your Submission by contract or applicable law, You must secure permission from Your
   employer to make the Submission before signing this Agreement. In that case, the term “You” in this
   Agreement will refer to You and the employer collectively. If You change employers in the future and
   desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement
   and secure permission from the new employer before Submitting those Submissions.
5. Licenses.

• Copyright License. You grant Microsoft, and those who receive the Submission directly or
  indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the
  Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute
  the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third
  parties.
• Patent License. You grant Microsoft, and those who receive the Submission directly or
  indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under
  Your patent claims that are necessarily infringed by the Submission or the combination of the
  Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and
  import or otherwise dispose of the Submission alone or with the Project.
• Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement.
  No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are
  granted by implication, exhaustion, estoppel or otherwise.

6. Representations and Warranties. You represent that You are legally entitled to grant the above
   licenses. You represent that each of Your Submissions is entirely Your original work (except as You may
   have disclosed under Section 3). You represent that You have secured permission from Your employer to
   make the Submission in cases where Your Submission is made in the course of Your work for Your
   employer or Your employer has intellectual property rights in Your Submission by contract or applicable
   law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You
   have the necessary authority to bind the listed employer to the obligations contained in this Agreement.
   You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS
   REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES
   EXPRESSLY STATED IN SECTIONS 3, 4, AND 6, THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS
   PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF
   NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
7. Notice to Microsoft. You agree to notify Microsoft in writing of any facts or circumstances of which
   You later become aware that would make Your representations in this Agreement inaccurate in any
   respect.
8. Information about Submissions. You agree that contributions to Projects and information about
   contributions may be maintained indefinitely and disclosed publicly, including Your name and other
   information that You submit with Your Submission.
9. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and
   the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County,
   Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to
   exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all
   defenses of lack of personal jurisdiction and forum non-conveniens.
10. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and
    supersedes any and all prior agreements, understandings or communications, written or oral, between
    the parties relating to the subject matter hereof. This Agreement may be assigned by Microsoft.