Set-​Azure​Affinity​Group

Modifies properties of an affinity group.

Syntax

Set-AzureAffinityGroup
   [-Name] <String>
   [-Description <String>]
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   -Label <String>
   [-Profile <AzureSMProfile>]
   [<CommonParameters>]

Description

The Set-AzureAffinityGroup cmdlet modifies properties of an Azure affinity group. You can change the label and the description.

Examples

Example 1: Modify an affinity group

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

This command modifies the label of the affinity group named South01 to be SouthUSProduction The command also modifies the description.

Required Parameters

-Label

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

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Name

Specifies the name of the affinity group that this cmdlet modifies.

Type:String
Position:0
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Optional Parameters

-Description

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

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-InformationAction

Specifies how this cmdlet responds to an information event.

The acceptable values for this parameter are:

  • Continue
  • Ignore
  • Inquire
  • SilentlyContinue
  • Stop
  • Suspend
Type:ActionPreference
Aliases:infa
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-InformationVariable

Specifies an information variable.

Type:String
Aliases:iv
Position:Named
Default value:None
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
Accept pipeline input:False
Accept wildcard characters:False