< Back

Remove-AzureRmExpressRouteCircuitAuthorization

Tue Jan 29, 2019 9:57 pm

NAME Remove-AzureRmExpressRouteCircuitAuthorization



SYNOPSIS

Removes an existing ExpressRoute configuration authorization.





SYNTAX

Remove-AzureRmExpressRouteCircuitAuthorization [-DefaultProfile <IAzureContextContainer>] -ExpressRouteCircuit <PSExpressRouteCircuit> [-Name

<String>] [<CommonParameters>]





DESCRIPTION

The Remove-AzureRmExpressRouteCircuitAuthorization 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-AzureRmExpressRouteCircuitAuthorization 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.





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



Required? true

Position? named

Default value None

Accept pipeline input? True (ByValue)

Accept wildcard characters? false



-Name <String>

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



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

This cmdlet accepts pipelined instances of the Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit object.





OUTPUTS

PSExpressRouteCircuit

This cmdlet modifies existing instances of the Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit object.





NOTES









Example 1: Remove a circuit authorization from an ExpressRoute circuit



$Circuit = Get-AzureRmExpressRouteCircuit -Name "ContosoCircuit" -ResourceGroupName "ContosoResourceGroup"

Remove-AzureRmExpressRouteCircuitAuthorization -Name "ContosoCircuitAuthorization" -Circuit $Circuit

Set-AzureRmExpressRouteCircuit -ExpressRouteCircuit $Circuit



This example removes a circuit authorization from an ExpressRoute circuit. The first command uses the Get-AzureRmExpressRouteCircuit 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-AzureRmExpressRouteCircuit cmdlet to confirm the removal of the ExpressRoute circuit stored in the $Circuit

variable.







RELATED LINKS

Online Version: https://docs.microsoft.com/en-us/powers ... horization

Add-AzureRmExpressRouteCircuitAuthorization

Get-AzureRmExpressRouteCircuit

Get-AzureRmExpressRouteCircuitAuthorization

New-AzureRmExpressRouteCircuitAuthorization

Set-AzureRmExpressRouteCircuit