< Back
Get-AzureRmVirtualNetworkGatewayAdvertisedRoute
Post
NAME Get-AzureRmVirtualNetworkGatewayAdvertisedRoute
SYNOPSIS
Lists routes being advertised by an Azure virtual network gateway
SYNTAX
Get-AzureRmVirtualNetworkGatewayAdvertisedRoute [-AsJob] [-DefaultProfile <IAzureContextContainer>] -Peer <String> -ResourceGroupName <String>
-VirtualNetworkGatewayName <String> [<CommonParameters>]
DESCRIPTION
Given the IP of a BGP peer, enumerates routes being advertised to that peer by the specified Azure virtual network gateway.
PARAMETERS
-AsJob [<SwitchParameter>]
Run cmdlet in the background
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Peer <String>
BGP peer's IP address. This should be an IP within the address space accessible from within the Azure virtual network the gateway is deployed
in.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ResourceGroupName <String>
Virtual network gateway resource group's name
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-VirtualNetworkGatewayName <String>
Virtual network gateway name
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
System.String
OUTPUTS
Microsoft.Azure.Commands.Network.Models.PSGatewayRoute[]
NOTES
This command is only applicable to Azure virtual network gateways with BGP enabled connections.
Example 1
PS C:\\> Get-AzureRmVirtualNetworkGatewayAdvertisedRoute -VirtualNetworkGatewayName gatewayName -ResourceGroupName resourceGroupName -Peer
10.0.0.254
For the Azure gateway named gatewayName in resource group resourceGroupName, retrives a list of routes being advertised to the BGP peer with IP
10.0.0.254
Example 2
PS C:\\> $bgpPeerStatus = Get-AzureRmVirtualNetworkGatewayBGPPeerStatus -VirtualNetworkGatewayName gatewayName -ResourceGroupName resourceGroupName
PS C:\\> Get-AzureRmVirtualNetworkGatewayAdvertisedRoute -VirtualNetworkGatewayName gatewayName -ResourceGroupName resourceGroupName -Peer
$bgpPeerStatus[0].Neighbor
For the Azure gateway named gatewayName in resource group resourceGroupName, retrieves routes being advertised to the first BGP peer on the
gateway's list of BGP peers.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... tisedroute
SYNOPSIS
Lists routes being advertised by an Azure virtual network gateway
SYNTAX
Get-AzureRmVirtualNetworkGatewayAdvertisedRoute [-AsJob] [-DefaultProfile <IAzureContextContainer>] -Peer <String> -ResourceGroupName <String>
-VirtualNetworkGatewayName <String> [<CommonParameters>]
DESCRIPTION
Given the IP of a BGP peer, enumerates routes being advertised to that peer by the specified Azure virtual network gateway.
PARAMETERS
-AsJob [<SwitchParameter>]
Run cmdlet in the background
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Peer <String>
BGP peer's IP address. This should be an IP within the address space accessible from within the Azure virtual network the gateway is deployed
in.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ResourceGroupName <String>
Virtual network gateway resource group's name
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-VirtualNetworkGatewayName <String>
Virtual network gateway name
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
System.String
OUTPUTS
Microsoft.Azure.Commands.Network.Models.PSGatewayRoute[]
NOTES
This command is only applicable to Azure virtual network gateways with BGP enabled connections.
Example 1
PS C:\\> Get-AzureRmVirtualNetworkGatewayAdvertisedRoute -VirtualNetworkGatewayName gatewayName -ResourceGroupName resourceGroupName -Peer
10.0.0.254
For the Azure gateway named gatewayName in resource group resourceGroupName, retrives a list of routes being advertised to the BGP peer with IP
10.0.0.254
Example 2
PS C:\\> $bgpPeerStatus = Get-AzureRmVirtualNetworkGatewayBGPPeerStatus -VirtualNetworkGatewayName gatewayName -ResourceGroupName resourceGroupName
PS C:\\> Get-AzureRmVirtualNetworkGatewayAdvertisedRoute -VirtualNetworkGatewayName gatewayName -ResourceGroupName resourceGroupName -Peer
$bgpPeerStatus[0].Neighbor
For the Azure gateway named gatewayName in resource group resourceGroupName, retrieves routes being advertised to the first BGP peer on the
gateway's list of BGP peers.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... tisedroute