Get Affinity Group Properties
Updated: June 7, 2012
The Get Affinity Group Properties operation returns the system properties associated with the specified affinity group.
Request
The Get Affinity Group Properties request may be specified as follows. Replace <subscription-id> with your subscription ID, and <affinity-group-name> with the name of the desired affinity group as returned by the name element of the List Affinity Groups operation:
| Method | Request URI | HTTP Version |
|---|---|---|
|
GET |
|
HTTP/1.1 |
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 later. For more information about versioning headers, see Service Management Versioning. |
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). For information about status codes, see Service Management Status and Error Codes.
Response Headers
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. |
Response Body
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>
</AffinityGroup>
The following table describes the key elements of the response body:
| Element name | Description |
|---|---|
|
Name |
The user supplied name of the affinity group. |
|
Label |
The user supplied label of the affinity group returned as a base-64 encoded string. |
|
Description |
The user supplied description of this affinity group. |
|
Location |
The location of the data center that the affinity group is associated with. |
|
Url |
The Service Management API request URI used to perform Get Hosted Service Properties requests against the hosted service. |
|
ServiceName |
The name of the hosted service. |
|
Url |
The Service Management API request URI used to perform Get Storage Account Properties requests against the storage account. |
|
ServiceName |
The user supplied name of the storage account. |
|
Capability |
Indicates if the virtual machine related operations can be performed in this affinity group. If so, the string PersistentVMRole will be returned by this element. Otherwise, this element will not be present. The Capability element is only available using version 2012-03-01 or higher. |
Authorization
Any management certificate associated with the subscription specified by <subscription-id> can be used to authenticate this operation. For additional details, see Authenticating Service Management Requests.
Remarks
If the x-ms-version is 2012-03-01 or later and the affinity group was created in one of the deprecated Anywhere US, Anywhere Europe, Anywhere Asia regions, the Location element will return the location where this affinity group is allocated.
