Skip to content

Commit 0784655

Browse files
Shubhika-1795Shubhika-1795
committed
Adding aaz changes for VNET gateway Failover APIs
1 parent f64d8ef commit 0784655

13 files changed

Lines changed: 439 additions & 0 deletions

File tree

‎Commands/network/vnet-gateway/_get-failover-all-tests-detail.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# [Command] _network vnet-gateway get-failover-all-tests-detail_
2+
3+
This operation retrieves the details of all the failover tests performed on the gateway for different peering locations
4+
5+
## Versions
6+
7+
### [2024-05-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5uZXR3b3JrL3ZpcnR1YWxuZXR3b3JrZ2F0ZXdheXMve30vZ2V0ZmFpbG92ZXJhbGx0ZXN0c2RldGFpbHM=/2024-05-01.xml) **Stable**
8+
9+
<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.network/virtualnetworkgateways/{}/getfailoveralltestsdetails 2024-05-01 -->
10+
11+
#### examples
12+
13+
- VirtualNetworkGatewayGetFailoverAllTestsDetails
14+
```bash
15+
network vnet-gateway get-failover-all-tests-detail --resource-group rg1 --virtual-network-gateway-name ergw --type SingleSiteFailover --fetch-latest true
16+
```

‎Commands/network/vnet-gateway/_get-failover-single-test-detail.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# [Command] _network vnet-gateway get-failover-single-test-detail_
2+
3+
This operation retrieves the details of a particular failover test performed on the gateway based on the test Guid
4+
5+
## Versions
6+
7+
### [2024-05-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5uZXR3b3JrL3ZpcnR1YWxuZXR3b3JrZ2F0ZXdheXMve30vZ2V0ZmFpbG92ZXJzaW5nbGV0ZXN0ZGV0YWlscw==/2024-05-01.xml) **Stable**
8+
9+
<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.network/virtualnetworkgateways/{}/getfailoversingletestdetails 2024-05-01 -->
10+
11+
#### examples
12+
13+
- VirtualNetworkGatewayGetFailoverSingleTestDetails
14+
```bash
15+
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+
```

‎Commands/network/vnet-gateway/_start-site-failover-test.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# [Command] _network vnet-gateway start-site-failover-test_
2+
3+
This operation starts failover simulation on the gateway for the specified peering location
4+
5+
## Versions
6+
7+
### [2024-05-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5uZXR3b3JrL3ZpcnR1YWxuZXR3b3JrZ2F0ZXdheXMve30vc3RhcnRzaXRlZmFpbG92ZXJ0ZXN0/2024-05-01.xml) **Stable**
8+
9+
<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.network/virtualnetworkgateways/{}/startsitefailovertest 2024-05-01 -->
10+
11+
#### examples
12+
13+
- VirtualNetworkGatewayStartSiteFailoverSimulation
14+
```bash
15+
network vnet-gateway start-site-failover-test --resource-group rg1 --virtual-network-gateway-name ergw --peering-location Vancouver
16+
```

‎Commands/network/vnet-gateway/_stop-site-failover-test.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# [Command] _network vnet-gateway stop-site-failover-test_
2+
3+
This operation stops failover simulation on the gateway for the specified peering location
4+
5+
## Versions
6+
7+
### [2024-05-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5uZXR3b3JrL3ZpcnR1YWxuZXR3b3JrZ2F0ZXdheXMve30vc3RvcHNpdGVmYWlsb3ZlcnRlc3Q=/2024-05-01.xml) **Stable**
8+
9+
<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.network/virtualnetworkgateways/{}/stopsitefailovertest 2024-05-01 -->
10+
11+
#### examples
12+
13+
- VirtualNetworkGatewayStopSiteFailoverSimulation
14+
```bash
15+
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}]"
16+
```

‎Commands/network/vnet-gateway/readme.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,12 @@ To learn more about Azure Virtual Network Gateways, visit https://learn.microsof
4444
- [disconnect-vpn-connections](/Commands/network/vnet-gateway/_disconnect-vpn-connections.md)
4545
: Disconnect vpn connections of virtual network gateway.
4646

