Skip to content
Merged
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
16 changes: 16 additions & 0 deletions Commands/network/vnet-gateway/_get-failover-all-tests-detail.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _network vnet-gateway get-failover-all-tests-detail_

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

## Versions

### [2024-05-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5uZXR3b3JrL3ZpcnR1YWxuZXR3b3JrZ2F0ZXdheXMve30vZ2V0ZmFpbG92ZXJhbGx0ZXN0c2RldGFpbHM=/2024-05-01.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.network/virtualnetworkgateways/{}/getfailoveralltestsdetails 2024-05-01 -->

#### examples

- VirtualNetworkGatewayGetFailoverAllTestsDetails
```bash
network vnet-gateway get-failover-all-tests-detail --resource-group rg1 --virtual-network-gateway-name ergw --type SingleSiteFailover --fetch-latest true
```
16 changes: 16 additions & 0 deletions Commands/network/vnet-gateway/_get-failover-single-test-detail.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _network vnet-gateway get-failover-single-test-detail_

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

## Versions

### [2024-05-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5uZXR3b3JrL3ZpcnR1YWxuZXR3b3JrZ2F0ZXdheXMve30vZ2V0ZmFpbG92ZXJzaW5nbGV0ZXN0ZGV0YWlscw==/2024-05-01.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.network/virtualnetworkgateways/{}/getfailoversingletestdetails 2024-05-01 -->

#### examples

- VirtualNetworkGatewayGetFailoverSingleTestDetails
```bash
network vnet-gateway get-failover-single-test-detail --resource-group rg1 --virtual-network-gateway-name ergw --peering-location Vancouver --failover-test-id fe458ae8-d2ae-4520-a104-44bc233bde7e
```
16 changes: 16 additions & 0 deletions Commands/network/vnet-gateway/_start-site-failover-test.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _network vnet-gateway start-site-failover-test_

This operation starts failover simulation on the gateway for the specified peering location

## Versions

### [2024-05-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5uZXR3b3JrL3ZpcnR1YWxuZXR3b3JrZ2F0ZXdheXMve30vc3RhcnRzaXRlZmFpbG92ZXJ0ZXN0/2024-05-01.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.network/virtualnetworkgateways/{}/startsitefailovertest 2024-05-01 -->

#### examples

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

This operation stops failover simulation on the gateway for the specified peering location

## Versions

### [2024-05-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5uZXR3b3JrL3ZpcnR1YWxuZXR3b3JrZ2F0ZXdheXMve30vc3RvcHNpdGVmYWlsb3ZlcnRlc3Q=/2024-05-01.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.network/virtualnetworkgateways/{}/stopsitefailovertest 2024-05-01 -->

#### examples

- VirtualNetworkGatewayStopSiteFailoverSimulation
```bash
network vnet-gateway stop-site-failover-test --resource-group rg1 --virtual-network-gateway-name ergw --peering-location Vancouver --was-simulation-successful True --details "[{failover-connection-name:conn1,failover-location:Denver,is-verified:False},{failover-connection-name:conn2,failover-location:Amsterdam,is-verified:True}]"
```
12 changes: 12 additions & 0 deletions Commands/network/vnet-gateway/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,12 @@ To learn more about Azure Virtual Network Gateways, visit https://learn.microsof
- [disconnect-vpn-connections](/Commands/network/vnet-gateway/_disconnect-vpn-connections.md)
: Disconnect vpn connections of virtual network gateway.

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

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

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

Expand Down Expand Up @@ -71,5 +77,11 @@ To learn more about Azure Virtual Network Gateways, visit https://learn.microsof
- [show-supported-devices](/Commands/network/vnet-gateway/_show-supported-devices.md)
: Get a xml format representation for supported vpn devices.

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

- [stop-site-failover-test](/Commands/network/vnet-gateway/_stop-site-failover-test.md)
: This operation stops failover simulation on the gateway for the specified peering location

