Get-AzVirtualNetworkGatewayResiliencyInformation
Retrieves the resiliency information for an ExpressRoute Gateway, including its current resiliency score and recommendations for improvement.
Syntax
Default (Default)
Get-AzVirtualNetworkGatewayResiliencyInformation
-ResourceGroupName <String>
-VirtualNetworkGatewayName <String>
[-AttemptRefresh <Boolean>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
The Get-AzVirtualNetworkGatewayResiliencyInformation cmdlet retrieves the resiliency information for a specific virtual network gateway, including the gateway's current resiliency score. This score indicates the gateway's performance in terms of availability, redundancy, and failover capabilities. Additionally, the cmdlet provides recommendations for improving the gateway's resiliency score, ensuring better business continuity.
By default, the cmdlet retrieves the existing resiliency information. If you want to refresh and recalculate the resiliency metrics to get the most up-to-date data, you can use the -AttemptRefresh parameter, which triggers a recalculation of the resiliency information.
This cmdlet is essential for evaluating the robustness of your virtual network gateway, helping you identify areas where improvements can be made to enhance its availability and overall performance.
Examples
Example 1
Get-AzVirtualNetworkGatewayResiliencyInformation -ResourceGroupName "test_rg" -VirtualNetworkGatewayName "test_gateway"
This example retrieves the resiliency information for the virtual network gateway "test_gateway" in the resource group "test_rg". It does not attempt to refresh the data, providing the latest available information.
Example 2
Get-AzVirtualNetworkGatewayResiliencyInformation -ResourceGroupName "test_rg" -VirtualNetworkGatewayName "test_gateway" -AttemptRefresh $true
This example retrieves the resiliency information for the virtual network gateway "test_gateway" in the resource group "test_rg", and forces the system to recalculate the resiliency metrics by using the -AttemptRefresh parameter set to $true.
Parameters
-AttemptRefresh
Attempt to recalculate the Resiliency Information for the gateway.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
Parameter properties
| Type: | IAzureContextContainer |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ResourceGroupName
The resource group name of the virtual network gateway.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-VirtualNetworkGatewayName
The name of the virtual network gateway.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
