Get-AzVirtualRouterPeerAdvertisedRoute

Reference

Module:: Az.Network

List routes being advertised by specific virtual router peer

Syntax

Get-AzVirtualRouterPeerAdvertisedRoute
   -ResourceGroupName <String>
   -VirtualRouterName <String>
   -PeerName <String>
   [-AsJob]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzVirtualRouterPeerAdvertisedRoute
   -InputObject <PSVirtualRouterPeer>
   [-AsJob]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

Given A virtual router peer either by name or by object, enumerate routes being advertised to that peer by a specific virtual router.

Examples

Example 1

Get-AzVirtualRouterPeerAdvertisedRoute -ResourceGroupName $resourceGroupName -VirtualRouterName $virtualRouterName -PeerName $peerName

Example 2

$virtualRouterPeer = Get-AzVirtualRouterPeer -ResourceGroupName $resourceGroupName -VirtualRouterName $virtualRouterName -PeerName $peerName
Get-AzVirtualRouterPeerAdvertisedRoute -InputObject $virtualRouterPeer

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

-InputObject

The virtual router peer input object.

Type:	PSVirtualRouterPeer
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-PeerName

Virtual router peer name

Type:	String
Aliases:	ResourceName
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-ResourceGroupName

Virtual router peer resource group's name

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-VirtualRouterName

Virtual router name

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

Inputs

String

PSVirtualRouterPeer

Outputs

PSPeerRoute

Share via