Backup BizTalk Service


Updated: January 4, 2016

This topic provides information on how to back up the configuration and all artifacts in the specified BizTalk Services. You must suspend the BizTalk Services before starting the backup using the REST API. For more information, see Suspend BizTalk Service.


You cannot backup the Developer or Free editions of BizTalk Services.

This section provides information about the request operation to back up the specified BizTalk Services.


Request URI

HTTP Version



  • subscription-id is your Azure subscription ID

  • cloud-service-name is the unique name for the cloud service that hosts your BizTalk Service. The name can be up to 64 characters in length.

  • resource-name is the unique name for the BizTalk Services subscription.

  • comp=backup specifies the backup operation to be performed on BizTalk Services.


All parameters are required.





Required. Set this to application/xml.


Required. Specifies the version of the operation to use for this request. The value of this header must be set to 2012-08-01 or later.


Optional. Specifies an ID to identify the request. This can be useful in troubleshooting client issues end-to-end and is passed to the BizTalk Services resource provider.


Optional. If an Etag value is passed for this header for an update operation, Azure matches the value with the Etag for the resource.

POST<subscription-id>}/cloudservices/mycloudservice1/resources/biztalkservices/biztalk/mybiztalkservice?comp=backup HTTP/1.1
Content-Type: application/xml; charset=utf-8 
x-ms-version: 2013-04-26
If-Match: {Etag}



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

Element Name



Required. Represents the store in which BizTalk Services backup is created. The specified backup store must already exist.


Required. Represents the backup name which can later be used while restoring the service. You must adhere to the following considerations when providing a backup name:

  • Backup name must start with a letter or number, and can contain only letters, numbers, and the dash (-) character.

  • Every dash (-) character must be immediately preceded and followed by a letter or number; consecutive dashes are not permitted in container names.

  • All letters in a container name must be lowercase.

  • Length of container names can be between 3 and 63 characters.

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

A successful operation returns status code 202 (ACCEPTED).

For information about status codes, see Service Management Status and Error Codes.




Specifies the content type.


A value that uniquely identifies a request made against the application service.


If there is an error response, the format of the response body is the same as shown at Service Management Status and Error Codes.

This section lists the error codes that you might encounter while performing backup operations on BizTalk Services.

Error Code

Error String



Backup failed. One or more of the service settings specified are not allowed for backup operation. Please refer to the product documentation on the allowed values and updatable settings.

You might encounter this error when the specified backup store is not a valid Azure storage account.


Backup failed. The backup container in the specified storage account already contains data. Please delete the container or remove all contents inside the container.



Backup failed. Backup name specified is not allowed. Please refer to the product documentation on the allowed values for backup names.