Share via


Get Affinity Group Properties

 

The Get Affinity Group Properties operation returns the system properties that are associated with the specified affinity group.

Request

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.

Method

Request URI

GET

https://management.core.windows.net/<subscription-id>/affinitygroups/<affinity-group-name>

URI Parameters

None.

Request Headers

The following table describes the request headers.

Request Header

Description

x-ms-version

Required. Specifies the version of the operation to use for this request. This header should be set to 2009-10-01 or higher.

Request Body

None.

Response

The response includes an HTTP status code, a set of response headers, and a response body.

Status Code

A successful operation returns status code 200 (OK).

Response Headers

The response for this operation includes the following headers. The response may also include additional standard HTTP headers.

Response Header

Description

x-ms-request-id

A value that uniquely identifies a request made against the management service.

Response Body

The format of the response body is as follows:

<?xml version="1.0" encoding="utf-8"?>
<AffinityGroup xmlns="https://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.

Element name

Description

Name

Specifies the user name of the affinity group.

Label

Specifies the base-64-encloded identifier of the affinity group.

Description

Specifies the description of this affinity group.

Location

Specifies the location of the data center in which the affinity group is associated.

Url

The URL of the cloud service that is associated with the affinity group.

ServiceName

The name of the cloud service that is associated with the affinity group.

Url

The URL of the storage account that is associated with the affinity group.

ServiceName

The name of the storage account that is associated with the affinity group.

Capability

Specifies the capabilities that of the affinity group.

Possible values are:

  • PersistentVMRole

  • HighMemory

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.

CreatedTime

Specifies in UTC format when the affinity group was created.

The CreatedTime element is only available using version 2014-01-01 or higher.