SALES: 1-800-867-1380

List Affinity Groups

Updated: May 12, 2014

The List Affinity Groups operation lists the affinity groups that are associated with the specified subscription.

The List Affinity Groups request may be specified as follows. Replace <subscription-id> with the subscription ID.

 

Method Request URI

GET

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

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.

 

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. 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 202 (Accepted). 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.

 

Response Header Description

x-ms-request-id

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"?>
  <AffinityGroups xmlns="http://schemas.microsoft.com/windowsazure">
    <AffinityGroup>
      <Name>affinity-group-name</Name>
      <Label>base64-encoded-label</Label>
      <Description>description</Description>
      <Location>location</Location>  
      <Capabilities>
        <Capability>affinity-group-capability</Capability>
      </Capabilities>
      <CreatedTime>creation-time-of-affinity-group</CreatedTime>
      <ComputeCapabilities>
        <VirtualMachineRoleSizes>
          <RoleSize>role-size-name</RoleSize>
        </VirtualMachineRoleSizes>
        <WebWorkerRoleSizes>
          <RoleSize>role-size-name</RoleSize>
        </WebWorkerRoleSizes>
      </ComputeCapabilities>
    </AffinityGroup>
  </AffinityGroups>

The following table describes the elements of the response body.

 

Element name Description

Name

Specifies the name of the affinity group.

Label

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

Description

Specified the description of this affinity group.

Location

Specifies the data center in which the affinity group is located.

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. For more information about Virtual Machines sizes, see Virtual Machine and Cloud Service Sizes for Azure

CreatedTime

Specifies in UTC format when the affinity group was created.

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

ComputeCapabilities

Specifies the roles sizes that are available for deployments in the affinity group. Deployments of web roles and worker roles may have different sizes available than deployments of Virtual Machines. For more information about role sizes, see Virtual Machine and Cloud Service Sizes for Windows Azure.

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

Specifies the roles sizes that are available for deployments in the affinity group.

 

Element name Description

VirtualMachineRoleSizes

Contains a collection of RoleSize elements.

WebWorkerRoleSizes

Contains a collection of RoleSize elements.

RoleSize

Specifies the role size that is available for the type of deployment.

You can also use the following resources to manage affinity groups:

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft