Get-AzExpressRouteCircuit
Gets an Azure ExpressRoute circuit from Azure.
Syntax
Default (Default)
Get-AzExpressRouteCircuit
[-Name <String>]
[-ResourceGroupName <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
The Get-AzExpressRouteCircuit 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
Get-AzExpressRouteCircuit -ResourceGroupName testrg -Name test
Name : test
ResourceGroupName : testrg
Location : southcentralus
Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/pro
viders/Microsoft.Network/expressRouteCircuits/test
Etag : W/"00000000-0000-0000-0000-000000000000"
ProvisioningState : Succeeded
Sku : {
"Name": "Standard_UnlimitedData",
"Tier": "Standard",
"Family": "UnlimitedData"
}
CircuitProvisioningState : Enabled
ServiceProviderProvisioningState : NotProvisioned
ServiceProviderNotes :
ServiceProviderProperties : {
"ServiceProviderName": "AT&T",
"PeeringLocation": "Silicon Valley",
"BandwidthInMbps": 50
}
ExpressRoutePort : null
BandwidthInGbps :
Stag :
ServiceKey : 00000000-0000-0000-0000-000000000000
Peerings : []
Authorizations : []
AllowClassicOperations : False
GatewayManagerEtag :
Get a specific ExpressRoute circuit with Name "testrg" and ResourceGroupName "test"
Example 2: List the ExpressRoute circuits using filtering
Get-AzExpressRouteCircuit -Name test*
Name : test1
ResourceGroupName : testrg
Location : southcentralus
Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/pro
viders/Microsoft.Network/expressRouteCircuits/test1
Etag : W/"00000000-0000-0000-0000-000000000000"
ProvisioningState : Succeeded
Sku : {
"Name": "Standard_UnlimitedData",
"Tier": "Standard",
"Family": "UnlimitedData"
}
CircuitProvisioningState : Enabled
ServiceProviderProvisioningState : NotProvisioned
ServiceProviderNotes :
ServiceProviderProperties : {
"ServiceProviderName": "AT&T",
"PeeringLocation": "Silicon Valley",
"BandwidthInMbps": 50
}
ExpressRoutePort : null
BandwidthInGbps :
Stag :
ServiceKey : 00000000-0000-0000-0000-000000000000
Peerings : []
Authorizations : []
AllowClassicOperations : False
GatewayManagerEtag :
Name : test2
ResourceGroupName : testrg
Location : southcentralus
Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/pro
viders/Microsoft.Network/expressRouteCircuits/test2
Etag : W/"00000000-0000-0000-0000-000000000000"
ProvisioningState : Succeeded
Sku : {
"Name": "Standard_UnlimitedData",
"Tier": "Standard",
"Family": "UnlimitedData"
}
CircuitProvisioningState : Enabled
ServiceProviderProvisioningState : NotProvisioned
ServiceProviderNotes :
ServiceProviderProperties : {
"ServiceProviderName": "AT&T",
"PeeringLocation": "Silicon Valley",
"BandwidthInMbps": 50
}
ExpressRoutePort : null
BandwidthInGbps :
Stag :
ServiceKey : 00000000-0000-0000-0000-000000000000
Peerings : []
Authorizations : []
AllowClassicOperations : False
GatewayManagerEtag :
Get all ExpressRoute circuits whose name starts with "test".
Parameters
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with azure.
Parameter properties
| Type: | IAzureContextContainer |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Name
The name of the ExpressRoute circuit.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | True |
| DontShow: | False |
| Aliases: | ResourceName |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-ResourceGroupName
The name of the resource group that contains the ExpressRoute circuit.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | True |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
