New-AzExpressRouteCircuit
Creates an Azure express route circuit.
Syntax
ServiceProvider (Default)
New-AzExpressRouteCircuit
-Name <String>
-ResourceGroupName <String>
-Location <String>
-ServiceProviderName <String>
-PeeringLocation <String>
-BandwidthInMbps <Int32>
[-SkuTier <String>]
[-SkuFamily <String>]
[-Peering <PSPeering[]>]
[-Authorization <PSExpressRouteCircuitAuthorization[]>]
[-AllowClassicOperations <Boolean>]
[-Tag <Hashtable>]
[-Force]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ExpressRoutePort
New-AzExpressRouteCircuit
-Name <String>
-ResourceGroupName <String>
-Location <String>
-ExpressRoutePort <PSExpressRoutePort>
-BandwidthInGbps <Double>
[-SkuTier <String>]
[-SkuFamily <String>]
[-AuthorizationKey <String>]
[-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
-AllowClassicOperations
The use of this parameter allows you to use the classic Azure PowerShell cmdlets to manage the
circuit.
Parameter properties
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-AsJob
Run cmdlet in the background
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Authorization
A list of circuit authorizations.
Parameter properties
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-AuthorizationKey
The authorization key used when the circuit is provisioned on an ExpressRoutePort resource in different subscription.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ExpressRoutePort
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-BandwidthInGbps
The bandwidth of the circuit when the circuit is provisioned on an ExpressRoutePort resource.
Parameter properties
Type: Double
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ExpressRoutePort
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-BandwidthInMbps
The bandwidth of the circuit. This must be a value that is supported by the service provider.
Parameter properties
Type: Int32
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ServiceProvider
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
Type: SwitchParameter
Default value: False Supports wildcards: False DontShow: False Aliases: cf
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-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
-ExpressRoutePort
The reference to the ExpressRoutePort resource when the circuit is provisioned on an ExpressRoutePort resource.
Parameter properties
Parameter sets
ExpressRoutePort
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-Force
Forces the command to run without asking for user confirmation.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Location
The location of the circuit.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-Name
The name of the ExpressRoute circuit being created.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False Aliases: ResourceName
Parameter sets
(All)
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-Peering
A list peer configurations.
Parameter properties
Type: PSPeering [ ]
Default value: None Supports wildcards: False 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
-PeeringLocation
The name of the peering location supported by the service provider.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ServiceProvider
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-ResourceGroupName
The resource group that will contain the circuit.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-ServiceProviderName
The name of the circuit service provider. This must match a name listed by the
Get-AzExpressRouteServiceProvider cmdlet.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ServiceProvider
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-SkuFamily
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.
Parameter properties
Type: String
Default value: None Accepted values: MeteredData, UnlimitedData Supports wildcards: False 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
-SkuTier
The tier of service for the circuit. Possible values for this parameter are: Standard, Premium or Local.
Parameter properties
Type: String
Default value: None Accepted values: Standard, Premium, Basic, Local Supports wildcards: False 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
-Tag
Key-value pairs in the form of a hash table. For example:
@{key0="value0";key1=$null;key2="value2"}
Parameter properties
Type: Hashtable
Default value: None Supports wildcards: False 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
-WhatIf
Shows what would happen if the cmdlet runs.
The cmdlet is not run.
Parameter properties
Type: SwitchParameter
Default value: False Supports wildcards: False DontShow: False Aliases: wi
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False 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 .
Outputs
