Edit

Remove-AzExpressRouteCircuitConnectionConfig

  • Reference
Module:
Az.Network

Removes an ExpressRoute circuit connection configuration.

Syntax

Remove-AzExpressRouteCircuitConnectionConfig
      [-Name] <String>
      [-ExpressRouteCircuit] <PSExpressRouteCircuit>
      [-AddressPrefixType <String>]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Remove-AzExpressRouteCircuitConnectionConfig cmdlet removes an ExpressRoute circuit connection configuration associated with a given Express Route Circuit.

Examples

Example 1: Remove a circuit connection configuration from an ExpressRoute circuit

$circuit_init = Get-AzExpressRouteCircuit -Name $initiatingCircuitName -ResourceGroupName $rg
Remove-AzExpressRouteCircuitConnectionConfig -Name $circuitConnectionName -ExpressRouteCircuit $circuit_init
Set-AzExpressRouteCircuit -ExpressRouteCircuit $circuit_init

Example 2: Remove a circuit connection configuration using Piping from an ExpressRoute Circuit

Get-AzExpressRouteCircuit -Name $initiatingCircuitName -ResourceGroupName $rg|Remove-AzExpressRouteCircuitConnectionConfig -Name $circuitConnectionName|Set-AzExpressRouteCircuit

Example 3: Remove a circuit connection configuration from an ExpressRoute circuit for a specific address family

$circuit_init = Get-AzExpressRouteCircuit -Name $initiatingCircuitName -ResourceGroupName $rg
Remove-AzExpressRouteCircuitConnectionConfig -Name $circuitConnectionName -ExpressRouteCircuit $circuit_init -AddressPrefixType IPv4
Set-AzExpressRouteCircuit -ExpressRouteCircuit $circuit_init

Example 4: Remove a circuit connection configuration using Piping from an ExpressRoute Circuit for a specific address family

Get-AzExpressRouteCircuit -Name $initiatingCircuitName -ResourceGroupName $rg|Remove-AzExpressRouteCircuitConnectionConfig -Name $circuitConnectionName -AddressPrefixType IPv6|Set-AzExpressRouteCircuit

Parameters

-AddressPrefixType

Specifies the address family that needs to be removed from the config

Type:String
Accepted values:IPv4, IPv6, All
Position:Named
Default value:IPv4
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-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

-ExpressRouteCircuit

The ExpressRoute circuit containing the peering configuration to be removed.

Type:PSExpressRouteCircuit
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Name

The name of the circuit connection configuration to be removed.

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

PSExpressRouteCircuit

Outputs

PSExpressRouteCircuit