Share via


Remove-AzureAffinityGroup

[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]

Remove-AzureAffinityGroup

Deletes an affinity group in the specified subscription.

Parameter Set: Default
Remove-AzureAffinityGroup [-Name] <String> [ <CommonParameters>]

This topic describes the cmdlet in the .6.19 version of the Windows Azure PowerShell module. To find out the version of the module you're using, from the Windows Azure PowerShell console, type (get-module azure).version.

The Remove-AzureAffinityGroup cmdlet deletes an affinity group in the subscription. You can't delete an affinity group that has any members. You must first delete all the members of an affinity group and then use Remove-AzureAffinityGroup to delete the affinity group.

-Name<String>

Specifies the name of the affinity group to delete.

Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see  about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

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

This command deletes the 'South1' affinity group in the current subscription.

C:\PS>Remove-AzureAffinityGroup -name "South1" 

Get-AzureAffinityGroup

New-AzureAffinityGroup

Set-AzureAffinityGroup