Edit

Share via

Get-AzRouteServerPeer

  • Reference
Module:
Az.Network

Gets a RouteServer peer in an Azure RouteServer

Syntax

PowerShell 
Get-AzRouteServerPeer
   -ResourceGroupName <String>
   -PeerName <String>
   -RouteServerName <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
PowerShell 
Get-AzRouteServerPeer
   -ResourceId <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The Get-AzRouteServerPeer cmdlet gets a Peer in an Azure RouteServer

Examples

Example 1

PowerShell 
Get-AzRouteServerPeer -ResourceGroupName routeServerRG -RouteServerName routeServer -PeerName peer

Example 2

PowerShell 
$routeServerPeerId = '/subscriptions/8c992d64-fce9-426d-b278-85642dfeab03/resourceGroups/routeServerRG/providers/Microsoft.Network/virtualHubs/routeServer/bgpConnections/peer'
Get-AzRouteServerPeer -ResourceId $routeServerPeerId

Parameters

-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

-PeerName

The name of the route server peer.

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

-ResourceGroupName

The resource group name of the route server.

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

-ResourceId

ResourceId of the route server peer.

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

-RouteServerName

The name of the route server.

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

Inputs

Outputs