Walk Upgrade Domain
Updated: June 29, 2015
The Walk Upgrade Domain asynchronous operation specifies an update domain in which a role instance must be updated. For more information about updating role instances, see Update an Azure Service.
The Walk Upgrade Domain request may be specified as follows. replace <subscription-id> with the subscription ID, <cloudservice-name> with the name of the cloud service, <deployment-slot> with staging or production, and <deployment-name> with the name of the deployment.
You must make sure that the request that is made to the management service is secure. For additional details, see Authenticating Service Management Requests.
Required. Specifies that the role instances in a deployment are updated one update domain at a time during a manual in-place update.
The following table describes the request headers.
Required. Set this header to application/xml.
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 format of the request body is as follows:
<?xml version="1.0" encoding="utf-8"?> <WalkUpgradeDomain xmlns="http://schemas.microsoft.com/windowsazure"> <UpgradeDomain>update-domain-id</UpgradeDomain> </WalkUpgradeDomain>
The following table describes the elements in the request body.
Required. Specifies an integer value that identifies the update domain to update. Update domains are identified with a zero-based index: the first update domain has an ID of 0, the second has an ID of 1, and so on.
The response includes an HTTP status code and a set of response headers.
A successful operation returns status code 200 (OK). 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.
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.
By default, a service is deployed with five update domains, which are updated one at a time during an in-place update. For information on modifying the number of update domains in the service definition file, see Azure Service Definition Schema (.csdef File).
To perform a manual update of a deployment, proceed in this order:
Call Upgrade Deployment with the Mode element set to manual.
Call Walk Upgrade Domain to update each domain within the deployment. Update domains must be updated in order. For example, begin with domain 0, proceed to domain 1, and so on.
An update that adds or removes role instances will result in a configuration update to all roles that are deployed in the cloud service. Existing role instances need to be notified of new role instances so that all role instances can communicate together in the cloud service.
While an update is in progress, call Get Deployment to determine its status. If the update is in progress, Get Deployment returns an UpgradeStatus element that contains information about the update. If the update is complete, or if no update is in progress, then the UpgradeStatus element is null.