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-resiliency-information.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _network vnet-gateway get-resiliency-information_

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

## Versions

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

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

#### examples

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

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

## Versions

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

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

#### examples

- GetVirtualNetworkGatewayRoutesInformation
```bash
network vnet-gateway get-routes-information --resource-group rg1 --virtual-network-gateway-name vpngw --attempt-refresh False
```
6 changes: 6 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-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

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

- [list](/Commands/network/vnet-gateway/_list.md)
: List virtual network gateways.

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/virtualnetworkgateways/{}/getroutesinformation", "version": "2024-07-01", "swagger": "mgmt-plane/network/ResourceProviders/Microsoft.Network/Paths/L3N1YnNjcmlwdGlvbnMve3N1YnNjcmlwdGlvbklkfS9yZXNvdXJjZUdyb3Vwcy97cmVzb3VyY2VHcm91cE5hbWV9L3Byb3ZpZGVycy9NaWNyb3NvZnQuTmV0d29yay92aXJ0dWFsTmV0d29ya0dhdGV3YXlzL3t2aXJ0dWFsTmV0d29ya0dhdGV3YXlOYW1lfS9nZXRSb3V0ZXNJbmZvcm1hdGlvbg==/V/MjAyNC0wNy0wMQ=="}], "commandGroups": [{"name": "network vnet-gateway", "commands": [{"name": "get-routes-information", "version": "2024-07-01", "resources": [{"id": "/subscriptions/{}/resourcegroups/{}/providers/microsoft.network/virtualnetworkgateways/{}/getroutesinformation", "version": "2024-07-01", "swagger": "mgmt-plane/network/ResourceProviders/Microsoft.Network/Paths/L3N1YnNjcmlwdGlvbnMve3N1YnNjcmlwdGlvbklkfS9yZXNvdXJjZUdyb3Vwcy97cmVzb3VyY2VHcm91cE5hbWV9L3Byb3ZpZGVycy9NaWNyb3NvZnQuTmV0d29yay92aXJ0dWFsTmV0d29ya0dhdGV3YXlzL3t2aXJ0dWFsTmV0d29ya0dhdGV3YXlOYW1lfS9nZXRSb3V0ZXNJbmZvcm1hdGlvbg==/V/MjAyNC0wNy0wMQ=="}], "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.attemptRefresh", "options": ["attempt-refresh"], "help": {"short": "Attempt to recalculate the Route Sets Information for the gateway"}}]}], "operations": [{"longRunning": {"finalStateVia": "location"}, "operationId": "VirtualNetworkGateways_GetRoutesInformation", "http": {"path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/getRoutesInformation", "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": "attemptRefresh", "arg": "$Query.attemptRefresh"}], "consts": [{"readOnly": true, "const": true, "default": {"value": "2024-07-01"}, "type": "string", "name": "api-version", "required": true}]}}, "responses": [{"statusCode": [200], "body": {"json": {"var": "$Instance", "schema": {"type": "object", "props": [{"type": "object", "name": "circuitsMetadataMap", "additionalProps": {"item": {"type": "object", "props": [{"type": "string", "name": "link"}, {"type": "string", "name": "location"}, {"type": "string", "name": "name"}]}}}, {"type": "string", "name": "lastComputedTime"}, {"type": "string", "name": "nextEligibleComputeTime"}, {"type": "string", "name": "routeSetVersion"}, {"type": "array<object>", "name": "routeSets", "item": {"type": "object", "props": [{"type": "object", "name": "details", "additionalProps": {"item": {"type": "array<object>", "item": {"type": "object", "props": [{"type": "string", "name": "circuit"}, {"type": "string", "name": "pri"}, {"type": "string", "name": "sec"}]}}}}, {"type": "array<string>", "name": "locations", "item": {"type": "string"}}, {"type": "string", "name": "name"}]}}]}}}}, {"statusCode": [202], "header": {"items": [{"name": "location"}]}}, {"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,89 @@
<?xml version='1.0' encoding='utf-8'?>
<CodeGen plane="mgmt-plane">
<resource id="/subscriptions/{}/resourcegroups/{}/providers/microsoft.network/virtualnetworkgateways/{}/getroutesinformation" version="2024-07-01" swagger="mgmt-plane/network/ResourceProviders/Microsoft.Network/Paths/L3N1YnNjcmlwdGlvbnMve3N1YnNjcmlwdGlvbklkfS9yZXNvdXJjZUdyb3Vwcy97cmVzb3VyY2VHcm91cE5hbWV9L3Byb3ZpZGVycy9NaWNyb3NvZnQuTmV0d29yay92aXJ0dWFsTmV0d29ya0dhdGV3YXlzL3t2aXJ0dWFsTmV0d29ya0dhdGV3YXlOYW1lfS9nZXRSb3V0ZXNJbmZvcm1hdGlvbg==/V/MjAyNC0wNy0wMQ=="/>
<commandGroup name="network vnet-gateway">
<command name="get-routes-information" version="2024-07-01">
<resource id="/subscriptions/{}/resourcegroups/{}/providers/microsoft.network/virtualnetworkgateways/{}/getroutesinformation" version="2024-07-01" swagger="mgmt-plane/network/ResourceProviders/Microsoft.Network/Paths/L3N1YnNjcmlwdGlvbnMve3N1YnNjcmlwdGlvbklkfS9yZXNvdXJjZUdyb3Vwcy97cmVzb3VyY2VHcm91cE5hbWV9L3Byb3ZpZGVycy9NaWNyb3NvZnQuTmV0d29yay92aXJ0dWFsTmV0d29ya0dhdGV3YXlzL3t2aXJ0dWFsTmV0d29ya0dhdGV3YXlOYW1lfS9nZXRSb3V0ZXNJbmZvcm1hdGlvbg==/V/MjAyNC0wNy0wMQ=="/>
<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.attemptRefresh" options="attempt-refresh">
<help short="Attempt to recalculate the Route Sets Information for the gateway"/>
</arg>
</argGroup>
<operation operationId="VirtualNetworkGateways_GetRoutesInformation">
<longRunning finalStateVia="location"/>
<http path="/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/getRoutesInformation">
<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="attemptRefresh" arg="$Query.attemptRefresh"/>
<const readOnly="True" const="True" type="string" name="api-version" required="True">
<default value="&quot;2024-07-01&quot;"/>
</const>
</query>
</request>
<response statusCode="200">
<body>
<json var="$Instance">
<schema type="object">
<prop type="object" name="circuitsMetadataMap">
<additionalProp>
<item type="object">
<prop type="string" name="link"/>
<prop type="string" name="location"/>
<prop type="string" name="name"/>
</item>
</additionalProp>
</prop>
<prop type="string" name="lastComputedTime"/>
<prop type="string" name="nextEligibleComputeTime"/>
<prop type="string" name="routeSetVersion"/>
<prop type="array<object>" name="routeSets">
<item type="object">
<prop type="object" name="details">
<additionalProp>
<item type="array<object>">
<item type="object">
<prop type="string" name="circuit"/>
<prop type="string" name="pri"/>
<prop type="string" name="sec"/>
</item>
</item>
</additionalProp>
</prop>
<prop type="array<string>" name="locations">
<item type="string"/>
</prop>
<prop type="string" name="name"/>
</item>
</prop>
</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="object" ref="$Instance" clientFlatten="True"/>
</command>
</commandGroup>
</CodeGen>
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"plane": "mgmt-plane", "resources": [{"id": "/subscriptions/{}/resourcegroups/{}/providers/microsoft.network/virtualnetworkgateways/{}/getresiliencyinformation", "version": "2024-07-01", "swagger": "mgmt-plane/network/ResourceProviders/Microsoft.Network/Paths/L3N1YnNjcmlwdGlvbnMve3N1YnNjcmlwdGlvbklkfS9yZXNvdXJjZUdyb3Vwcy97cmVzb3VyY2VHcm91cE5hbWV9L3Byb3ZpZGVycy9NaWNyb3NvZnQuTmV0d29yay92aXJ0dWFsTmV0d29ya0dhdGV3YXlzL3t2aXJ0dWFsTmV0d29ya0dhdGV3YXlOYW1lfS9nZXRSZXNpbGllbmN5SW5mb3JtYXRpb24=/V/MjAyNC0wNy0wMQ=="}], "commandGroups": [{"name": "network vnet-gateway", "commands": [{"name": "get-resiliency-information", "version": "2024-07-01", "resources": [{"id": "/subscriptions/{}/resourcegroups/{}/providers/microsoft.network/virtualnetworkgateways/{}/getresiliencyinformation", "version": "2024-07-01", "swagger": "mgmt-plane/network/ResourceProviders/Microsoft.Network/Paths/L3N1YnNjcmlwdGlvbnMve3N1YnNjcmlwdGlvbklkfS9yZXNvdXJjZUdyb3Vwcy97cmVzb3VyY2VHcm91cE5hbWV9L3Byb3ZpZGVycy9NaWNyb3NvZnQuTmV0d29yay92aXJ0dWFsTmV0d29ya0dhdGV3YXlzL3t2aXJ0dWFsTmV0d29ya0dhdGV3YXlOYW1lfS9nZXRSZXNpbGllbmN5SW5mb3JtYXRpb24=/V/MjAyNC0wNy0wMQ=="}], "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.attemptRefresh", "options": ["attempt-refresh"], "help": {"short": "Attempt to recalculate the Resiliency Information for the gateway"}}]}], "operations": [{"longRunning": {"finalStateVia": "location"}, "operationId": "VirtualNetworkGateways_GetResiliencyInformation", "http": {"path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/getResiliencyInformation", "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": "attemptRefresh", "arg": "$Query.attemptRefresh"}], "consts": [{"readOnly": true, "const": true, "default": {"value": "2024-07-01"}, "type": "string", "name": "api-version", "required": true}]}}, "responses": [{"statusCode": [200], "body": {"json": {"var": "$Instance", "schema": {"type": "object", "props": [{"type": "array<object>", "name": "components", "item": {"type": "object", "props": [{"type": "string", "name": "currentScore"}, {"type": "string", "name": "maxScore"}, {"type": "string", "name": "name"}, {"type": "array<object>", "name": "recommendations", "item": {"type": "object", "props": [{"type": "string", "name": "callToActionLink"}, {"type": "string", "name": "callToActionText"}, {"type": "string", "name": "recommendationId"}, {"type": "string", "name": "recommendationText"}, {"type": "string", "name": "recommendationTitle"}, {"type": "string", "name": "severity"}]}}]}}, {"type": "string", "name": "lastComputedTime"}, {"type": "string", "name": "maxScoreFromRecommendations"}, {"type": "string", "name": "minScoreFromRecommendations"}, {"type": "string", "name": "nextEligibleComputeTime"}, {"type": "string", "name": "overallScore"}, {"type": "string", "name": "scoreChange"}]}}}}, {"statusCode": [202], "header": {"items": [{"name": "location"}]}}, {"isError": true, "body": {"json": {"schema": {"type": "@ODataV4Format"}}}}]}}], "outputs": [{"type": "object", "ref": "$Instance", "clientFlatten": true}]}]}]}
Loading