Restore Azure BizTalk Service from Backup
Updated: January 4, 2016
This topic provides information on how to restore BizTalk Services from a service backup. You can upgrade the edition as part of the restore. The following restore upgrades are supported:
Basic edition can be restored to Standard edition.
Basic edition can be restored to Premium edition.
Standard edition can be restored to Premium.
Important |
|---|
You cannot restore the Developer or Free editions of BizTalk Services. |
An edition cannot be downgraded. For example, the Premium edition cannot be restored to Standard, Basic, or Developer editions. The Standard edition cannot be restored to the Basic or Developer editions. The Basic edition cannot be restored to the Developer edition.
Note |
|---|
You cannot backup the Developer and Free editions of BizTalk Services. Hence, they cannot be restored as well. |
This section provides information about the request operation to restore BizTalk Services.
Method | Request URI | HTTP Version | ||
|---|---|---|---|---|
PUT | https://management.core.windows.net/{subscription-id}/cloudservices/{cloud-service-name}/resources/biztalkservices/biztalk/{resource-name} where,
| HTTP/1.1 |
Header | Description |
|---|---|
Content-Type | Required. Set this to application/xml. |
x-ms-version | 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. |
x-ms-client-request-id | Required. 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. |
If-Match | Required. If an Etag value is passed for this header, Azure matches the value with the Etag for the resource. |
PUT HYPERLINK "https://managment.core.windows.net/%3csubscription-id%3e/cloudservices/mycloudservice1/resources/biztalkservices" https://management.core.windows.net/<subscription-id>/cloudservices/mycloudservice1/resources/biztalkservices/biztalk/mybiztalkservice HTTP/1.1
Content-Type: application/xml; charset=utf-8
x-ms-version: 2013-04-26
If-Match: <Etag>
<Resource xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<SchemaVersion>1.0</SchemaVersion>
<Plan></Plan>
<IntrinsicSettings>
<ServiceSettings>
<ServiceBackupSettings>
<BackupStoreConnectionString>BlobEndpoint=blobendpoint;QueueEndpoint=queueendpoint;TableEndpoint=tableendpoint;AccountName=accountname;AccountKey=accountkey;DefaultEndpointsProtocol=https</BackupStoreConnectionString>
<BackupName>backup-2012-21-02</BackupName>
</ServiceBackupSettings>
<CustomDomainUrl>example.com</CustomDomainUrl>
<Edition>Premium</Edition>
<ServiceCertificate>
<Data>{certificate-in-serialized-form}</Data>
<Password>{password}</Password>
</ServiceCertificate>
<TrackingStoreConnectionString>Data Source=tcp:databaseservername.database.windows.net;Initial Catalog=databasename;Integrated Security=False;User ID=user1@databaseservername;Password=mypassword;Asynchronous Processing=True;Encrypt=True;TrustServerCertificate=False</TrackingStoreConnectionString>
<ArchivingStoreConnectionString>BlobEndpoint=blobendpoint;QueueEndpoint=queueendpoint;TableEndpoint=tableendpoint;AccountName=accountname;AccountKey=accountkey;DefaultEndpointsProtocol=https</ArchivingStoreConnectionString>
<MonitoringStoreConnectionString>BlobEndpoint=blobendpoint;QueueEndpoint=queueendpoint;TableEndpoint=tableendpoint;AccountName=accountname;AccountKey=accountkey;DefaultEndpointsProtocol=https</MonitoringStoreConnectionString>
<ServiceAcsParameters>
<Namespace>acssample</Namespace>
<ManagementUserName>user</ManagementUserName>
<ManagementPassword>password=</ManagementPassword>
</ServiceAcsParameters>
</ServiceSettings>
</IntrinsicSettings>
</Resource>
The following table describes the key elements in the request body.
Element Name | Description | ||
|---|---|---|---|
SchemaVersion | Required. Schema version of the intrinsic settings. Set this to 1.0. | ||
Plan | Required. Leave this element empty. | ||
IntrinsicSettings (Settings used to provision or configure BizTalk Services) | |||
ServiceBackupSettings/BackupStoreConnectionString | Required. Represents the store in which BizTalk Services backup is created. The specified backup store must already exist. | ||
ServiceBackupSettings/BackupName | Required. Represents the backup in the specified backup store from which the service needs to be restored. You must adhere to the following considerations when providing a backup name:
| ||
CustomDomainUrl | Required. This represents a custom endpoint for message processing and should not be more than 256 characters in length. If no value is provided, this is set to <BizTalkServiceName>.biztalk.windows.net. | ||
Edition | Required. Represents the edition of BizTalk Services. Set this to Basic, Standard, Developer, or Premium. These values are case-sensitive.
| ||
ServiceCertificate/Data | Required. Represents the BizTalk Services certificate (.pfx format) in a serialized form. | ||
ServiceCertificate/Password | Required. Represents the BizTalk Services certificate private key password. | ||
TrackingStoreConnectionString | Required. Represents a Microsoft Azure SQL Database connection string which BizTalk Services uses to write tracking records to. The specified database should already exist and must be in the same region as the BizTalk Services resource.
| ||
ArchivingStoreConnectionString | Required. Represents the Azure storage connection string which BizTalk Services uses to write archiving records to (if the edition supports). The specified storage account should already exist and must be in the same region as the BizTalk Services resource.
| ||
MonitoringStoreConnectionString | Required. Represents the Azure storage connection string which BizTalk Services uses to write monitoring records to. The specified storage account should already exist and must be in the same region as the BizTalk Services resource.
| ||
ServiceAcsParameters/Namespace | Required. Represents the ACS namespace with which BizTalk Services is configured as the relying party. The specified ACS namespace must be in the same region as the BizTalk Services. | ||
ServiceAcsParameters/ManagementUserName | Required. Represents the management user of the specified ACS namespace. | ||
ServiceAcsParameters/ManagementPassword | Required. Represents the password of the management user of the specified ACS namespace. | ||
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.
Header | Description |
|---|---|
Content-Type | Specifies the content type. |
x-ms-request-id | A value that uniquely identifies a request made against the application service. |
ETag | On successful mutations to the resource, Service Manager returns a unique increasing ETag to identify the revision on the resource |
None.
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 | Description |
|---|---|---|
InvalidBackupStore | Restore failed. One or more of the service settings specified are not allowed for a restore 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. |
InvalidBackupName | Restore failed. Either the specified backup could not be found or the backup has been corrupted. | - |
RestoreEditionDowngradeNotAllowed | Restore failed. Edition downgrade is not supported during the restore. | You might encounter this error if you downgrade the edition while doing a restore. You can only upgrade an edition during restore. For more information, see BizTalk Services: Developer, Basic, Standard and Premium Editions Chart. |
RestoreVersionChangeNotAllowed | Restore failed. Service version update is not allowed during the restore. | |
RestoreUnitCountChangeNotAllowed | Restore failed. Unit count change is not allowed during the restore. |
During a restore, you specify the ACS Namespace and key, SQL database, and storage account. If you don't provide these properties, their values are retrieved from the backup content. Such values are not validated. If the parameters in the backup content have been removed from the BizTalk Services settings, the restore operation does not detect that they have been deleted, and as a result, the restore fails.
User-provided input is validated during the restore operation. To validate the parameters, enter the ACS namespace and key, SQL database, and storage account details while doing the restore.

