Edit

Share via

Get-AzRouteServerPeer

Module:
Az.Network Module

Gets a RouteServer peer in an Azure RouteServer

Syntax

RouteServerNPeerNameParameterSet (Default) 

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

RouteServerNPeerResourceIdParameterSet 

Get-AzRouteServerPeer
    -ResourceId <String>
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

Description

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

Examples

Example 1

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

Example 2

$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.

Parameter properties

Type:IAzureContextContainer
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AzContext, AzureRmContext, AzureCredential

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PeerName

The name of the route server peer.

Parameter properties

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

Parameter sets

RouteServerNPeerNameParameterSet
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-ResourceGroupName

The resource group name of the route server.

Parameter properties

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

Parameter sets

RouteServerNPeerNameParameterSet
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-ResourceId

ResourceId of the route server peer.

Parameter properties

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

Parameter sets

RouteServerNPeerResourceIdParameterSet
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-RouteServerName

The name of the route server.

Parameter properties

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

Parameter sets

RouteServerNPeerNameParameterSet
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

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

Outputs

PSRouteServerPeer