47+
- [get-failover-all-tests-detail](/Commands/network/vnet-gateway/_get-failover-all-tests-detail.md)
48+
: This operation retrieves the details of all the failover tests performed on the gateway for different peering locations
49+
50+
- [get-failover-single-test-detail](/Commands/network/vnet-gateway/_get-failover-single-test-detail.md)
51+
: This operation retrieves the details of a particular failover test performed on the gateway based on the test Guid
52+
4753
- [list](/Commands/network/vnet-gateway/_list.md)
4854
: List virtual network gateways.
4955

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

74+
- [start-site-failover-test](/Commands/network/vnet-gateway/_start-site-failover-test.md)
75+
: This operation starts failover simulation on the gateway for the specified peering location
76+
77+
- [stop-site-failover-test](/Commands/network/vnet-gateway/_stop-site-failover-test.md)
78+
: This operation stops failover simulation on the gateway for the specified peering location
79+
6880
- [update](/Commands/network/vnet-gateway/_update.md)
6981
: Update a virtual network gateway.

‎Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5uZXR3b3JrL3ZpcnR1YWxuZXR3b3JrZ2F0ZXdheXMve30vZ2V0ZmFpbG92ZXJhbGx0ZXN0c2RldGFpbHM=/2024-05-01.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
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}]}]}]}

‎Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5uZXR3b3JrL3ZpcnR1YWxuZXR3b3JrZ2F0ZXdheXMve30vZ2V0ZmFpbG92ZXJhbGx0ZXN0c2RldGFpbHM=/2024-05-01.xml‎

