Edit

Share via

Remove-WAPackStaticIPAddressPool

  • Reference
Module:
Azure

Removes static IP address pool objects.

Note

The cmdlets referenced in this documentation are for managing legacy Azure resources that use Azure Service Manager (ASM) APIs. This legacy PowerShell module isn't recommended when creating new resources since ASM is scheduled for retirement. For more information, see Azure Service Manager retirement.

The Az PowerShell module is the recommended PowerShell module for managing Azure Resource Manager (ARM) resources with PowerShell.

Syntax

Remove-WAPackStaticIPAddressPool
      -StaticIPAddressPool <StaticIPAddressPool>
      [-PassThru]
      [-Force]
      [-Profile <AzureSMProfile>]
      [<CommonParameters>]

Description

These topics are deprecated and will be removed in the future. This topic describes the cmdlet in the 0.8.1 version of the Microsoft Azure PowerShell module. To find out the version of the module you're using, from the Azure PowerShell console, type (Get-Module -Name Azure).Version.

The Remove-WAPackStaticIPAddressPool cmdlet removes static IP address pool objects.

Examples

Example 1: Remove a static IP address pool

PS C:\> $StaticIPAddressPool = Get-WAPackStaticIPAddressPool -Name "ContosoStaticIPAddressPool01"
PS C:\> Remove-WAPackStaticIPAddressPool -StaticIPAddressPool $StaticIPAddressPool

The first command gets the static IP address pool named ContosoStaticIPAddressPool01 by using the Get-WAPackStaticIPAddressPool cmdlet, and then stores that object in the $StaticIPAddressPool variable.

The second command removes the static IP address pool stored in $StaticIPAddressPool. The command prompts you for confirmation.

Example 2: Remove a static IP address pool without confirmation

PS C:\> $StaticIPAddressPool = Get-WAPackStaticIPAddressPool -Name "ContosoStaticIPAddressPool02"
PS C:\> Remove-WAPackStaticIPAddressPool -StaticIPAddressPool $StaticIPAddressPool -Force

The first command gets the static IP address pool named ContosoStaticIPAddressPool02 by using the Get-WAPackStaticIPAddressPool cmdlet, and then stores that object in the $ StaticIPAddressPool variable.

The second command removes the static IP address pool stored in $StaticIPAddressPool. This command includes the Force parameter. The command does not prompt you for confirmation.

Parameters

-Force

Forces the command to run without asking for user confirmation.

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

-PassThru

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

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

-Profile

Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.

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

-StaticIPAddressPool

Specifies a StaticIPAddressPool. To obtain a static IP address pool, use the Get-WAPackStaticIPAddressPool cmdlet.

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