Get-AzVirtualNetworkGatewayFailoverSingleTestDetail
Retrieves detailed information about a specific failover test for a virtual network gateway.
Syntax
Default (Default)
Get-AzVirtualNetworkGatewayFailoverSingleTestDetail
-ResourceGroupName <String>
-VirtualNetworkGatewayName <String>
-PeeringLocation <String>
-FailoverTestId <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
The Get-AzVirtualNetworkGatewayFailoverSingleTestDetail cmdlet retrieves detailed information about a specific failover test performed on a virtual network gateway. This cmdlet allows you to identify a particular test using the FailoverTestId (a unique GUID), the PeeringLocation where the test was performed, and the ResourceGroupName and VirtualNetworkGatewayName to locate the specific gateway.
You can obtain the FailoverTestId (or TestGuid) from the output of the Get-AzVirtualNetworkGatewayFailoverAllTestsDetail cmdlet, which provides a list of all failover tests conducted on the virtual network gateway.
This cmdlet is especially useful when you need to examine the results of a single failover test, such as the start time, end time, status, and other related test details. You can specify the failover test to retrieve by using the FailoverTestId and PeeringLocation.
Examples
Example 1
Get-AzVirtualNetworkGatewayFailoverSingleTestDetail -ResourceGroupName "test_rg" -VirtualNetworkGatewayName "test_gateway" -PeeringLocation "West US" -FailoverTestId "00000000-0000-0000-0000-000000000000"
This example retrieves the details of a specific failover test with the FailoverTestId of 00000000-0000-0000-0000-000000000000 that was performed in the East US peering location on the virtual network gateway "test_gateway" in the resource group "test_rg".
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 |
-FailoverTestId
The unique Guid value which identifies the test.
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 |
-PeeringLocation
Peering location of the test.
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 |
-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.
