Azure ExpressRoute Cmdlets Reference

This section provides detailed documentation for Azure ExpressRoute cmdlets in Azure PowerShell. These cmdlets allow you to manage your ExpressRoute circuits, connections, and related configurations.

Cmdlet Categories

The ExpressRoute cmdlets are grouped by functionality:

Circuit Management: Cmdlets for creating, viewing, updating, and deleting ExpressRoute circuits.
Connection Management: Cmdlets for managing connections between your on-premises network and Azure.
Peering Management: Cmdlets for configuring public, private, and Microsoft peering.
Authorization and Provider Management: Cmdlets related to ExpressRoute partner authorizations and provider operations.

Common Cmdlets

Get-AzExpressRouteCircuit

Get-AzExpressRouteCircuit [-Name ] [-ResourceGroupName ] []

Retrieves one or more ExpressRoute circuits.

Parameters:

Name	Type	Description
`Name`	String	The name of the ExpressRoute circuit.
`ResourceGroupName`	String	The name of the resource group.

Example:

Get-AzExpressRouteCircuit -Name "MyCircuit" -ResourceGroupName "MyResourceGroup"

New-AzExpressRouteCircuit

New-AzExpressRouteCircuit -Name -ResourceGroupName -Location -Sku -Bandwidth [-CircuitName ] [-Force] []

Creates a new ExpressRoute circuit.

Parameters:

Name	Type	Description
`Name`	String	The name of the ExpressRoute circuit.
`ResourceGroupName`	String	The name of the resource group.
`Location`	String	The Azure region where the circuit will be created.
`Sku`	PSObject	Specifies the SKU details for the ExpressRoute circuit (e.g., Standard, Premium).
`Bandwidth`	Int32	The desired bandwidth in Mbps.

Example:

$sku = New-Object -TypeName Microsoft.Azure.Commands.ExpressRoute.Models.PSSkuId -Property @{Name = "Standard"; Family = "Metered"}
New-AzExpressRouteCircuit -Name "MyNewCircuit" -ResourceGroupName "MyResourceGroup" -Location "East US" -Sku $sku -Bandwidth 1000

Set-AzExpressRouteCircuit

Set-AzExpressRouteCircuit -Circuit  [-AllowGlobalReach] [-Bandwidth ] [-CircuitName ] [-ExpressRoutePort ] [-Location ] [-Sku ] [-Tag ] []

Updates an existing ExpressRoute circuit.

Parameters:

Name	Type	Description
`Circuit`	PSObject	The ExpressRoute circuit object to update.
`Bandwidth`	Int32	The new desired bandwidth in Mbps.
`Sku`	PSObject	The new SKU for the circuit.

Example:

$circuit = Get-AzExpressRouteCircuit -Name "MyCircuit" -ResourceGroupName "MyResourceGroup"
Set-AzExpressRouteCircuit -Circuit $circuit -Bandwidth 2000

Remove-AzExpressRouteCircuit

Remove-AzExpressRouteCircuit -Name -ResourceGroupName [-Force] [-PassThru] []

Deletes an ExpressRoute circuit.

Parameters:

Name	Type	Description
`Name`	String	The name of the ExpressRoute circuit to delete.
`ResourceGroupName`	String	The name of the resource group.

Example:

Remove-AzExpressRouteCircuit -Name "MyCircuitToDelete" -ResourceGroupName "MyResourceGroup" -Force

More Cmdlets

Get-AzExpressRouteCircuitPeeringConfig
Set-AzExpressRouteCircuitPeeringConfig
New-AzExpressRouteCircuitPeeringConfig
Get-AzExpressRouteCircuitConnection
New-AzExpressRouteCircuitConnection
Remove-AzExpressRouteCircuitConnection

For a comprehensive list of all available cmdlets and their detailed parameters, please refer to the official Azure PowerShell documentation index.