Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Remove-AzureBGPPeering

Remove-AzureBGPPeering

microsoft.windowsazure.commands.expressroute.dll

Synopsis

Removes the routing configuration for an ExpressRoute circuit.

Syntax

Remove-AzureBGPPeering [-ServiceKey] [-AccessType] [-Force] [-PassThru] [<CommonParameters>]

Detailed Description

The Remove-AzureBGPPeering cmdlet deletes the routing configuration of an ExpressRoute circuit. This cmdlet works only for circuits provisioned through an Internet Exchange Point service provider. This cmdlet does not work for ExpressRoute circuits established through a carrier.

Parameters

-ServiceKey <String>

Specifies the service key of the ExpressRoute circuit for which the routing configuration needs to be deleted.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

false

-AccessType <BgpPeeringAccessType>

Access type can be either Public or Private. Private (the default value) sets up a BGP session to be used with virtual networks. Public sets up a BGP session to be used to access public IP addresses in the service, including VIPs.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

false

-Force <SwitchParameter>

Forces the action without prompting the user for input.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-PassThru <SwitchParameter>

If -PassThru is specified, then a result is returned as True or False, depending on whether the command succeeded or not.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type


Return Type


Notes

Examples

-------------------------- Example 1 --------------------------

This command removes the routing configuration for the ExpressRoute circuit with service key "12345678-1234-1234-abcd-1234567890ab".

PS C:\> C:\PS>Remove-AzureBGPPeering -ServiceKey "12345678-1234-1234-abcd-1234567890ab"

Get-AzureBGPPeering
Get-AzureDedicatedCircuit
Get-AzureDedicatedCircuitLink
Get-AzureDedicatedCircuitServiceProvider
New-AzureBGPPeering
New-AzureDedicatedCircuit
New-AzureDedicatedCircuitLink
Remove-AzureBGPPeering
Remove-AzureDedicatedCircuitLink
Set-AzureBGPPeering