Edit

Share via

Remove-AzExpressRouteCircuitPeeringConfig

Module:
Az.Network Module

Removes an ExpressRoute circuit peering configuration.

Syntax

Default (Default) 

Remove-AzExpressRouteCircuitPeeringConfig
    [-Name <String>]
    -ExpressRouteCircuit <PSExpressRouteCircuit>
    [-PeerAddressType <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

Description

The Remove-AzExpressRouteCircuitPeeringConfig cmdlet removes an ExpressRoute circuit peering configuration.

Examples

Example 1: Remove a peering configuration from an ExpressRoute circuit

$circuit = Get-AzExpressRouteCircuit -Name $CircuitName -ResourceGroupName $rg
Remove-AzExpressRouteCircuitPeeringConfig -Name 'AzurePrivatePeering' -ExpressRouteCircuit $circuit
Set-AzExpressRouteCircuit -ExpressRouteCircuit $circuit

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

-ExpressRouteCircuit

The ExpressRoute circuit containing the peering configuration to be removed.

Parameter properties

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

Parameter sets

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

-Name

The name of the peering configuration to be removed.

Parameter properties

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

Parameter sets

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

-PeerAddressType

The Address family of the peering

Parameter properties

Type:String
Default value:None
Accepted values:IPv4, IPv6, All
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
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

PSExpressRouteCircuit

Outputs

PSExpressRouteCircuit