Get-AzExpressRouteCircuitAuthorizationKey
Gets the authorization key for an ExpressRoute circuit authorization.
Syntax
ByName (Default)
Get-AzExpressRouteCircuitAuthorizationKey
-ResourceGroupName <String>
-CircuitName <String>
-Name <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
ByParentObject
Get-AzExpressRouteCircuitAuthorizationKey
-ExpressRouteCircuit <PSExpressRouteCircuit>
-Name <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
The Get-AzExpressRouteCircuitAuthorizationKey cmdlet retrieves the authorization key for an authorization on an ExpressRoute circuit.
The authorization key is a secret and is masked by Get-AzExpressRouteCircuitAuthorization.
This cmdlet performs a live listKeys action against the service to return the current
authorization key so that an ExpressRoute connection owner can consume it.
Examples
Example 1: Get the authorization key by name
Get-AzExpressRouteCircuitAuthorizationKey -ResourceGroupName "ContosoResourceGroup" -CircuitName "ContosoCircuit" -Name "ContosoCircuitAuthorization"
AuthorizationKey
----------------
10d01cd7-0b67-4c44-88ca-51e7effa452d
This command returns the authorization key for the authorization named ContosoCircuitAuthorization on the ExpressRoute circuit ContosoCircuit.
Example 2: Get the authorization key from a circuit object
$circuit = Get-AzExpressRouteCircuit -Name "ContosoCircuit" -ResourceGroupName "ContosoResourceGroup"
$circuit | Get-AzExpressRouteCircuitAuthorizationKey -Name "ContosoCircuitAuthorization"
AuthorizationKey
----------------
10d01cd7-0b67-4c44-88ca-51e7effa452d
The first command gets the ExpressRoute circuit ContosoCircuit and stores it in the variable $circuit. The second command pipes that circuit to Get-AzExpressRouteCircuitAuthorizationKey to retrieve the authorization key.
Parameters
-CircuitName
The name of the ExpressRoute circuit.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | ExpressRouteCircuitName |
Parameter sets
ByName
| Position: | Named |
| Mandatory: | True |
| 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 |
-ExpressRouteCircuit
The ExpressRoute circuit object.
Parameter properties
| Type: | PSExpressRouteCircuit |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ByParentObject
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Name
The name of the authorization.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | AuthorizationName |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ResourceGroupName
The resource group name.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ByName
| Position: | Named |
| Mandatory: | True |
| 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.
