Get-AzVirtualNetworkGatewayFailoverAllTestsDetail
Retrieves the details of all failover tests for a specified virtual network gateway.
Syntax
ByName (Default)
Get-AzVirtualNetworkGatewayFailoverAllTestsDetail
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
GetByNameParameterSet
Get-AzVirtualNetworkGatewayFailoverAllTestsDetail
-ResourceGroupName <String>
-VirtualNetworkGatewayName <String>
-Type <String>
-FetchLatest <Boolean>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
The Get-AzVirtualNetworkGatewayFailoverAllTestsDetailcmdlet retrieves detailed information about the failover tests conducted on a specific virtual network gateway. These tests assess the resiliency of the gateway by simulating failovers to various peering locations.
This cmdlet requires the ResourceGroupName, VirtualNetworkGatewayName, and Type parameters to identify the virtual network gateway and the specific type of failover test you wish to inspect. The -Type parameter allows you to specify the type of failover test (e.g., "SingleSiteFailover").
The -FetchLatest parameter, when set to true, ensures that only the most recent failover tests for each peering location are retrieved.
Using this cmdlet, you can gain valuable insights into the status, start time, end time, and results of each failover test, helping you evaluate the gateway's resiliency and ensure its availability across different locations.
Examples
Example 1
Get-AzVirtualNetworkGatewayFailoverAllTestsDetail -ResourceGroupName "test_rg" -VirtualNetworkGatewayName "test_gateway" -Type "SingleSiteFailover" -FetchLatest $true
This example retrieves the details of all failover tests of type SingleSiteFailover for the virtual network gateway "test_gateway" in the resource group "test_rg". The -FetchLatest parameter is set to $true, ensuring only the most recent failover tests for each peering location are returned.
Example 2
Get-AzVirtualNetworkGatewayFailoverAllTestsDetail -ResourceGroupName "test_rg" -VirtualNetworkGatewayName "test_gateway" -Type "MultiSiteFailover" -FetchLatest $false
This example retrieves all MultisiteFailover tests (not limited to the latest) for the virtual network gateway "test_gateway" in the resource group "test_rg". The -FetchLatest parameter is set to $false, so the cmdlet will return all available failover tests.
Parameters
-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 |
-FetchLatest
Fetch only the latest tests for each peering location.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
GetByNameParameterSet
| Position: | Named |
| Mandatory: | True |
| 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
GetByNameParameterSet
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Type
The type of failover test.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
GetByNameParameterSet
| 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
GetByNameParameterSet
| 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.
