Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _network express-route gateway get-failover-all-tests-detail_

This operation retrieves the details of all the failover tests performed on the Virtual Wan ExpressRoute gateways for different peering locations

## Versions

### [2025-07-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5uZXR3b3JrL2V4cHJlc3Nyb3V0ZWdhdGV3YXlzL3t9L2dldGZhaWxvdmVyYWxsdGVzdHNkZXRhaWxz/2025-07-01.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.network/expressroutegateways/{}/getfailoveralltestsdetails 2025-07-01 -->

#### examples

- VwanExpressRouteGatewayFailoverAllTestsDetails
```bash
network express-route gateway get-failover-all-tests-detail --resource-group "rg1" --name "ergw1" --type "SingleSiteFailover" --fetch-latest True
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _network express-route gateway get-failover-single-test-detail_

This operation retrieves the details of a particular failover test performed on the vwan expressRouteGateway based on the test Guid

## Versions

### [2025-07-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5uZXR3b3JrL2V4cHJlc3Nyb3V0ZWdhdGV3YXlzL3t9L2dldGZhaWxvdmVyc2luZ2xldGVzdGRldGFpbHM=/2025-07-01.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.network/expressroutegateways/{}/getfailoversingletestdetails 2025-07-01 -->

#### examples

- VwanExpressRouteGatewayFailoverSingleTestDetails
```bash
network express-route gateway get-failover-single-test-detail --resource-group "rg1" --name "ergw" --peering-location "Vancouver" --failover-test-id "fe458ae8-d2ae-4520-a104-44bc233bde7e"
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _network express-route gateway get-resiliency-information_

This operation retrieves the resiliency information for VWAN ExpressRoute Gateway, including the gateway's current resiliency score and recommendations to further improve the score

## Versions

### [2025-07-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5uZXR3b3JrL2V4cHJlc3Nyb3V0ZWdhdGV3YXlzL3t9L2dldHJlc2lsaWVuY3lpbmZvcm1hdGlvbg==/2025-07-01.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.network/expressroutegateways/{}/getresiliencyinformation 2025-07-01 -->

#### examples

- VwanExpressRouteGatewayGetResiliencyInformation
```bash
network express-route gateway get-resiliency-information --resource-group "rg1" --name "ergw" --attempt-refresh True
```
16 changes: 16 additions & 0 deletions Commands/network/express-route/gateway/_get-routes-information.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _network express-route gateway get-routes-information_

This operation retrieves the route set information for Vwan Express Route Gateway based on their resiliency

## Versions

### [2025-07-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5uZXR3b3JrL2V4cHJlc3Nyb3V0ZWdhdGV3YXlzL3t9L2dldHJvdXRlc2luZm9ybWF0aW9u/2025-07-01.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.network/expressroutegateways/{}/getroutesinformation 2025-07-01 -->

#### examples

