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-circuit get-circuit-link-failover-all-tests-detail_

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

## Versions

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

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

#### examples

- ExpressRouteCircuitLinkFailoverAllTestsDetails
```bash
network express-route-circuit get-circuit-link-failover-all-tests-detail --resource-group rg1 --express-route-circuit-name erckt --failover-test-type LinkFailover --fetch-latest True
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _network express-route-circuit get-circuit-link-failover-single-test-detail_

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

## Versions

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

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

#### examples

- ExpressRouteCircuitLinkFailoverSingleTestDetails
```bash
network express-route-circuit get-circuit-link-failover-single-test-detail --resource-group rg1 --express-route-circuit-name erckt --failover-test-id fe458ae8-d2ae-4520-a104-44bc233bde7e --link-type Primary --circuit-maintenance-category BgpDisconnect
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _network express-route-circuit start-circuit-link-failover-test_

This operation starts failover simulation on the circuit for the specified link type

## Versions

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

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

#### examples

- ExpressRouteCircuitStartLinkFailoverSimulation
```bash
network express-route-circuit start-circuit-link-failover-test --resource-group rg1 --express-route-circuit-name erckt --link-type Primary --circuit-maintenance-category BgpDisconnect
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _network express-route-circuit stop-circuit-link-failover-test_

This operation stops an ongoing failover simulation on the circuit for the specified link type

## Versions

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

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

#### examples

- ExpressRouteCircuitStopLinkFailoverSimulation
```bash
network express-route-circuit stop-circuit-link-failover-test --resource-group rg1 --express-route-circuit-name erckt --circuit-test-category BgpDisconnect --link-type Primary --was-simulation-successful True --is-verified True
```
17 changes: 17 additions & 0 deletions Commands/network/express-route-circuit/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# [Group] _network express-route-circuit_

Manage Express Route Circuit

## Commands

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

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

- [start-circuit-link-failover-test](/Commands/network/express-route-circuit/_start-circuit-link-failover-test.md)
: This operation starts failover simulation on the circuit for the specified link type

- [stop-circuit-link-failover-test](/Commands/network/express-route-circuit/_stop-circuit-link-failover-test.md)
: This operation stops an ongoing failover simulation on the circuit for the specified link type
3 changes: 3 additions & 0 deletions Commands/network/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,9 @@ Manage Azure Network resources.
- [express-route](/Commands/network/express-route/readme.md)
: Manage dedicated private network fiber connections to Azure.

- [express-route-circuit](/Commands/network/express-route-circuit/readme.md)
: Manage Express Route Circuit

- [express-route-cross-connection](/Commands/network/express-route-cross-connection/readme.md)
: Manage express route cross connection

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"plane": "mgmt-plane", "resources": [{"id": "/subscriptions/{}/resourcegroups/{}/providers/microsoft.network/expressroutecircuits/{}/getcircuitlinkfailoveralltestsdetails", "version": "2025-07-01", "swagger": "mgmt-plane/network/ResourceProviders/Microsoft.Network/Paths/L3N1YnNjcmlwdGlvbnMve3N1YnNjcmlwdGlvbklkfS9yZXNvdXJjZUdyb3Vwcy97cmVzb3VyY2VHcm91cE5hbWV9L3Byb3ZpZGVycy9NaWNyb3NvZnQuTmV0d29yay9leHByZXNzUm91dGVDaXJjdWl0cy97ZXhwcmVzc1JvdXRlQ2lyY3VpdE5hbWV9L2dldENpcmN1aXRMaW5rRmFpbG92ZXJBbGxUZXN0c0RldGFpbHM=/V/MjAyNS0wNy0wMQ=="}], "commandGroups": [{"name": "network express-route-circuit", "commands": [{"name": "get-circuit-link-failover-all-tests-detail", "version": "2025-07-01", "resources": [{"id": "/subscriptions/{}/resourcegroups/{}/providers/microsoft.network/expressroutecircuits/{}/getcircuitlinkfailoveralltestsdetails", "version": "2025-07-01", "swagger": "mgmt-plane/network/ResourceProviders/Microsoft.Network/Paths/L3N1YnNjcmlwdGlvbnMve3N1YnNjcmlwdGlvbklkfS9yZXNvdXJjZUdyb3Vwcy97cmVzb3VyY2VHcm91cE5hbWV9L3Byb3ZpZGVycy9NaWNyb3NvZnQuTmV0d29yay9leHByZXNzUm91dGVDaXJjdWl0cy97ZXhwcmVzc1JvdXRlQ2lyY3VpdE5hbWV9L2dldENpcmN1aXRMaW5rRmFpbG92ZXJBbGxUZXN0c0RldGFpbHM=/V/MjAyNS0wNy0wMQ=="}], "argGroups": [{"name": "", "args": [{"type": "string", "var": "$Path.expressRouteCircuitName", "options": ["express-route-circuit-name"], "required": true, "idPart": "name", "help": {"short": "The name of the express route circuit."}, "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": "string", "var": "$Query.failoverTestType", "options": ["failover-test-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"}]}}, {"type": "boolean", "var": "$Query.fetchLatest", "options": ["fetch-latest"], "required": true, "help": {"short": "Fetch only the latest tests for each peering location"}}]}], "operations": [{"longRunning": {"finalStateVia": "location"}, "operationId": "ExpressRouteCircuits_GetCircuitLinkFailoverAllTestsDetails", "http": {"path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{expressRouteCircuitName}/getCircuitLinkFailoverAllTestsDetails", "request": {"method": "post", "path": {"params": [{"type": "string", "name": "expressRouteCircuitName", "arg": "$Path.expressRouteCircuitName", "required": true, "format": {"pattern": "^[A-Za-z0-9_]+"}}, {"type": "string", "name": "resourceGroupName", "arg": "$Path.resourceGroupName", "required": true}, {"type": "string", "name": "subscriptionId", "arg": "$Path.subscriptionId", "required": true}]}, "query": {"params": [{"type": "string", "name": "failoverTestType", "arg": "$Query.failoverTestType", "required": true, "enum": {"items": [{"value": "All"}, {"value": "LinkFailover"}, {"value": "MultiSiteFailover"}, {"value": "SingleSiteFailover"}]}}, {"type": "boolean", "name": "fetchLatest", "arg": "$Query.fetchLatest", "required": true}], "consts": [{"readOnly": true, "const": true, "default": {"value": "2025-07-01"}, "type": "string", "name": "api-version", "required": true}]}}, "responses": [{"statusCode": [200], "body": {"json": {"var": "$Instance", "schema": {"type": "array<object>", "item": {"type": "object", "props": [{"readOnly": true, "type": "array<object>", "name": "bgpStatus", "item": {"type": "object", "props": [{"readOnly": true, "type": "string", "name": "bgpStatusType", "enum": {"items": [{"value": "IPv4"}, {"value": "IPv6"}]}}, {"readOnly": true, "type": "string", "name": "checkTime"}, {"type": "string", "name": "link", "enum": {"items": [{"value": "Primary"}, {"value": "Secondary"}]}}, {"readOnly": true, "type": "string", "name": "status", "enum": {"items": [{"value": "Connected"}, {"value": "Disconnected"}, {"value": "Undefined"}]}}]}}, {"readOnly": true, "type": "string", "name": "circuitTestCategory", "enum": {"items": [{"value": "ASPathPrepend"}, {"value": "BgpDisconnect"}]}}, {"readOnly": true, "type": "string", "name": "endTime"}, {"readOnly": true, "type": "array<string>", "name": "issues", "item": {"type": "string"}}, {"readOnly": true, "type": "string", "name": "linkType", "enum": {"items": [{"value": "Primary"}, {"value": "Secondary"}]}}, {"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"}]}}, {"readOnly": true, "type": "boolean", "name": "wasSimulationSuccessful"}]}}}}}, {"statusCode": [202], "header": {"items": [{"name": "location"}]}}, {"isError": true, "body": {"json": {"schema": {"type": "@ODataV4Format"}}}}]}}], "outputs": [{"type": "array", "ref": "$Instance"}]}]}]}
Original file line number Diff line number Diff line change
@@ -0,0 +1,144 @@
<?xml version='1.0' encoding='utf-8'?>
<CodeGen plane="mgmt-plane">
<resource id="/subscriptions/{}/resourcegroups/{}/providers/microsoft.network/expressroutecircuits/{}/getcircuitlinkfailoveralltestsdetails" version="2025-07-01" swagger="mgmt-plane/network/ResourceProviders/Microsoft.Network/Paths/L3N1YnNjcmlwdGlvbnMve3N1YnNjcmlwdGlvbklkfS9yZXNvdXJjZUdyb3Vwcy97cmVzb3VyY2VHcm91cE5hbWV9L3Byb3ZpZGVycy9NaWNyb3NvZnQuTmV0d29yay9leHByZXNzUm91dGVDaXJjdWl0cy97ZXhwcmVzc1JvdXRlQ2lyY3VpdE5hbWV9L2dldENpcmN1aXRMaW5rRmFpbG92ZXJBbGxUZXN0c0RldGFpbHM=/V/MjAyNS0wNy0wMQ=="/>
<commandGroup name="network express-route-circuit">
<command name="get-circuit-link-failover-all-tests-detail" version="2025-07-01">
<resource id="/subscriptions/{}/resourcegroups/{}/providers/microsoft.network/expressroutecircuits/{}/getcircuitlinkfailoveralltestsdetails" version="2025-07-01" swagger="mgmt-plane/network/ResourceProviders/Microsoft.Network/Paths/L3N1YnNjcmlwdGlvbnMve3N1YnNjcmlwdGlvbklkfS9yZXNvdXJjZUdyb3Vwcy97cmVzb3VyY2VHcm91cE5hbWV9L3Byb3ZpZGVycy9NaWNyb3NvZnQuTmV0d29yay9leHByZXNzUm91dGVDaXJjdWl0cy97ZXhwcmVzc1JvdXRlQ2lyY3VpdE5hbWV9L2dldENpcmN1aXRMaW5rRmFpbG92ZXJBbGxUZXN0c0RldGFpbHM=/V/MjAyNS0wNy0wMQ=="/>
<argGroup name="">
<arg type="string" var="$Path.expressRouteCircuitName" options="express-route-circuit-name" required="True" idPart="name">
<help short="The name of the express route circuit."/>
<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="string" var="$Query.failoverTestType" options="failover-test-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>
<arg type="boolean" var="$Query.fetchLatest" options="fetch-latest" required="True">
<help short="Fetch only the latest tests for each peering location"/>
</arg>
</argGroup>
<operation operationId="ExpressRouteCircuits_GetCircuitLinkFailoverAllTestsDetails">
<longRunning finalStateVia="location"/>
<http path="/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{expressRouteCircuitName}/getCircuitLinkFailoverAllTestsDetails">
<request method="post">
<path>
<param type="string" name="expressRouteCircuitName" arg="$Path.expressRouteCircuitName" required="True">
<format pattern="^[A-Za-z0-9_]+"/>
</param>
<param type="string" name="resourceGroupName" arg="$Path.resourceGroupName" required="True"/>
<param type="string" name="subscriptionId" arg="$Path.subscriptionId" required="True"/>
</path>
<query>
<param type="string" name="failoverTestType" arg="$Query.failoverTestType" 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>
<param type="boolean" name="fetchLatest" arg="$Query.fetchLatest" required="True"/>
<const readOnly="True" const="True" type="string" name="api-version" required="True">
<default value="&quot;2025-07-01&quot;"/>
</const>
</query>
</request>
<response statusCode="200">
<body>
<json var="$Instance">
<schema type="array<object>">
<item type="object">
<prop readOnly="True" type="array<object>" name="bgpStatus">
<item type="object">
<prop readOnly="True" type="string" name="bgpStatusType">
<enum>
<item value="&quot;IPv4&quot;"/>
<item value="&quot;IPv6&quot;"/>
</enum>
</prop>
<prop readOnly="True" type="string" name="checkTime"/>
<prop type="string" name="link">
<enum>
<item value="&quot;Primary&quot;"/>
<item value="&quot;Secondary&quot;"/>
</enum>
</prop>
<prop readOnly="True" type="string" name="status">
<enum>
<item value="&quot;Connected&quot;"/>
<item value="&quot;Disconnected&quot;"/>
<item value="&quot;Undefined&quot;"/>
</enum>
</prop>
</item>
</prop>
<prop readOnly="True" type="string" name="circuitTestCategory">
<enum>
<item value="&quot;ASPathPrepend&quot;"/>
<item value="&quot;BgpDisconnect&quot;"/>
</enum>
</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="linkType">
<enum>
<item value="&quot;Primary&quot;"/>
<item value="&quot;Secondary&quot;"/>
</enum>
</prop>
<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>
<prop readOnly="True" type="boolean" name="wasSimulationSuccessful"/>
</item>
</schema>
</json>
</body>
</response>
<response statusCode="202">
<header>
<item name="location"/>
</header>
</response>
<response isError="True">
<body>
<json>
<schema type="@ODataV4Format"/>
</json>
</body>
</response>
</http>
</operation>
<output type="array" ref="$Instance"/>
</command>
</commandGroup>
</CodeGen>
Loading