Get-AzVirtualNetworkGatewayLearnedRoute
Lists routes learned by an Azure virtual network gateway
Syntax
Get-AzVirtualNetworkGatewayLearnedRoute
-VirtualNetworkGatewayName <String>
-ResourceGroupName <String>
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
Enumerates routes learned by an Azure virtual network gateway from various sources. This includes routes learned over BGP, as well as static routes.
Examples
Example 1
Get-AzVirtualNetworkGatewayLearnedRoute -ResourceGroupName resourceGroup -VirtualNetworkGatewayname gatewayName
AsPath :
LocalAddress : 10.1.0.254
Network : 10.1.0.0/16
NextHop :
Origin : Network
SourcePeer : 10.1.0.254
Weight : 32768
AsPath :
LocalAddress : 10.1.0.254
Network : 10.0.0.254/32
NextHop :
Origin : Network
SourcePeer : 10.1.0.254
Weight : 32768
AsPath : 65515
LocalAddress : 10.1.0.254
Network : 10.0.0.0/16
NextHop : 10.0.0.254
Origin : EBgp
SourcePeer : 10.0.0.254
Weight : 32768
For the Azure virtual network gateway named gatewayname in resource group resourceGroup, retrieves routes the Azure gateway knows. The Azure virtual network gateway in this case has two static routes (10.1.0.0/16 and 10.0.0.254/32), as well as one route learned over BGP (10.0.0.0/16).
Parameters
-AsJob
Run cmdlet in the background
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with azure.
Type: | IAzureContextContainer |
Aliases: | AzContext, AzureRmContext, AzureCredential |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ResourceGroupName
Virtual network gateway resource group's name
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-VirtualNetworkGatewayName
Virtual network gateway name
Type: | String |
Aliases: | ResourceName |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Inputs
Outputs
Azure PowerShell