< Back
Get-AzureRmExpressRouteCircuitPeeringConfig
Post
NAME Get-AzureRmExpressRouteCircuitPeeringConfig
SYNOPSIS
Gets an ExpressRoute circuit peering configuration.
SYNTAX
Get-AzureRmExpressRouteCircuitPeeringConfig [-DefaultProfile <IAzureContextContainer>] -ExpressRouteCircuit <PSExpressRouteCircuit> [-Name
<String>] [<CommonParameters>]
DESCRIPTION
The Get-AzureRmExpressRouteCircuitPeeringConfig cmdlet retrieves the configuration of a peering relationship for an ExpressRoute circuit.
PARAMETERS
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ExpressRouteCircuit <PSExpressRouteCircuit>
The ExpressRoute circuit object containing the peering configuration.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-Name <String>
The name of the peering configuration to be retrieved.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
PSExpressRouteCircuit
Parameter 'ExpressRouteCircuit' accepts value of type 'PSExpressRouteCircuit' from the pipeline
OUTPUTS
Microsoft.Azure.Commands.Network.Models.PSPeering
NOTES
Example 1: Display the peering configuration for an ExpressRoute circuit
$ckt = Get-AzureRmExpressRouteCircuit -Name $CircuitName -ResourceGroupName $RG
Get-AzureRmExpressRouteCircuitPeeringConfig -Name "AzurePrivatePeering" -ExpressRouteCircuit $ckt
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... ringconfig
Add-AzureRmExpressRouteCircuitPeeringConfig
New-AzureRmExpressRouteCircuitPeeringConfig
Remove-AzureRmExpressRouteCircuitPeeringConfig
Set-AzureRmExpressRouteCircuit
SYNOPSIS
Gets an ExpressRoute circuit peering configuration.
SYNTAX
Get-AzureRmExpressRouteCircuitPeeringConfig [-DefaultProfile <IAzureContextContainer>] -ExpressRouteCircuit <PSExpressRouteCircuit> [-Name
<String>] [<CommonParameters>]
DESCRIPTION
The Get-AzureRmExpressRouteCircuitPeeringConfig cmdlet retrieves the configuration of a peering relationship for an ExpressRoute circuit.
PARAMETERS
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ExpressRouteCircuit <PSExpressRouteCircuit>
The ExpressRoute circuit object containing the peering configuration.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-Name <String>
The name of the peering configuration to be retrieved.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
PSExpressRouteCircuit
Parameter 'ExpressRouteCircuit' accepts value of type 'PSExpressRouteCircuit' from the pipeline
OUTPUTS
Microsoft.Azure.Commands.Network.Models.PSPeering
NOTES
Example 1: Display the peering configuration for an ExpressRoute circuit
$ckt = Get-AzureRmExpressRouteCircuit -Name $CircuitName -ResourceGroupName $RG
Get-AzureRmExpressRouteCircuitPeeringConfig -Name "AzurePrivatePeering" -ExpressRouteCircuit $ckt
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... ringconfig
Add-AzureRmExpressRouteCircuitPeeringConfig
New-AzureRmExpressRouteCircuitPeeringConfig
Remove-AzureRmExpressRouteCircuitPeeringConfig
Set-AzureRmExpressRouteCircuit