How to back up and restore a server in Azure Database for MySQL using the Azure CLI

Backup happens automatically

Azure Database for MySQL servers are backed up periodically to enable Restore features. Using this feature you may restore the server and all its databases to an earlier point-in-time, on a new server.

Prerequisites

To complete this how-to guide, you need:

Open Azure Cloud Shell

Azure Cloud Shell is a free, interactive shell that you can use to run the steps in this article. Common Azure tools are preinstalled and configured in Cloud Shell for you to use with your account. Just select the Copy button to copy the code, paste it in Cloud Shell, and then press Enter to run it. There are a few ways to open Cloud Shell:

Select Try It in the upper-right corner of a code block. Cloud Shell in this article
Open Cloud Shell in your browser. https://shell.azure.com/bash
Select the Cloud Shell button on the menu in the upper-right corner of the Azure portal. Cloud Shell in the portal

Important

This how-to guide requires that you use Azure CLI version 2.0 or later. To confirm the version, at the Azure CLI command prompt, enter az --version. To install or upgrade, see Install Azure CLI.

Set backup configuration

You make the choice between configuring your server for either locally redundant backups or geographically redundant backups at server creation.

Note

After a server is created, the kind of redundancy it has, geographically redundant vs locally redundant, can't be switched.

While creating a server via the az mysql server create command, the --geo-redundant-backup parameter decides your Backup Redundancy Option. If Enabled, geo redundant backups are taken. Or if Disabled locally redundant backups are taken.

The backup retention period is set by the parameter --backup-retention.

For more information about setting these values during create, see the Azure Database for MySQL server CLI Quickstart.

The backup retention period of a server can be changed as follows:

az mysql server update --name mydemoserver --resource-group myresourcegroup --backup-retention 10

The preceding example changes the backup retention period of mydemoserver to 10 days.

The backup retention period governs how far back in time a point-in-time restore can be retrieved, since it's based on backups available. Point-in-time restore is described further in the next section.

Server point-in-time restore

You can restore the server to a previous point in time. The restored data is copied to a new server, and the existing server is left as is. For example, if a table is accidentally dropped at noon today, you can restore to the time just before noon. Then, you can retrieve the missing table and data from the restored copy of the server.

To restore the server, use the Azure CLI az mysql server restore command.

Run the restore command

To restore the server, at the Azure CLI command prompt, enter the following command:

az mysql server restore --resource-group myresourcegroup --name mydemoserver-restored --restore-point-in-time 2018-03-13T13:59:00Z --source-server mydemoserver

The az mysql server restore command requires the following parameters:

Setting Suggested value Description
resource-group myresourcegroup The resource group where the source server exists.
name mydemoserver-restored The name of the new server that is created by the restore command.
restore-point-in-time 2018-03-13T13:59:00Z Select a point in time to restore to. This date and time must be within the source server's backup retention period. Use the ISO8601 date and time format. For example, you can use your own local time zone, such as 2018-03-13T05:59:00-08:00. You can also use the UTC Zulu format, for example, 2018-03-13T13:59:00Z.
source-server mydemoserver The name or ID of the source server to restore from.

When you restore a server to an earlier point in time, a new server is created. The original server and its databases from the specified point in time are copied to the new server.

The location and pricing tier values for the restored server remain the same as the original server.

After the restore process finishes, locate the new server and verify that the data is restored as expected.

Geo restore

If you configured your server for geographically redundant backups, a new server can be created from the backup of that existing server. This new server can be created in any region that Azure Database for MySQL is available.

To create a server using a geo redundant backup, use the Azure CLI az mysql server georestore command.

Note

When a server is first created it may not be immediately available for geo restore. It may take a few hours for the necessary metadata to be populated.

To geo restore the server, at the Azure CLI command prompt, enter the following command:

az mysql server georestore --resource-group myresourcegroup --name mydemoserver-georestored --source-server mydemoserver --location eastus --sku-name GP_Gen4_8 

This command creates a new server called mydemoserver-georestored in East US that will belong to myresourcegroup. It is a General Purpose, Gen 4 server with 8 vCores. The server is created from the geo-redundant backup of mydemoserver, which is also in the resource group myresourcegroup

If you want to create the new server in a different resource group from the existing server, then in the --source-server parameter you would qualify the server name as in the following example:

az mysql server georestore --resource-group newresourcegroup --name mydemoserver-georestored --source-server "/subscriptions/$<subscription ID>/resourceGroups/$<resource group ID>/providers/Microsoft.DBforMySQL/servers/mydemoserver" --location eastus --sku-name GP_Gen4_8

The az mysql server georestore command requies the following parameters:

Setting Suggested value Description
resource-group myresourcegroup The name of the resource group the new server will belong to.
name mydemoserver-georestored The name of the new server.
source-server mydemoserver The name of the existing server whose geo redundant backups are used.
location eastus The location of the new server.
sku-name GP_Gen4_8 This parameter sets the pricing tier, compute generation, and number of vCores of the new server. GP_Gen4_8 maps to a General Purpose, Gen 4 server with 8 vCores.

Important

When creating a new server by a geo restore, it inherits the same storage size and pricing tier as the source server. These values cannot be changed during creation. After the new server is created, its storage size can be scaled up.

After the restore process finishes, locate the new server and verify that the data is restored as expected.

Next steps