New-AzExpressRouteCircuit
Creates an Azure express route circuit.
Note
This is the previous version of our documentation. Please consult the most recent version for up-to-date information.
Syntax
New-AzExpressRouteCircuit
-Name <String>
-ResourceGroupName <String>
-Location <String>
[-SkuTier <String>]
[-SkuFamily <String>]
-ServiceProviderName <String>
-PeeringLocation <String>
-BandwidthInMbps <Int32>
[-Peering <PSPeering[]>]
[-Authorization <PSExpressRouteCircuitAuthorization[]>]
[-AllowClassicOperations <Boolean>]
[-Tag <Hashtable>]
[-Force]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
New-AzExpressRouteCircuit
-Name <String>
-ResourceGroupName <String>
-Location <String>
[-SkuTier <String>]
[-SkuFamily <String>]
-ExpressRoutePort <PSExpressRoutePort>
-BandwidthInGbps <Double>
[-Peering <PSPeering[]>]
[-Authorization <PSExpressRouteCircuitAuthorization[]>]
[-AllowClassicOperations <Boolean>]
[-Tag <Hashtable>]
[-Force]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The New-AzExpressRouteCircuit cmdlet creates an Azure express route circuit.
Examples
Example 1: Create a new ExpressRoute circuit
$parameters = @{
Name='ExpressRouteCircuit'
ResourceGroupName='ExpressRouteResourceGroup'
Location='West US'
SkuTier='Standard'
SkuFamily='MeteredData'
ServiceProviderName='Equinix'
PeeringLocation='Silicon Valley'
BandwidthInMbps=200
}
New-AzExpressRouteCircuit @parameters
Example 2: Create a new ExpressRoute circuit on ExpressRoutePort
$parameters = @{
Name='ExpressRouteCircuit'
ResourceGroupName='ExpressRouteResourceGroup'
Location='West US'
SkuTier='Standard'
SkuFamily='MeteredData'
ExpressRoutePort=$PSExpressRoutePort
BandwidthInGbps=10.0
}
New-AzExpressRouteCircuit @parameters
Parameters
The use of this parameter allows you to use the classic Azure PowerShell cmdlets to manage the circuit.
| Type: | Nullable<T>[Boolean] |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
Run cmdlet in the background
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
A list of circuit authorizations.
| Type: | PSExpressRouteCircuitAuthorization[] |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
The bandwidth of the circuit when the circuit is provisioned on an ExpressRoutePort resource.
| Type: | Double |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
The bandwidth of the circuit. This must be a value that is supported by the service provider.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
The credentials, account, tenant, and subscription used for communication with azure.
| Type: | IAzureContextContainer |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
The reference to the ExpressRoutePort resource when the circuit is provisioned on an ExpressRoutePort resource.
| Type: | PSExpressRoutePort |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
Forces the command to run without asking for user confirmation.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
The location of the circuit.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
The name of the ExpressRoute circuit being created.
| Type: | String |
| Aliases: | ResourceName |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
A list peer configurations.
| Type: | PSPeering[] |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
The name of the peering location supported by the service provider.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
The resource group that will contain the circuit.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
The name of the circuit service provider. This must match a name listed by the Get-AzExpressRouteServiceProvider cmdlet.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
SKU family determines the billing type. Possible values for this parameter are: MeteredData or
UnlimitedData. Note that you can change the billing type from MeteredData to UnlimitedData, but
you can't change the type from UnlimitedData to MeteredData.
| Type: | String |
| Accepted values: | MeteredData, UnlimitedData |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
The tier of service for the circuit. Possible values for this parameter are: Standard, Premium or Local.
| Type: | String |
| Accepted values: | Standard, Premium, Local |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
Key-value pairs in the form of a hash table. For example: @{key0="value0";key1=$null;key2="value2"}
| Type: | Hashtable |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
Shows what would happen if the cmdlet runs. The cmdlet is not run.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
PSExpressRouteCircuitAuthorization[]
Nullable<T>[[System.Boolean, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]