Get-AzVirtualRouterPeer

Module:

Az.Network

Gets a VirtualRouter peer in an Azure VirtualRouter

Syntax

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

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

Description

The Get-AzVirtualRouterPeer cmdlet gets a Peer in an Azure VirtualRouter

Examples

Example 1

Get-AzVirtualRouterPeer -ResourceGroupName virtualRouterRG -VirtualRouterName virtualRouter -PeerName csr

Example 2

$virtualRouterPeerId = '/subscriptions/8c992d64-fce9-426d-b278-85642dfeab03/resourceGroups/virtualRouterRG/providers/Microsoft.Network/virtualRouters/virtualRouter/peerings/csr'
Get-AzVirtualRouterPeer -ResourceId $virtualRouterPeerId

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 virtual router 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 virtual router.

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

-ResourceId

ResourceId of the virtual router.

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

-VirtualRouterName

The name of the virtual router.

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

Inputs

String

Outputs

PSVirtualRouterPeer