Remove-AzureRmExpressRouteCircuitConnectionConfig

  • Reference
Module:
AzureRM.Network

Removes an ExpressRoute circuit connection configuration.

Warning

The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.

Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.

Syntax

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

Description

The Remove-AzureRmExpressRouteCircuitConnectionConfig 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-AzureRmExpressRouteCircuit -Name $initiatingCircuitName -ResourceGroupName $rg
Remove-AzureRmExpressRouteCircuitConnectionConfig -Name $circuitConnectionName -ExpressRouteCircuit $circuit_init
Set-AzureRmExpressRouteCircuit -ExpressRouteCircuit $circuit_init

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

Get-AzureRmExpressRouteCircuit -Name $initiatingCircuitName -ResourceGroupName $rg|Remove-AzureRmExpressRouteCircuitConnectionConfig -Name $circuitConnectionName|Set-AzureRmExpressRouteCircuit

Parameters

-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: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

Parameters: ExpressRouteCircuit (ByValue)

Outputs

PSExpressRouteCircuit