Get Affinity Group Properties
Updated: July 10, 2015
The Get Affinity Group Properties operation returns the system properties that are associated with the specified affinity group. You can get a list of affinity groups by using List Affinity Groups.
The Get Affinity Group Properties request may be specified as follows. Replace <subscription-id> with the subscription ID, and <affinity-group-name> with the name of the affinity group.
You must make sure that the request that is made to the management service is secure. For additional details, see Authenticating Service Management Requests.
The following table describes the request headers.
Required. Specifies the version of the operation to use for this request. This header should be set to 2009-10-01 or higher. For more information about versioning headers, see Service Management Versioning.
The response includes an HTTP status code, a set of response headers, and a response body.
A successful operation returns status code 200 (OK). For information about status codes, see Service Management Status and Error Codes.
The response for this operation includes the following headers. The response may also include additional standard HTTP headers. All standard headers conform to the HTTP/1.1 protocol specification.
A value that uniquely identifies a request made against the management service.
The format of the response body is as follows:
<?xml version="1.0" encoding="utf-8"?> <AffinityGroup xmlns="http://schemas.microsoft.com/windowsazure"> <Name>name-of-affinity-group</Name> <Label>base64-encoded-label</Label> <Description>description</Description> <Location>location</Location> <HostedServices> <HostedService> <Url>hosted-service-address</Url> <ServiceName>hosted-service-name</ServiceName> </HostedService> </HostedServices> <StorageServices> <StorageService> <Url>storage-account-address</Url> <ServiceName>storage-account-name</ServiceName> </StorageService> </StorageServices> <Capabilities> <Capability>affinity-group-capability</Capability> </Capabilities> <CreatedTime>creation-time-of-affinity-group</CreatedTime> </AffinityGroup>
The following table describes the elements of the response body.
Specifies the user name of the affinity group.
Specifies the base-64-encloded identifier of the affinity group.
Specifies the description of this affinity group.
Specifies the location of the data center in which the affinity group is associated.
The URL of the cloud service that is associated with the affinity group.
The name of the cloud service that is associated with the affinity group.
The URL of the storage account that is associated with the affinity group.
The name of the storage account that is associated with the affinity group.
Specifies the capabilities that of the affinity group.
Possible values are:
The capabilities of an affinity group are typically derived from its location. An affinity group may show a reduced set of capabilities if the specific set of resources assigned to support the affinity group do not support a capability, for example high-memory Virtual Machines. The PersistentVMRole capability enables an affinity group to support Virtual Machines. The HighMemory capability enables the affinity group to support Virtual Machines that use high memory relative to the number of CPUs. For more information about Virtual Machines sizes, see Virtual Machine and Cloud Service Sizes for Azure
Specifies in UTC format when the affinity group was created.
The CreatedTime element is only available using version 2014-01-01 or higher.