< Back

Get-AzureRmExpressRouteCircuit

Tue Jan 29, 2019 9:54 pm

NAME Get-AzureRmExpressRouteCircuit



SYNOPSIS

Gets an Azure ExpressRoute circuit from Azure.





SYNTAX

Get-AzureRmExpressRouteCircuit [-DefaultProfile <IAzureContextContainer>] [-Name <String>] [-ResourceGroupName <String>] [<CommonParameters>]





DESCRIPTION

The Get-AzureRmExpressRouteCircuit cmdlet is used to retrieve an ExpressRoute circuit object from your subscription. The circuit object returned

can be used as input to other cmdlets that operate on ExpressRoute circuits.





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



-Name <String>

The name of the ExpressRoute circuit.



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-ResourceGroupName <String>

The name of the resource group that contains the ExpressRoute circuit.



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

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

Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit







NOTES









Example 1: Get the ExpressRoute circuit to be deleted



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











RELATED LINKS

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

Move-AzureRmExpressRouteCircuit

New-AzureRmExpressRouteCircuit

Remove-AzureRmExpressRouteCircuit

Set-AzureRmExpressRouteCircuit