< Back

Set-AzureAffinityGroup

Wed Jan 30, 2019 5:53 pm

NAME Set-AzureAffinityGroup



SYNOPSIS

Modifies properties of an affinity group.





SYNTAX

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

[-InformationVariable <String>] [<CommonParameters>]





DESCRIPTION

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





PARAMETERS

-Name <String>

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



Required? true

Position? 0

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Label <String>

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



Required? true

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Description <String>

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



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Profile <AzureSMProfile>

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



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-InformationAction <ActionPreference>





Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-InformationVariable <String>





Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS



NOTES









-------------------------- 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.



RELATED LINKS

Get-AzureAffinityGroup

New-AzureAffinityGroup

Remove-AzureAffinityGroup