Edit

New-AzExpressRouteCircuitAuthorization

  • Reference
Module:
Az.Network

Creates an ExpressRoute circuit authorization.

Syntax

New-AzExpressRouteCircuitAuthorization
   -Name <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The New-AzExpressRouteCircuitAuthorization cmdlet creates a circuit authorization that can be added to an ExpressRoute circuit. ExpressRoute circuits connect your on-premises network to the Microsoft cloud by using a connectivity provider instead of the public Internet. The owner of an ExpressRoute circuit can create as many as 10 authorizations for each circuit; these authorizations generate an authorization key that can be used by a virtual network owner to connect a network to the circuit. There can only one authorization per virtual network. After you create an ExpressRoute circuit you can use Add-AzExpressRouteCircuitAuthorization to add an authorization to that circuit. Alternatively, you can use New-AzExpressRouteCircuitAuthorization to create an authorization that can be added to a new circuit at the same time the circuit is created.

Examples

Example 1: Create a new circuit authorization

$Authorization = New-AzExpressRouteCircuitAuthorization -Name "ContosoCircuitAuthorization"

This command creates a new circuit authorization named ContosoCircuitAuthorization and then stores that object in a variable named $Authorization. Saving the object to a variable is important: although New-AzExpressRouteCircuitAuthorization can create a circuit authorization it cannot add that authorization to a circuit route. Instead, the variable $Authorization is used New-AzExpressRouteCircuit when creating a brand-new ExpressRoute circuit. For more information, see the documentation for the New-AzExpressRouteCircuit cmdlet.

Parameters

-DefaultProfile

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

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Name

Specifies a unique name for the new ExpressRoute circuit authorization.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

Inputs

None

Outputs

PSExpressRouteCircuitAuthorization