Remove-AzExpressRouteCircuitAuthorization

  • Reference
Module:
Az.Network

Removes an existing ExpressRoute configuration authorization.

Syntax

Remove-AzExpressRouteCircuitAuthorization
      [-Name <String>]
      -ExpressRouteCircuit <PSExpressRouteCircuit>
      [-DefaultProfile <IAzureContextContainer>]
      [<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

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with azure.

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ExpressRouteCircuit

Specifies the ExpressRouteCircuit object that this cmdlet removes.

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 that this cmdlet removes.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

PSExpressRouteCircuit

Outputs

PSExpressRouteCircuit