Share via

Get-AzureAffinityGroup

  • Article

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

Get-AzureAffinityGroup

Returns an object that represents a Windows Azure affinity group.

Parameter Set: Default
Get-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 Get-AzureAffinityGroup cmdlet returns an affinity group object that includes the affinity group name, location, label, description and the storage and hosted services that are part of the affinity group.

-Name<String>

Affinity Group name. A name is assigned to the affinity group at the time of creation. Note that names for affinity groups created through the Management Portal are typically GUIDs and that the UI shows its label.

Aliases

none

Required?

false

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.

  • AffinityGroup

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

This example list the properties of the "MyGroup1" affinity group.

C:\PS>Get-AzureAffinityGroup -Name "MyGroup1"