Edit

Remove-AzExpressRouteCircuitAuthorization

Module:
Az.Network Module

Removes an existing ExpressRoute configuration authorization.

Syntax

Default (Default) 

Remove-AzExpressRouteCircuitAuthorization
    [-Name <String>]
    -ExpressRouteCircuit <PSExpressRouteCircuit>
    [-DefaultProfile <IAzureContextContainer>]
    [-AcquirePolicyToken]
    [-ChangeReference <String>]
    [<CommonParameters>]

Description

The Remove-AzExpressRouteCircuitAuthorization cmdlet removes an authorization assigned to an ExpressRoute circuit. ExpressRoute circuits connect your on-premises network to Azure 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. There can only be one authorization per virtual network. At any time, however, the circuit owner can use Remove-AzExpressRouteCircuitAuthorization to remove the authorization assigned to a virtual network. When that happens the corresponding virtual network is no longer able to use the ExpressRoute circuit to connect to Azure.

Examples

Example 1: Remove a circuit authorization from an ExpressRoute circuit

$Circuit = Get-AzExpressRouteCircuit -Name "ContosoCircuit" -ResourceGroupName "ContosoResourceGroup"
Remove-AzExpressRouteCircuitAuthorization -Name "ContosoCircuitAuthorization" -ExpressRouteCircuit $Circuit
Set-AzExpressRouteCircuit -ExpressRouteCircuit $Circuit

This example removes a circuit authorization from an ExpressRoute circuit. The first command uses the Get-AzExpressRouteCircuit cmdlet to create an object reference to an ExpressRoute circuit named ContosoCircuit and stores the result in the variable named $Circuit. The second command marks the circuit authorization ContosoCircuitAuthorization for removal. The third command uses the Set-AzExpressRouteCircuit cmdlet to confirm the removal of the ExpressRoute circuit stored in the $Circuit variable.

Parameters

-AcquirePolicyToken

Acquire an Azure Policy token automatically for this resource operation.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ChangeReference

The change reference resource ID for this resource operation.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
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

Specifies the ExpressRouteCircuit object that this cmdlet removes.

Parameter properties

Type:PSExpressRouteCircuit
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-Name

Specifies the name of the circuit authorization that this cmdlet removes.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
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.

Inputs

PSExpressRouteCircuit

Outputs

PSExpressRouteCircuit