Add-AzureRmExpressRouteCircuitAuthorization
Adds 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
Add-AzureRmExpressRouteCircuitAuthorization
-Name <String>
-ExpressRouteCircuit <PSExpressRouteCircuit>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Description
The Add-AzureRmExpressRouteCircuitAuthorization cmdlet adds an authorization 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 his or her network to the circuit (one authorization per virtual network). Add-AzureRmExpressRouteCircuitAuthorization adds a new authorization to a circuit and, at the same time, generates the corresponding authorization key. These keys can be viewed at any time by running the Get-AzureRmExpressRouteCircuitAuthorization cmdlet and, as needed, can then be copied and forwarded to the appropriate network owner. Note that, after running Add-AzureRmExpressRouteCircuitAuthorization, you must call the Set-AzureRmExpressRouteCircuit cmdlet to activate the key. If you do not call Set-AzureRmExpressRouteCircuit the authorization will be added to the circuit but will not be enabled for use.
Examples
Example 1: Add an authorization to the specified ExpressRoute circuit
$Circuit = Get-AzureRmExpressRouteCircuit -Name "ContosoCircuit" -ResourceGroupName "ContosoResourceGroup"
Add-AzureRmExpressRouteCircuitAuthorization -Name "ContosoCircuitAuthorization" -Circuit $Circuit
Set-AzureRmExpressRouteCircuit -ExpressRouteCircuit $CircuitThe commands in this example add a new authorization to an existing ExpressRoute circuit. The first command uses Get-AzureRmExpressRouteCircuit to create an object reference to a circuit named ContosoCircuit. That object reference is stored in a variable named $Circuit. In the second command, the Add-AzureRmExpressRouteCircuitAuthorization cmdlet is used to add a new authorization (ContosoCircuitAuthorization) to the ExpressRoute circuit. This command adds the authorization but does not activate that authorization. Activating an authorization requires the Set-AzureRmExpressRouteCircuit shown in the final command in the example.
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 |
-ExpressRouteCircuit
Specifies the ExpressRoute circuit that this cmdlet adds the authorization to.
| Type: | PSExpressRouteCircuit |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Name
Specifies the name of the circuit authorization to be added.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
Parameters: ExpressRouteCircuit (ByValue)