Lines changed: 111 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
1+
<?xml version='1.0' encoding='utf-8'?>
2+
<CodeGen plane="mgmt-plane">
3+
<resource id="/subscriptions/{}/resourcegroups/{}/providers/microsoft.network/virtualnetworkgateways/{}/getfailoveralltestsdetails" version="2024-05-01" swagger="mgmt-plane/network/ResourceProviders/Microsoft.Network/Paths/L3N1YnNjcmlwdGlvbnMve3N1YnNjcmlwdGlvbklkfS9yZXNvdXJjZUdyb3Vwcy97cmVzb3VyY2VHcm91cE5hbWV9L3Byb3ZpZGVycy9NaWNyb3NvZnQuTmV0d29yay92aXJ0dWFsTmV0d29ya0dhdGV3YXlzL3t2aXJ0dWFsTmV0d29ya0dhdGV3YXlOYW1lfS9nZXRGYWlsb3ZlckFsbFRlc3RzRGV0YWlscw==/V/MjAyNC0wNS0wMQ=="/>
4+
<commandGroup name="network vnet-gateway">
5+
<command name="get-failover-all-tests-detail" version="2024-05-01">
6+
<resource id="/subscriptions/{}/resourcegroups/{}/providers/microsoft.network/virtualnetworkgateways/{}/getfailoveralltestsdetails" version="2024-05-01" swagger="mgmt-plane/network/ResourceProviders/Microsoft.Network/Paths/L3N1YnNjcmlwdGlvbnMve3N1YnNjcmlwdGlvbklkfS9yZXNvdXJjZUdyb3Vwcy97cmVzb3VyY2VHcm91cE5hbWV9L3Byb3ZpZGVycy9NaWNyb3NvZnQuTmV0d29yay92aXJ0dWFsTmV0d29ya0dhdGV3YXlzL3t2aXJ0dWFsTmV0d29ya0dhdGV3YXlOYW1lfS9nZXRGYWlsb3ZlckFsbFRlc3RzRGV0YWlscw==/V/MjAyNC0wNS0wMQ=="/>
7+
<argGroup name="">
8+
<arg type="ResourceGroupName" var="$Path.resourceGroupName" options="resource-group g" required="True" idPart="resource_group"/>
9+
<arg type="SubscriptionId" var="$Path.subscriptionId" options="subscription" required="True" idPart="subscription"/>
10+
<arg type="string" var="$Path.virtualNetworkGatewayName" options="virtual-network-gateway-name" required="True" idPart="name">
11+
<help short="The name of the virtual network gateway."/>
12+
</arg>
13+
<arg type="boolean" var="$Query.fetchLatest" options="fetch-latest" required="True">
14+
<help short="Fetch only the latest tests for each peering location"/>
15+
</arg>
16+
<arg type="string" var="$Query.type" options="type" required="True">
17+
<help short="The type of failover test"/>
18+
</arg>
19+
</argGroup>
20+
<operation operationId="VirtualNetworkGateways_GetFailoverAllTestDetails">
21+
<longRunning finalStateVia="location"/>
22+
<http path="/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/getFailoverAllTestsDetails">
23+
<request method="post">
24+
<path>
25+
<param type="string" name="resourceGroupName" arg="$Path.resourceGroupName" required="True"/>
26+
<param type="string" name="subscriptionId" arg="$Path.subscriptionId" required="True"/>
27+
<param type="string" name="virtualNetworkGatewayName" arg="$Path.virtualNetworkGatewayName" required="True"/>
28+
</path>
29+
<query>
30+
<param type="boolean" name="fetchLatest" arg="$Query.fetchLatest" required="True"/>
31+
<param type="string" name="type" arg="$Query.type" required="True"/>
32+
<const readOnly="True" const="True" type="string" name="api-version" required="True">
33+
<default value="&quot;2024-05-01&quot;"/>
34+
</const>
35+
</query>
36+
</request>
37+
<response statusCode="200">
38+
<body>
39+
<json var="$Instance">
40+
<schema type="array<object>">
41+
<item type="object">
42+
<prop type="array<object>" name="circuits">
43+
<item type="object">
44+
<prop type="string" name="connectionName"/>
45+
<prop type="string" name="name"/>
46+
<prop type="ResourceId" name="nrpResourceUri"/>
47+
</item>
48+
</prop>
49+
<prop type="array<object>" name="connections">
50+
<item type="object">
51+
<prop type="string" name="lastUpdatedTime"/>
52+
<prop type="string" name="name"/>
53+
<prop type="ResourceId" name="nrpResourceUri"/>
54+
<prop type="string" name="status">
55+
<enum>
56+
<item value="&quot;Connected&quot;"/>
57+
<item value="&quot;Disconnected&quot;"/>
58+
</enum>
59+
</prop>
60+
</item>
61+
</prop>
62+
<prop type="string" name="endTime"/>
63+
<prop type="array<string>" name="issues">
64+
<item type="string"/>
65+
</prop>
66+
<prop type="string" name="peeringLocation"/>
67+
<prop type="string" name="startTime"/>
68+
<prop type="string" name="status">
69+
<enum>
70+
<item value="&quot;Completed&quot;"/>
71+
<item value="&quot;Expired&quot;"/>
72+
<item value="&quot;Invalid&quot;"/>
73+
<item value="&quot;NotStarted&quot;"/>
74+
<item value="&quot;Running&quot;"/>
75+
<item value="&quot;StartFailed&quot;"/>
76+
<item value="&quot;Starting&quot;"/>
77+
<item value="&quot;StopFailed&quot;"/>
78+
<item value="&quot;Stopping&quot;"/>
79+
</enum>
80+
</prop>
81+
<prop type="string" name="testGuid"/>
82+
<prop type="string" name="testType">
83+
<enum>
84+
<item value="&quot;All&quot;"/>
85+
<item value="&quot;MultiSiteFailover&quot;"/>
86+
<item value="&quot;SingleSiteFailover&quot;"/>
87+
</enum>
88+
</prop>
89+
</item>
90+
</schema>
91+
</json>
92+
</body>
93+
</response>
94+
<response statusCode="202">
95+
<header>
96+
<item name="location"/>
97+
</header>
98+
</response>
99+
<response isError="True">
100+
<body>
101+
<json>
102+
<schema type="@ODataV4Format"/>
103+
</json>
104+
</body>
105+
</response>
106+
</http>
107+
</operation>
108+
<output type="array" ref="$Instance" clientFlatten="True"/>
109+
</command>
110+
</commandGroup>
111+
</CodeGen>

0 commit comments

Comments
 (0)