Create Affinity Group

 

The Create Affinity Group operation creates a new affinity group for the specified subscription.

Request

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

Method

Request URI

POST

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

URI Parameters

None.

Request Headers

The following table describes the request headers.

Request Header

Description

content_type

Required. Set this header to application/xml.

x-ms-version

Required. Specifies the version of the operation to use for this request. This header should be set to 2011-02-25 or higher.

Request Body

The format of the request body is as follows:

<?xml version="1.0" encoding="utf-8"?>
<CreateAffinityGroup xmlns="https://schemas.microsoft.com/windowsazure">
      <Name>affinity-group-name</Name>
      <Label>base64-encoded-affinity-group-label</Label>
      <Description>affinity-group-description</Description>
      <Location>location</Location>
</CreateAffinityGroup>

The following table describes the elements of the request body.

Element Name

Description

Name

Required. A name for the affinity group that is unique to the subscription.

Label

Required. A base-64 encoded name for the affinity group. The name can be up to 100 characters in length.

Description

Optional. A description for the affinity group. The description can be up to 1024 characters in length.

Location

Required. The data center location where the affinity group will be created. To list available locations, use the List Locations operation.

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 201 (Created).

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

None.

Remarks

If the value of x-ms-version is 2012-03-01 or later, an affinity group cannot be created in the Anywhere US, Anywhere Europe, or Anywhere Asia regions.