Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

Get-AzRouteServerPeerAdvertisedRoute

List routes being advertised by specific route server peer

Syntax

RouteServerNPeerNameParameterSet (Default) 

Get-AzRouteServerPeerAdvertisedRoute
 -ResourceGroupName <String>
 -RouteServerName <String>
 -PeerName <String>
 [-AsJob]
 [-DefaultProfile <IAzureContextContainer>]
 [<CommonParameters>]

RouteServerNPeerInputObjectParameterSet 

Get-AzRouteServerPeerAdvertisedRoute
 -InputObject <PSRouteServerPeer>
 [-AsJob]
 [-DefaultProfile <IAzureContextContainer>]
 [<CommonParameters>]

Description

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

Examples

Example 1

Get-AzRouteServerPeerAdvertisedRoute -ResourceGroupName $resourceGroupName -RouteServerName $routeServerName -PeerName $peerName

Example 2

$routeServerPeer = Get-AzRouteServerPeer -ResourceGroupName $resourceGroupName -RouteServerName $routeServerName -PeerName $peerName
Get-AzRouteServerPeerAdvertisedRoute -InputObject $routeServerPeer

Parameters

-AsJob

Run cmdlet in the background

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-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

-InputObject

The route server peer input object.

Parameter properties

Type:PSRouteServerPeer
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-PeerName

Route server peer name

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:ResourceName

Parameter sets

-ResourceGroupName

Route server peer resource group's name

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-RouteServerName

Route Server name

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

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.

Inputs

String

PSRouteServerPeer

Outputs

PSPeerRoute

Feedback

Was this page helpful?