- [update](/Commands/network/vnet-gateway/_update.md)
: Update a virtual network gateway.
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"plane": "mgmt-plane", "resources": [{"id": "/subscriptions/{}/resourcegroups/{}/providers/microsoft.network/virtualnetworkgateways/{}/getfailoveralltestsdetails", "version": "2024-05-01", "swagger": "mgmt-plane/network/ResourceProviders/Microsoft.Network/Paths/L3N1YnNjcmlwdGlvbnMve3N1YnNjcmlwdGlvbklkfS9yZXNvdXJjZUdyb3Vwcy97cmVzb3VyY2VHcm91cE5hbWV9L3Byb3ZpZGVycy9NaWNyb3NvZnQuTmV0d29yay92aXJ0dWFsTmV0d29ya0dhdGV3YXlzL3t2aXJ0dWFsTmV0d29ya0dhdGV3YXlOYW1lfS9nZXRGYWlsb3ZlckFsbFRlc3RzRGV0YWlscw==/V/MjAyNC0wNS0wMQ=="}], "commandGroups": [{"name": "network vnet-gateway", "commands": [{"name": "get-failover-all-tests-detail", "version": "2024-05-01", "resources": [{"id": "/subscriptions/{}/resourcegroups/{}/providers/microsoft.network/virtualnetworkgateways/{}/getfailoveralltestsdetails", "version": "2024-05-01", "swagger": "mgmt-plane/network/ResourceProviders/Microsoft.Network/Paths/L3N1YnNjcmlwdGlvbnMve3N1YnNjcmlwdGlvbklkfS9yZXNvdXJjZUdyb3Vwcy97cmVzb3VyY2VHcm91cE5hbWV9L3Byb3ZpZGVycy9NaWNyb3NvZnQuTmV0d29yay92aXJ0dWFsTmV0d29ya0dhdGV3YXlzL3t2aXJ0dWFsTmV0d29ya0dhdGV3YXlOYW1lfS9nZXRGYWlsb3ZlckFsbFRlc3RzRGV0YWlscw==/V/MjAyNC0wNS0wMQ=="}], "argGroups": [{"name": "", "args": [{"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": "$Path.virtualNetworkGatewayName", "options": ["virtual-network-gateway-name"], "required": true, "idPart": "name", "help": {"short": "The name of the virtual network gateway."}}, {"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"}}]}], "operations": [{"longRunning": {"finalStateVia": "location"}, "operationId": "VirtualNetworkGateways_GetFailoverAllTestDetails", "http": {"path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/getFailoverAllTestsDetails", "request": {"method": "post", "path": {"params": [{"type": "string", "name": "resourceGroupName", "arg": "$Path.resourceGroupName", "required": true}, {"type": "string", "name": "subscriptionId", "arg": "$Path.subscriptionId", "required": true}, {"type": "string", "name": "virtualNetworkGatewayName", "arg": "$Path.virtualNetworkGatewayName", "required": true}]}, "query": {"params": [{"type": "boolean", "name": "fetchLatest", "arg": "$Query.fetchLatest", "required": true}, {"type": "string", "name": "type", "arg": "$Query.type", "required": true}], "consts": [{"readOnly": true, "const": true, "default": {"value": "2024-05-01"}, "type": "string", "name": "api-version", "required": true}]}}, "responses": [{"statusCode": [200], "body": {"json": {"var": "$Instance", "schema": {"type": "array<object>", "item": {"type": "object", "props": [{"type": "array<object>", "name": "circuits", "item": {"type": "object", "props": [{"type": "string", "name": "connectionName"}, {"type": "string", "name": "name"}, {"type": "ResourceId", "name": "nrpResourceUri"}]}}, {"type": "array<object>", "name": "connections", "item": {"type": "object", "props": [{"type": "string", "name": "lastUpdatedTime"}, {"type": "string", "name": "name"}, {"type": "ResourceId", "name": "nrpResourceUri"}, {"type": "string", "name": "status", "enum": {"items": [{"value": "Connected"}, {"value": "Disconnected"}]}}]}}, {"type": "string", "name": "endTime"}, {"type": "array<string>", "name": "issues", "item": {"type": "string"}}, {"type": "string", "name": "peeringLocation"}, {"type": "string", "name": "startTime"}, {"type": "string", "name": "status", "enum": {"items": [{"value": "Completed"}, {"value": "Expired"}, {"value": "Invalid"}, {"value": "NotStarted"}, {"value": "Running"}, {"value": "StartFailed"}, {"value": "Starting"}, {"value": "StopFailed"}, {"value": "Stopping"}]}}, {"type": "string", "name": "testGuid"}, {"type": "string", "name": "testType", "enum": {"items": [{"value": "All"}, {"value": "MultiSiteFailover"}, {"value": "SingleSiteFailover"}]}}]}}}}}, {"statusCode": [202], "header": {"items": [{"name": "location"}]}}, {"isError": true, "body": {"json": {"schema": {"type": "@ODataV4Format"}}}}]}}], "outputs": [{"type": "array", "ref": "$Instance", "clientFlatten": true}]}]}]}
Original file line number Diff line number Diff line change
@@ -0,0 +1,111 @@
<?xml version='1.0' encoding='utf-8'?>
<CodeGen plane="mgmt-plane">
<resource id="/subscriptions/{}/resourcegroups/{}/providers/microsoft.network/virtualnetworkgateways/{}/getfailoveralltestsdetails" version="2024-05-01" swagger="mgmt-plane/network/ResourceProviders/Microsoft.Network/Paths/L3N1YnNjcmlwdGlvbnMve3N1YnNjcmlwdGlvbklkfS9yZXNvdXJjZUdyb3Vwcy97cmVzb3VyY2VHcm91cE5hbWV9L3Byb3ZpZGVycy9NaWNyb3NvZnQuTmV0d29yay92aXJ0dWFsTmV0d29ya0dhdGV3YXlzL3t2aXJ0dWFsTmV0d29ya0dhdGV3YXlOYW1lfS9nZXRGYWlsb3ZlckFsbFRlc3RzRGV0YWlscw==/V/MjAyNC0wNS0wMQ=="/>
<commandGroup name="network vnet-gateway">
<command name="get-failover-all-tests-detail" version="2024-05-01">
<resource id="/subscriptions/{}/resourcegroups/{}/providers/microsoft.network/virtualnetworkgateways/{}/getfailoveralltestsdetails" version="2024-05-01" swagger="mgmt-plane/network/ResourceProviders/Microsoft.Network/Paths/L3N1YnNjcmlwdGlvbnMve3N1YnNjcmlwdGlvbklkfS9yZXNvdXJjZUdyb3Vwcy97cmVzb3VyY2VHcm91cE5hbWV9L3Byb3ZpZGVycy9NaWNyb3NvZnQuTmV0d29yay92aXJ0dWFsTmV0d29ya0dhdGV3YXlzL3t2aXJ0dWFsTmV0d29ya0dhdGV3YXlOYW1lfS9nZXRGYWlsb3ZlckFsbFRlc3RzRGV0YWlscw==/V/MjAyNC0wNS0wMQ=="/>
<argGroup name="">
<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="$Path.virtualNetworkGatewayName" options="virtual-network-gateway-name" required="True" idPart="name">
<help short="The name of the virtual network gateway."/>
</arg>
<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"/>
</arg>
</argGroup>
<operation operationId="VirtualNetworkGateways_GetFailoverAllTestDetails">
<longRunning finalStateVia="location"/>
<http path="/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/getFailoverAllTestsDetails">
<request method="post">
<path>
<param type="string" name="resourceGroupName" arg="$Path.resourceGroupName" required="True"/>
<param type="string" name="subscriptionId" arg="$Path.subscriptionId" required="True"/>
<param type="string" name="virtualNetworkGatewayName" arg="$Path.virtualNetworkGatewayName" required="True"/>
</path>
<query>
<param type="boolean" name="fetchLatest" arg="$Query.fetchLatest" required="True"/>
<param type="string" name="type" arg="$Query.type" required="True"/>
<const readOnly="True" const="True" type="string" name="api-version" required="True">
<default value="&quot;2024-05-01&quot;"/>
</const>
</query>
</request>
<response statusCode="200">
<body>
<json var="$Instance">
<schema type="array<object>">
<item type="object">
<prop 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 type="array<object>" name="connections">
<item type="object">
<prop 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 type="string" name="endTime"/>
<prop type="array<string>" name="issues">
<item type="string"/>
</prop>
<prop type="string" name="peeringLocation"/>
<prop type="string" name="startTime"/>
<prop 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 type="string" name="testGuid"/>
<prop type="string" name="testType">
<enum>
<item value="&quot;All&quot;"/>
<item value="&quot;MultiSiteFailover&quot;"/>
<item value="&quot;SingleSiteFailover&quot;"/>
</enum>
</prop>
</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" clientFlatten="True"/>
</command>
</commandGroup>
</CodeGen>
Loading