< Back
Get-AzureRmExpressRouteCircuitAuthorization
Post
NAME Get-AzureRmExpressRouteCircuitAuthorization
SYNOPSIS
Gets information about ExpressRoute circuit authorizations.
SYNTAX
Get-AzureRmExpressRouteCircuitAuthorization [-DefaultProfile <IAzureContextContainer>] -ExpressRouteCircuit <PSExpressRouteCircuit> [-Name
<String>] [<CommonParameters>]
DESCRIPTION
The Get-AzureRmExpressRouteCircuitAuthorization cmdlet gets information about the authorizations assigned 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). Authorization keys, as well as
other information about the authorization, can be viewed at any time by running Get-AzureRmExpressRouteCircuitAuthorization .
PARAMETERS
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ExpressRouteCircuit <PSExpressRouteCircuit>
Specifies the ExpressRoute circuit authorization.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-Name <String>
Specifies the name of the ExpressRoute circuit authorization that this cmdlet gets.
-Name "ContosoCircuitAuthorization"
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
PSExpressRouteCircuit
Get-AzureRmExpressRouteCircuitAuthorization accepts pipelined instances of the Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit
object.
OUTPUTS
PSExpressRouteCircuitAuthorization
Get-AzureRmExpressRouteCircuitAuthorization returns instances of the
Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuitAuthorization object.
NOTES
Example 1: Get all ExpressRoute authorizations
$Circuit = Get-AzureRmExpressRouteCircuit -Name "ContosoCircuit" -ResourceGroupName "ContosoResourceGroup"
Get-AzureRmExpressRouteCircuitAuthorization -Circuit $Circuit
These commands return information about all the ExpressRoute authorizations associated with an ExpressRoute circuit. The first command uses the
Get-AzureRmExpressRouteCircuit cmdlet to create an object reference a circuit named ContosoCircuit; that object reference is stored in the
variable $Circuit. The second command then uses that object reference and the Get-AzureRmExpressRouteCircuitAuthorization cmdlet to return
information about the authorizations associated with ContosoCircuit.
Example 2: Get all ExpressRoute authorizations using the Where-Object cmdlet
$Circuit = Get-AzureRmExpressRouteCircuit -Name "ContosoCircuit" -ResourceGroupName "ContosoResourceGroup"
Get-AzureRmExpressRouteCircuitAuthorization -Circuit $Circuit | Where-Object {$_.AuthorizationUseStatus -eq "Available"}
These commands represent a variation on the commands used in Example 1. In this case, however, information is returned only for those
authorizations that are available for use (that is, for authorizations that have not been assigned to a virtual network). To do this, the circuit
authorization information is returned in command 2 and is piped to the Where-Object cmdlet. Where-Object then picks out only those authorizations
where the AuthorizationUseStatus property is set to Available. To list only those authorizations that are not available, use this syntax for the
Where clause:
`{$_.AuthorizationUseStatus -ne "Available"}`
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... horization
Add-AzureRmExpressRouteCircuitAuthorization
Get-AzureRmExpressRouteCircuit
New-AzureRmExpressRouteCircuitAuthorization
Remove-AzureRmExpressRouteCircuitAuthorization
SYNOPSIS
Gets information about ExpressRoute circuit authorizations.
SYNTAX
Get-AzureRmExpressRouteCircuitAuthorization [-DefaultProfile <IAzureContextContainer>] -ExpressRouteCircuit <PSExpressRouteCircuit> [-Name
<String>] [<CommonParameters>]
DESCRIPTION
The Get-AzureRmExpressRouteCircuitAuthorization cmdlet gets information about the authorizations assigned 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). Authorization keys, as well as
other information about the authorization, can be viewed at any time by running Get-AzureRmExpressRouteCircuitAuthorization .
PARAMETERS
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ExpressRouteCircuit <PSExpressRouteCircuit>
Specifies the ExpressRoute circuit authorization.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-Name <String>
Specifies the name of the ExpressRoute circuit authorization that this cmdlet gets.
-Name "ContosoCircuitAuthorization"
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
PSExpressRouteCircuit
Get-AzureRmExpressRouteCircuitAuthorization accepts pipelined instances of the Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit
object.
OUTPUTS
PSExpressRouteCircuitAuthorization
Get-AzureRmExpressRouteCircuitAuthorization returns instances of the
Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuitAuthorization object.
NOTES
Example 1: Get all ExpressRoute authorizations
$Circuit = Get-AzureRmExpressRouteCircuit -Name "ContosoCircuit" -ResourceGroupName "ContosoResourceGroup"
Get-AzureRmExpressRouteCircuitAuthorization -Circuit $Circuit
These commands return information about all the ExpressRoute authorizations associated with an ExpressRoute circuit. The first command uses the
Get-AzureRmExpressRouteCircuit cmdlet to create an object reference a circuit named ContosoCircuit; that object reference is stored in the
variable $Circuit. The second command then uses that object reference and the Get-AzureRmExpressRouteCircuitAuthorization cmdlet to return
information about the authorizations associated with ContosoCircuit.
Example 2: Get all ExpressRoute authorizations using the Where-Object cmdlet
$Circuit = Get-AzureRmExpressRouteCircuit -Name "ContosoCircuit" -ResourceGroupName "ContosoResourceGroup"
Get-AzureRmExpressRouteCircuitAuthorization -Circuit $Circuit | Where-Object {$_.AuthorizationUseStatus -eq "Available"}
These commands represent a variation on the commands used in Example 1. In this case, however, information is returned only for those
authorizations that are available for use (that is, for authorizations that have not been assigned to a virtual network). To do this, the circuit
authorization information is returned in command 2 and is piped to the Where-Object cmdlet. Where-Object then picks out only those authorizations
where the AuthorizationUseStatus property is set to Available. To list only those authorizations that are not available, use this syntax for the
Where clause:
`{$_.AuthorizationUseStatus -ne "Available"}`
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... horization
Add-AzureRmExpressRouteCircuitAuthorization
Get-AzureRmExpressRouteCircuit
New-AzureRmExpressRouteCircuitAuthorization
Remove-AzureRmExpressRouteCircuitAuthorization