Get-AzVirtualRouterPeer
Gets a VirtualRouter peer in an Azure VirtualRouter
Syntax
VirtualRouterPeerNameParameterSet (Default)
Get-AzVirtualRouterPeer
-ResourceGroupName <String>
-PeerName <String>
-VirtualRouterName <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
VirtualRouterPeerResourceIdParameterSet
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.
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 virtual router peer.
Parameter properties
Type: String
Default value: None Supports wildcards: True DontShow: False Aliases: ResourceName
Parameter sets
VirtualRouterPeerNameParameterSet
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 virtual router.
Parameter properties
Type: String
Default value: None Supports wildcards: True DontShow: False
Parameter sets
VirtualRouterPeerNameParameterSet
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-ResourceId
ResourceId of the virtual router.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
VirtualRouterPeerResourceIdParameterSet
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-VirtualRouterName
The name of the virtual router.
Parameter properties
Type: String
Default value: None Supports wildcards: True DontShow: False
Parameter sets
VirtualRouterPeerNameParameterSet
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 .
Outputs
