BizTalk Services: Backup and Restore

Important

Microsoft Azure BizTalk Services (MABS) is being retired, and replaced with Azure Logic Apps. If you currently use MABS, then Move from BizTalk Services to Logic Apps provides some guidance on moving your integration solutions to Logic Apps.

If you're brand new to Logic Apps, then we suggest getting started here:

Azure BizTalk Services includes Backup and Restore capabilities.

Important

The portal is deprecated. To manage your MABS instances, see REST API for Managing BizTalk Services on Azure.

Note

Hybrid Connections are NOT backed up, regardless of the Edition. You must recreate your hybrid connections.

Before you Begin

  • Backup and Restore may not be available for all editions. See BizTalk Services: Editions Chart.
  • Backup content can be restored to the same BizTalk Service or to a new BizTalk Service. To restore the BizTalk Service using the same name, the existing BizTalk Service must be deleted and the name must be available. After you delete a BizTalk Service, it can take longer time than wanted for the same name to be available. If you cannot wait for the same name to be available, then restore to a new BizTalk Service.
  • BizTalk Services can be restored to the same edition or a higher edition. Restoring BizTalk Services to a lower edition, from when the backup was taken, is not supported.

    For example, a backup using the Basic Edition can be restored to the Premium Edition. A backup using the Premium Edition cannot be restored to the Standard Edition.

  • The EDI Control numbers are backed up to maintain continuity of the control numbers. If messages are processed after the last backup, restoring this backup content can cause duplicate control numbers.
  • If a batch has active messages, process the batch before running a backup. When creating a backup (as needed or scheduled), messages in batches are never stored.

    If a backup is taken with active messages in a batch, these messages are not backed up and are therefore lost.

  • Optional: In the BizTalk Services Portal, stop any management operations.

Create a backup

A backup can be taken at any time and is completely controlled by you. To create a backup, use the REST API for Managing BizTalk Services on Azure.

Restore

To restore a backup, use the REST API for Managing BizTalk Services on Azure.

After restoring a backup

The BizTalk Service is always restored in a Suspended state. In this state, you can make any configuration changes before the new environment is functional, including:

  • If you created BizTalk Service applications using the Azure BizTalk Services SDK, you may need to to update the Access Control (ACS) credentials in those applications to work with the restored environment.
  • You restore a BizTalk Service to replicate an existing BizTalk Service environment. In this situation, if there are agreements configured in the original BizTalk Services portal that use a source FTP folder, you may need to update the agreements in the newly restored environment to use a different source FTP folder. Otherwise, there may be two different agreements trying to pull the same message.
  • If you restored to have multiple BizTalk Service environments, make sure you target the correct environment in the Visual Studio applications, PowerShell cmdlets, REST APIs, or Trading Partner Management OM APIs.
  • It's a good practice to configure automated backups on the newly restored BizTalk Service environment.

What gets backed up

When a backup is created, the following items are backed up:

Items backed up
Azure BizTalk Services Portal
Configuration and Runtime
  • Partner and profile details
  • Partner Agreements
  • Custom assemblies deployed
  • Bridges deployed
  • Certificates
  • Transforms deployed
  • Pipelines
  • Templates created and saved in the BizTalk Services Portal
  • X12 ST01 and GS01 mappings
  • Control numbers (EDI)
  • AS2 Message MIC values
Azure BizTalk Service
SSL Certificate
  • SSL Certificate Data
  • SSL Certificate Password
BizTalk Service Settings
  • Scale unit count
  • Edition
  • Product Version
  • Region/Datacenter
  • Access Control Service (ACS) namespace and key
  • Tracking database connection string
  • Archiving Storage account connection string
  • Monitoring storage account connection string
Additional Items
Tracking Database When the BizTalk Service is created, the Tracking Database details are entered, including the Azure SQL Database Server and the Tracking Database name. The Tracking Database is not automatically backed up.

Important
If the Tracking Database is deleted and the database needs recovered, a previous backup must exist. If a backup does not exist, the Tracking Database and its data are not recoverable. In this situation, create a new Tracking Database with the same database name. Geo-Replication is recommended.

Next

To create Azure BizTalk Services, go to BizTalk Services: Provisioning. To start creating applications, go to Azure BizTalk Services.

See Also