- VwanExpressRouteGatewayGetRoutesInformation
```bash
network express-route gateway get-routes-information --resource-group "rg1" --name "ergw" --attempt-refresh False
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _network express-route gateway start-site-failover-test_

This operation starts failover simulation on the vwan expressRouteGateway for the specified peering location

## Versions

### [2025-07-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5uZXR3b3JrL2V4cHJlc3Nyb3V0ZWdhdGV3YXlzL3t9L3N0YXJ0c2l0ZWZhaWxvdmVydGVzdA==/2025-07-01.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.network/expressroutegateways/{}/startsitefailovertest 2025-07-01 -->

#### examples

- VwanExpressRouteGatewayStartSiteFailoverSimulation
```bash
network express-route gateway start-site-failover-test --resource-group "rg1" --name "ergw" --peering-location "Vancouver"
```
16 changes: 16 additions & 0 deletions Commands/network/express-route/gateway/_stop-site-failover-test.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _network express-route gateway stop-site-failover-test_

This operation stops an ongoing failover simulation on the vwan expressRouteGateway for the specified peering location

## Versions

### [2025-07-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5uZXR3b3JrL2V4cHJlc3Nyb3V0ZWdhdGV3YXlzL3t9L3N0b3BzaXRlZmFpbG92ZXJ0ZXN0/2025-07-01.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.network/expressroutegateways/{}/stopsitefailovertest 2025-07-01 -->

#### examples

- VwanExpressRouteGatewayStopSiteFailoverSimulation
```bash
network express-route gateway stop-site-failover-test --resource-group "rg1" --name "ergw" --peering-location "Vancouver" --simulation-successful True --details "[{failover-connection-name:'conn1',failover-location:'Denver',is-verified:False},{failover-connection-name:'conn2',failover-location:'Amsterdam',is-verified:True}]"
```
18 changes: 18 additions & 0 deletions Commands/network/express-route/gateway/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,3 +23,21 @@ Manage ExpressRoute gateways.

- [update](/Commands/network/express-route/gateway/_update.md)
: Update settings of an ExpressRoute gateway.

- [get-failover-all-tests-detail](/Commands/network/express-route/gateway/_get-failover-all-tests-detail.md)
: This operation retrieves the details of all the failover tests performed on the Virtual Wan ExpressRoute gateways for different peering locations

- [get-failover-single-test-detail](/Commands/network/express-route/gateway/_get-failover-single-test-detail.md)
: This operation retrieves the details of a particular failover test performed on the vwan expressRouteGateway based on the test Guid

- [get-resiliency-information](/Commands/network/express-route/gateway/_get-resiliency-information.md)
: This operation retrieves the resiliency information for VWAN ExpressRoute Gateway, including the gateway's current resiliency score and recommendations to further improve the score

- [get-routes-information](/Commands/network/express-route/gateway/_get-routes-information.md)
: This operation retrieves the route set information for Vwan Express Route Gateway based on their resiliency

- [start-site-failover-test](/Commands/network/express-route/gateway/_start-site-failover-test.md)
: This operation starts failover simulation on the vwan expressRouteGateway for the specified peering location

- [stop-site-failover-test](/Commands/network/express-route/gateway/_stop-site-failover-test.md)
: This operation stops an ongoing failover simulation on the vwan expressRouteGateway for the specified peering location
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"plane": "mgmt-plane", "resources": [{"id": "/subscriptions/{}/resourcegroups/{}/providers/microsoft.network/expressroutegateways/{}/getfailoveralltestsdetails", "version": "2025-07-01", "swagger": "mgmt-plane/network/ResourceProviders/Microsoft.Network/Paths/L3N1YnNjcmlwdGlvbnMve3N1YnNjcmlwdGlvbklkfS9yZXNvdXJjZUdyb3Vwcy97cmVzb3VyY2VHcm91cE5hbWV9L3Byb3ZpZGVycy9NaWNyb3NvZnQuTmV0d29yay9leHByZXNzUm91dGVHYXRld2F5cy97ZXhwcmVzc1JvdXRlR2F0ZXdheU5hbWV9L2dldEZhaWxvdmVyQWxsVGVzdHNEZXRhaWxz/V/MjAyNS0wNy0wMQ=="}], "commandGroups": [{"name": "network express-route gateway", "commands": [{"name": "get-failover-all-tests-detail", "version": "2025-07-01", "resources": [{"id": "/subscriptions/{}/resourcegroups/{}/providers/microsoft.network/expressroutegateways/{}/getfailoveralltestsdetails", "version": "2025-07-01", "swagger": "mgmt-plane/network/ResourceProviders/Microsoft.Network/Paths/L3N1YnNjcmlwdGlvbnMve3N1YnNjcmlwdGlvbklkfS9yZXNvdXJjZUdyb3Vwcy97cmVzb3VyY2VHcm91cE5hbWV9L3Byb3ZpZGVycy9NaWNyb3NvZnQuTmV0d29yay9leHByZXNzUm91dGVHYXRld2F5cy97ZXhwcmVzc1JvdXRlR2F0ZXdheU5hbWV9L2dldEZhaWxvdmVyQWxsVGVzdHNEZXRhaWxz/V/MjAyNS0wNy0wMQ=="}], "argGroups": [{"name": "", "args": [{"type": "string", "var": "$Path.expressRouteGatewayName", "options": ["name"], "required": true, "group": "", "idPart": "name", "help": {"short": "The name of the vwan express route gateway."}, "format": {"pattern": "^[A-Za-z0-9_-]+"}}, {"type": "ResourceGroupName", "var": "$Path.resourceGroupName", "options": ["g", "resource-group"], "required": true, "idPart": "resource_group"}, {"type": "SubscriptionId", "var": "$Path.subscriptionId", "options": ["subscription"], "required": true, "idPart": "subscription"}, {"type": "boolean", "var": "$Query.fetchLatest", "options": ["fetch-latest"], "required": true, "help": {"short": "Fetch only the latest tests for each peering location"}}, {"type": "string", "var": "$Query.type", "options": ["type"], "required": true, "help": {"short": "The type of failover test"}, "enum": {"items": [{"name": "All", "value": "All"}, {"name": "LinkFailover", "value": "LinkFailover"}, {"name": "MultiSiteFailover", "value": "MultiSiteFailover"}, {"name": "SingleSiteFailover", "value": "SingleSiteFailover"}]}}]}], "operations": [{"longRunning": {"finalStateVia": "location"}, "operationId": "ExpressRouteGateways_GetFailoverAllTestsDetails", "http": {"path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteGateways/{expressRouteGatewayName}/getFailoverAllTestsDetails", "request": {"method": "post", "path": {"params": [{"type": "string", "name": "expressRouteGatewayName", "arg": "$Path.expressRouteGatewayName", "required": true, "format": {"pattern": "^[A-Za-z0-9_-]+"}}, {"type": "string", "name": "resourceGroupName", "arg": "$Path.resourceGroupName", "required": true, "format": {"maxLength": 90, "minLength": 1}}, {"type": "uuid", "name": "subscriptionId", "arg": "$Path.subscriptionId", "required": true}]}, "query": {"params": [{"type": "boolean", "name": "fetchLatest", "arg": "$Query.fetchLatest", "required": true}, {"type": "string", "name": "type", "arg": "$Query.type", "required": true, "enum": {"items": [{"value": "All"}, {"value": "LinkFailover"}, {"value": "MultiSiteFailover"}, {"value": "SingleSiteFailover"}]}}], "consts": [{"readOnly": true, "const": true, "default": {"value": "2025-07-01"}, "type": "string", "name": "api-version", "required": true, "format": {"minLength": 1}}]}}, "responses": [{"statusCode": [200], "body": {"json": {"var": "$Instance", "schema": {"type": "object", "props": [{"type": "array<object>", "name": "value", "item": {"type": "object", "props": [{"readOnly": true, "type": "array<object>", "name": "circuits", "item": {"type": "object", "props": [{"type": "string", "name": "connectionName"}, {"type": "string", "name": "name"}, {"type": "ResourceId", "name": "nrpResourceUri"}]}}, {"readOnly": true, "type": "array<object>", "name": "connections", "item": {"type": "object", "props": [{"readOnly": true, "type": "string", "name": "lastUpdatedTime"}, {"type": "string", "name": "name"}, {"type": "ResourceId", "name": "nrpResourceUri"}, {"type": "string", "name": "status", "enum": {"items": [{"value": "Connected"}, {"value": "Disconnected"}]}}]}}, {"readOnly": true, "type": "string", "name": "endTime"}, {"readOnly": true, "type": "array<string>", "name": "issues", "item": {"type": "string"}}, {"readOnly": true, "type": "string", "name": "peeringLocation"}, {"readOnly": true, "type": "string", "name": "startTime"}, {"readOnly": true, "type": "string", "name": "status", "enum": {"items": [{"value": "Completed"}, {"value": "Expired"}, {"value": "Invalid"}, {"value": "NotStarted"}, {"value": "Running"}, {"value": "StartFailed"}, {"value": "Starting"}, {"value": "StopFailed"}, {"value": "Stopping"}]}}, {"readOnly": true, "type": "string", "name": "testGuid"}, {"readOnly": true, "type": "string", "name": "testType", "enum": {"items": [{"value": "All"}, {"value": "LinkFailover"}, {"value": "MultiSiteFailover"}, {"value": "SingleSiteFailover"}]}}]}}]}}}}, {"statusCode": [202], "header": {"items": [{"name": "Location"}, {"name": "Retry-After"}]}}, {"isError": true, "body": {"json": {"schema": {"type": "@ODataV4Format"}}}}]}}], "outputs": [{"type": "object", "ref": "$Instance", "clientFlatten": true}]}]}]}
Original file line number Diff line number Diff line change
@@ -0,0 +1,134 @@
<?xml version='1.0' encoding='utf-8'?>
<CodeGen plane="mgmt-plane">
<resource id="/subscriptions/{}/resourcegroups/{}/providers/microsoft.network/expressroutegateways/{}/getfailoveralltestsdetails" version="2025-07-01" swagger="mgmt-plane/network/ResourceProviders/Microsoft.Network/Paths/L3N1YnNjcmlwdGlvbnMve3N1YnNjcmlwdGlvbklkfS9yZXNvdXJjZUdyb3Vwcy97cmVzb3VyY2VHcm91cE5hbWV9L3Byb3ZpZGVycy9NaWNyb3NvZnQuTmV0d29yay9leHByZXNzUm91dGVHYXRld2F5cy97ZXhwcmVzc1JvdXRlR2F0ZXdheU5hbWV9L2dldEZhaWxvdmVyQWxsVGVzdHNEZXRhaWxz/V/MjAyNS0wNy0wMQ=="/>
<commandGroup name="network express-route gateway">
<command name="get-failover-all-tests-detail" version="2025-07-01">
<resource id="/subscriptions/{}/resourcegroups/{}/providers/microsoft.network/expressroutegateways/{}/getfailoveralltestsdetails" version="2025-07-01" swagger="mgmt-plane/network/ResourceProviders/Microsoft.Network/Paths/L3N1YnNjcmlwdGlvbnMve3N1YnNjcmlwdGlvbklkfS9yZXNvdXJjZUdyb3Vwcy97cmVzb3VyY2VHcm91cE5hbWV9L3Byb3ZpZGVycy9NaWNyb3NvZnQuTmV0d29yay9leHByZXNzUm91dGVHYXRld2F5cy97ZXhwcmVzc1JvdXRlR2F0ZXdheU5hbWV9L2dldEZhaWxvdmVyQWxsVGVzdHNEZXRhaWxz/V/MjAyNS0wNy0wMQ=="/>
<argGroup name="">
<arg type="string" var="$Path.expressRouteGatewayName" options="name" required="True" group="" idPart="name">
<help short="The name of the vwan express route gateway."/>
<format pattern="^[A-Za-z0-9_-]+"/>
</arg>
<arg type="ResourceGroupName" var="$Path.resourceGroupName" options="resource-group g" required="True" idPart="resource_group"/>
<arg type="SubscriptionId" var="$Path.subscriptionId" options="subscription" required="True" idPart="subscription"/>
<arg type="boolean" var="$Query.fetchLatest" options="fetch-latest" required="True">
<help short="Fetch only the latest tests for each peering location"/>
</arg>
<arg type="string" var="$Query.type" options="type" required="True">
<help short="The type of failover test"/>
<enum>
<item name="All" value="&quot;All&quot;"/>
<item name="LinkFailover" value="&quot;LinkFailover&quot;"/>
<item name="MultiSiteFailover" value="&quot;MultiSiteFailover&quot;"/>
<item name="SingleSiteFailover" value="&quot;SingleSiteFailover&quot;"/>
</enum>
</arg>
</argGroup>
<operation operationId="ExpressRouteGateways_GetFailoverAllTestsDetails">
<longRunning finalStateVia="location"/>
<http path="/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteGateways/{expressRouteGatewayName}/getFailoverAllTestsDetails">
<request method="post">
<path>
<param type="string" name="expressRouteGatewayName" arg="$Path.expressRouteGatewayName" required="True">
<format pattern="^[A-Za-z0-9_-]+"/>
</param>
<param type="string" name="resourceGroupName" arg="$Path.resourceGroupName" required="True">
<format maxLength="90" minLength="1"/>
</param>
<param type="uuid" name="subscriptionId" arg="$Path.subscriptionId" required="True"/>
</path>
<query>
<param type="boolean" name="fetchLatest" arg="$Query.fetchLatest" required="True"/>
<param type="string" name="type" arg="$Query.type" required="True">
<enum>
<item value="&quot;All&quot;"/>
<item value="&quot;LinkFailover&quot;"/>
<item value="&quot;MultiSiteFailover&quot;"/>
<item value="&quot;SingleSiteFailover&quot;"/>
</enum>
</param>
<const readOnly="True" const="True" type="string" name="api-version" required="True">
<default value="&quot;2025-07-01&quot;"/>
<format minLength="1"/>
</const>
</query>
</request>
<response statusCode="200">
<body>
<json var="$Instance">
<schema type="object">
<prop type="array<object>" name="value">
<item type="object">
<prop readOnly="True" type="array<object>" name="circuits">
<item type="object">
<prop type="string" name="connectionName"/>
<prop type="string" name="name"/>
<prop type="ResourceId" name="nrpResourceUri"/>
</item>
</prop>
<prop readOnly="True" type="array<object>" name="connections">
<item type="object">
<prop readOnly="True" type="string" name="lastUpdatedTime"/>
<prop type="string" name="name"/>
<prop type="ResourceId" name="nrpResourceUri"/>
<prop type="string" name="status">
<enum>
<item value="&quot;Connected&quot;"/>
<item value="&quot;Disconnected&quot;"/>
</enum>
</prop>
</item>
</prop>
<prop readOnly="True" type="string" name="endTime"/>
<prop readOnly="True" type="array<string>" name="issues">
<item type="string"/>
</prop>
<prop readOnly="True" type="string" name="peeringLocation"/>
<prop readOnly="True" type="string" name="startTime"/>
<prop readOnly="True" type="string" name="status">
<enum>
<item value="&quot;Completed&quot;"/>
<item value="&quot;Expired&quot;"/>
<item value="&quot;Invalid&quot;"/>
<item value="&quot;NotStarted&quot;"/>
<item value="&quot;Running&quot;"/>
<item value="&quot;StartFailed&quot;"/>
<item value="&quot;Starting&quot;"/>
<item value="&quot;StopFailed&quot;"/>
<item value="&quot;Stopping&quot;"/>
</enum>
</prop>
<prop readOnly="True" type="string" name="testGuid"/>
<prop readOnly="True" type="string" name="testType">
<enum>
<item value="&quot;All&quot;"/>
<item value="&quot;LinkFailover&quot;"/>
<item value="&quot;MultiSiteFailover&quot;"/>
<item value="&quot;SingleSiteFailover&quot;"/>
</enum>
</prop>
</item>
</prop>
</schema>
</json>
</body>
</response>
<response statusCode="202">
<header>
<item name="Location"/>
<item name="Retry-After"/>
</header>
</response>
<response isError="True">
<body>
<json>
<schema type="@ODataV4Format"/>
</json>
</body>
</response>
</http>
</operation>
<output type="object" ref="$Instance" clientFlatten="True"/>
</command>
</commandGroup>
</CodeGen>
Loading
Loading