Share via


Set-AzureAffinityGroup

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

Set-AzureAffinityGroup

Updates the properties of a Windows Azure affinity group.

Parameter Set: Default
Set-AzureAffinityGroup [-Name] <String> -Label <String> [-Description <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 Set-AzureAffinityGroup cmdlet updates properties of the specified affinity group. The properties that can be changed are the Label and the Description.

-Description<String>

Specifies the description of the affinity group. The description can be up to 1024 characters in length.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Label<String>

Specifies a label for the affinity group. The label can be up to 100 characters in length.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Name<String>

Specifies the name of the affinity group to change the properties of.

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 sets the label of the affinity group MyGroup1 to "SouthUSProduction" and sets the description to "Production applications for Southern US locations"

C:\PS>Set-AzureAffinityGroup -Name "MyGroup1" -Label "SouthUSProduction" -Description "Production applications for Southern US locations" 

Get-AzureAffinityGroup

New-AzureAffinityGroup

Remove-AzureAffinityGroup