Remove-AzPeeringServicePrefix

Reference

Module:: Az.Peering

Deletes an existing prefix with the specified name under the given subscription, resource group and peering service.

Syntax

Remove-AzPeeringServicePrefix
      -Name <String>
      -PeeringServiceName <String>
      -ResourceGroupName <String>
      [-SubscriptionId <String>]
      [-DefaultProfile <PSObject>]
      [-PassThru]
      [-Confirm]
      [-WhatIf]
      [<CommonParameters>]

Remove-AzPeeringServicePrefix
      -InputObject <IPeeringIdentity>
      [-DefaultProfile <PSObject>]
      [-PassThru]
      [-Confirm]
      [-WhatIf]
      [<CommonParameters>]

Description

Deletes an existing prefix with the specified name under the given subscription, resource group and peering service.

Examples

Example 1: Remove peering service prefix

Remove-AzPeeringServicePrefix -Name TestPrefix -PeeringServiceName TestDRInterCloudZurich -ResourceGroupName DemoRG

Removes peering service prefix from peering

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DefaultProfile

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

Type:	PSObject
Aliases:	AzureRMContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

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

-Name

The name of the prefix.

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

-PassThru

Returns true when the command succeeds

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

-PeeringServiceName

The name of the peering service.

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

-ResourceGroupName

The name of the resource group.

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

-SubscriptionId

The Azure subscription ID.

Type:	String
Position:	Named
Default value:	(Get-AzContext).Subscription.Id
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

IPeeringIdentity

Outputs

Boolean

Notes

ALIASES

COMPLEX PARAMETER PROPERTIES

To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.

INPUTOBJECT <IPeeringIdentity>: Identity Parameter

[ConnectionMonitorTestName <String>]: The name of the connection monitor test
[Id <String>]: Resource identity path
[PeerAsnName <String>]: The peer ASN name.
[PeeringName <String>]: The name of the peering.
[PeeringServiceName <String>]: The name of the peering service.
[PrefixName <String>]: The name of the prefix.
[RegisteredAsnName <String>]: The name of the registered ASN.
[RegisteredPrefixName <String>]: The name of the registered prefix.
[ResourceGroupName <String>]: The name of the resource group.
[SubscriptionId <String>]: The Azure subscription ID.