Update Affinity Group

 

The Update Affinity Group operation updates the label or the description for an affinity group in the specified subscription.

Request

The Update Affinity Group request may be specified as follows. Replace <subscription-id> with the subscription ID, and <affinity-group-name> with the name of your affinity group.

Method

Request URI

PUT

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

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"?>
<UpdateAffinityGroup xmlns="http://schemas.microsoft.com/windowsazure">
      <Label>base64-encoded-affinity-group-label</Label>
      <Description>affinity-group-description</Description>
</UpdateAffinityGroup>

The following table describes the elements of the request body.

Element Name

Description

Label

Optional. Specifies a name for the affinity specified as a base-64 encoded string. The label can be up to 100 characters in length.

Description

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

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

None.