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.
Syntax
Parameter Set: Default
Remove-AzureAffinityGroup [-Name] <String> [ <CommonParameters>]
Detailed Description
This topic describes the cmdlet in the 0.8.10 version of the Microsoft Azure PowerShell module. To get the version of the module you're using, in the Azure PowerShell console, type (Get-Module -Name 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.
Parameters
-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.
Examples
-------------- Example 1 --------------
This command deletes the 'South1' affinity group in the current subscription.
C:\PS>Remove-AzureAffinityGroup -name "South1"