Get-AzureRmExpressRouteCircuit

Gets an Azure ExpressRoute circuit from Azure.

Syntax

Get-AzureRmExpressRouteCircuit
   [-Name <String>]
   [-ResourceGroupName <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<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.

Examples

Example 1: Get the ExpressRoute circuit to be deleted

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

Optional Parameters

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with azure.

Type:Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer
Aliases:AzureRmContext, AzureCredential
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Name

The name of the ExpressRoute circuit.

Type:String
Aliases:ResourceName
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-ResourceGroupName

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

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Outputs

Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit