< Back

Remove-AzureRmExpressRouteCircuit

Tue Jan 29, 2019 9:57 pm

NAME Remove-AzureRmExpressRouteCircuit



SYNOPSIS

Removes an ExpressRoute circuit.





SYNTAX

Remove-AzureRmExpressRouteCircuit [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-Force] -Name <String> [-PassThru] -ResourceGroupName

<String> [-Confirm] [-WhatIf] [<CommonParameters>]





DESCRIPTION

The Remove-AzureRmExpressRouteCircuit cmdlet removes an ExpressRoute circuit.





PARAMETERS

-AsJob [<SwitchParameter>]

Run cmdlet in the background



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-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



-Force [<SwitchParameter>]

Forces the command to run without asking for user confirmation.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-Name <String>

The name of the ExpressRoute circuit to be removed.



Required? true

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-PassThru [<SwitchParameter>]

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-ResourceGroupName <String>

Specifies the name of the resource group that this ExpressRoute circuit belongs to.



Required? true

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Confirm [<SwitchParameter>]

Prompts you for confirmation before running the cmdlet.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]

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



Required? false

Position? named

Default value False

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

None

This cmdlet does not accept any input.





OUTPUTS



NOTES









Example 1: Delete an ExpressRoute circuit



Remove-AzureRmExpressRouteCircuit -Name $CircuitName -ResourceGroupName $rg









Example 2: Delete an ExpressRoute circuit using the pipeline



Get-AzureRmExpressRouteCircuit -Name $CircuitName -ResourceGroupName $rg | Remove-AzureRmExpressRouteCircuit











RELATED LINKS

Online Version: https://docs.microsoft.com/en-us/powers ... utecircuit

Get-AzureRmExpressRouteCircuit

Move-AzureRmExpressRouteCircuit

New-AzureRmExpressRouteCircuit

Set-AzureRmExpressRouteCircuit