The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

0 out of 4 rated this helpful - Rate this topic

Change Deployment Configuration

Updated: June 7, 2012

The Change Deployment Configuration operation initiates a change to the deployment configuration.

The Change Deployment Configuration operation is an asynchronous operation. To determine whether the Management service has finished processing the request, call Get Operation Status. For more information on asynchronous operations, see Tracking Asynchronous Service Management Requests.

Request

The Change Deployment Configuration request may be specified as follows. Note that you can change the configuration of a deployment either by specifying the deployment environment (staging or production), or by specifying the unique name of the deployment.

To generate the request URI, replace <subscription-id> with your subscription ID, <cloudservice-name> with the name of the cloud service, <deployment-slot> with staging or production, and <deployment-name> with the unique name of your deployment.

Method	Request URI	HTTP Version
POST	`https://management.core.windows.net/<subscription-id>/services/hostedservices/<cloudservice-name>/deploymentslots/<deployment-slot>/?comp=config`	HTTP/1.1
POST	`https://management.core.windows.net/<subscription-id>/services/hostedservices/<cloudservice-name>/deployments/<deployment-name>/?comp=config`	HTTP/1.1

URI Parameters

URI Parameter	Description
comp=config	Required. Specifies that a change must be made to the configuration of the deployment.

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 2009-10-01 or later. For more information about versioning headers, see Service Management Versioning.

Request Body

The format of the request body is as follows:


<?xml version="1.0" encoding="utf-8"?>
<ChangeConfiguration xmlns="http://schemas.microsoft.com/windowsazure">
  <Configuration>base-64-encoded-configuration-file</Configuration>
  <TreatWarningsAsError>true|false</TreatWarningsAsError>
  <Mode>Auto|Manual</Mode>
  <ExtendedProperties>
    <ExtendedProperty>
      <Name>property-name</Name>
      <Value>property-value</Value>
    </ExtendedProperty>
  </ExtendedProperties>
  <ExtensionConfiguration>
    <AllRoles>
      <Extension>
        <Id>identifier-of-extension</Id>
      </Extension>
      ...
    </AllRoles>
    <NamedRoles>
      <Role>
        <RoleName>role_name1</RoleName>
        <Extensions>
          <Extension>
            <Id>identifier-of-extension</Id>
          </Extension>
          ...
        </Extensions>
      </Role>
    </NamedRoles>
  </ExtensionConfiguration>
</ChangeConfiguration>

Important
The order of the elements in the request body is significant. If an element is required, it must appear in the XML in the order shown above.

The following table describes the key elements in the request body:

Element name	Description
Configuration	Required. The base-64 encoded service configuration file for the deployment.
TreatWarningsAsError	Optional. Possible values are: true false If not specified the default value is false. If set to true, the update will be blocked when warnings are encountered. The TreatWarningsAsError element is only available using version 2011-04-01 or higher.
Mode	Optional. Possible values are: Auto Manual If not specified the default value is Auto. If set to Manual, WalkUpgradeDomain must be called to apply the update. If set to Auto, the update is automatically applied to each update domain for the service. The Mode element is only available using version 2011-08-01 or higher.
Name	Optional. Represents the name of an extended cloud service property. Each extended property must have both a defined name and value. You can have a maximum of 25 extended property name and value pairs. The maximum length of the Name element is 64 characters, only alphanumeric characters and underscores are valid in the name, and it must start with a letter. Attempting to use other characters, starting with a non-letter character, or entering a name that is identical to that of another extended property owned by the same cloud service, will result in a status code 400 (Bad Request) error. The Name element is only available using version 2012-03-01 or higher.
Value	Optional. Represents the value of an extended cloud service property. Each extended property must have both a defined name and value. You can have a maximum of 25 extended property name and value pairs, and each extended property value has a maximum length of 255 characters. You can delete an extended property by setting the value to NULL. The Value element is only available using version 2012-03-01 or higher.
ExtensionConfiguration	Optional. Represents an extension that is added to the cloud service. In Windows Azure, a process can run as an extension of a cloud service. For example, Remote Desktop Access or the Windows Azure Diagnostics Agent can run as extensions to the cloud service. You must add an extension to the cloud service by using Add Extension before it can be added to the deployment during a configuration change. The ExtensionConfiguration element is only available using version 2013-03-01 or higher.

ExtensionConfiguration

Represents an extension that is added to the cloud service.

Element name	Description
AllRoles	Optional. Specifies a list of extensions that are applied to all roles in a deployment.
Extension	Required. Represents an extension that is to be deployed to a role in a cloud service.
NamedRoles	Optional. Specifies a list of extensions that are applied to specific roles in a deployment.

Extension

Represents an extension that is to be deployed to a role in a cloud service.

Element name	Description
Id	Required. The identifier of the extension. The identifier is created when the extension is added to the cloud service. You can find the Id of an extension that was added to a cloud service by using List Extensions.

NamedRoles

Specifies a list of extensions that are applied to specific roles in a deployment.

Element name	Description
Role	Required. Represents a specific role to which the extension is added.
RoleName	Required. Specifies the name of the role.
Extension	Required. Represents an extension that is to be deployed to a role in a cloud service.

Response

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

Because Change Deployment Configuration is an asynchronous operation, you must call Get Operation Status to determine whether the operation is complete, has failed, or is still in progress.

Status Code

Because Change Deployment Configuration is an asynchronous operation, it always returns status code 202 (Accept). To determine the status code for the operation once it is complete, call Get Operation Status. The status code is embedded in the response for this operation; if successful, it will be 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. For an asynchronous operation, you can call get operation status with the value of the header to determine whether the operation is complete, has failed, or is still in progress. See Tracking Asynchronous Service Management Requests for more information.

Response Body

None.

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

None.

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)