New-AzureRmExpressRouteCircuitAuthorization
Creates an ExpressRoute circuit authorization.
Warning
The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.
Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.
Syntax
New-AzureRmExpressRouteCircuitAuthorization
-Name <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Description
The New-AzureRmExpressRouteCircuitAuthorization 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-AzureRmExpressRouteCircuitAuthorization to add an authorization to that circuit. Alternatively, you can use New-AzureRmExpressRouteCircuitAuthorization 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-AzureRmExpressRouteCircuitAuthorization -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-AzureRmExpressRouteCircuitAuthorization can create a circuit authorization it cannot add that authorization to a circuit route. Instead, the variable $Authorization is used New-AzureRmExpressRouteCircuit when creating a brand-new ExpressRoute circuit. For more information, see the documentation for the New-AzureRmExpressRouteCircuit cmdlet.
Parameters
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with azure.
| Type: | IAzureContextContainer |
| Aliases: | 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