Share via

az webapp config backup

  • Reference

Manage backups for web apps.

Commands

Name Description Type Status
az webapp config backup create

Create a backup of a web app.

 Core GA
az webapp config backup delete

Delete a web app backup.

 Core GA
az webapp config backup list

List backups of a web app.

 Core GA
az webapp config backup restore

Restore a web app from a backup.

 Core GA
az webapp config backup show

Show the backup schedule for a web app.

 Core GA
az webapp config backup update

Configure a new backup schedule for a web app.

 Core GA

az webapp config backup create

Create a backup of a web app.

az webapp config backup create --container-url
                               --resource-group
                               --webapp-name
                               [--backup-name]
                               [--db-connection-string]
                               [--db-name]
                               [--db-type {LocalMySql, MySql, PostgreSql, SqlAzure}]
                               [--slot]

Examples

Create a backup of a web app. (autogenerated)

az webapp config backup create --container-url {container-url} --resource-group MyResourceGroup --webapp-name MyWebapp

Required Parameters

--container-url

URL with SAS token to the blob storage container.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--webapp-name

The name of the web app.

Optional Parameters

--backup-name

Name of the backup. If unspecified, the backup will be named with the web app name and a timestamp.

--db-connection-string

Connection string for the database in the backup.

--db-name

Name of the database in the backup.

--db-type

Type of database in the backup.

Accepted values: LocalMySql, MySql, PostgreSql, SqlAzure
--slot -s

The name of the slot. Default to the productions slot if not specified.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az webapp config backup delete

Delete a web app backup.

az webapp config backup delete --backup-id
                               --resource-group
                               --webapp-name
                               [--slot]
                               [--yes]

Required Parameters

--backup-id

Id of the backup.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--webapp-name

The name of the web app.

Optional Parameters

--slot -s

The name of the slot.

--yes -y

Do not prompt for confirmation.

Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az webapp config backup list

List backups of a web app.

az webapp config backup list --resource-group
                             --webapp-name
                             [--slot]

Examples

List backups of a web app. (autogenerated)

az webapp config backup list --resource-group MyResourceGroup --webapp-name MyWebapp

Required Parameters

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--webapp-name

The name of the web app.

Optional Parameters

--slot -s

The name of the slot. Default to the productions slot if not specified.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az webapp config backup restore

Restore a web app from a backup.

az webapp config backup restore --backup-name
                                --container-url
                                --resource-group
                                --webapp-name
                                [--db-connection-string]
                                [--db-name]
                                [--db-type {LocalMySql, MySql, PostgreSql, SqlAzure}]
                                [--ignore-hostname-conflict]
                                [--overwrite]
                                [--slot]
                                [--target-name]

Required Parameters

--backup-name

Name of the backup to restore.

--container-url

URL with SAS token to the blob storage container.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--webapp-name

The name of the web app.

Optional Parameters

--db-connection-string

Connection string for the database in the backup.

--db-name

Name of the database in the backup.

--db-type

Type of database in the backup.

Accepted values: LocalMySql, MySql, PostgreSql, SqlAzure
--ignore-hostname-conflict

Ignores custom hostnames stored in the backup.

--overwrite

Overwrite the source web app, if --target-name is not specified.

--slot -s

The name of the slot. Default to the productions slot if not specified.

--target-name

The name to use for the restored web app. If unspecified, will default to the name that was used when the backup was created.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az webapp config backup show

Show the backup schedule for a web app.

az webapp config backup show --resource-group
                             --webapp-name
                             [--slot]

Examples

Show the backup schedule for a web app. (autogenerated)

az webapp config backup show --resource-group MyResourceGroup --webapp-name MyWebapp

Required Parameters

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--webapp-name

The name of the web app.

Optional Parameters

--slot -s

The name of the slot. Default to the productions slot if not specified.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az webapp config backup update

Configure a new backup schedule for a web app.

az webapp config backup update --resource-group
                               --webapp-name
                               [--backup-name]
                               [--container-url]
                               [--db-connection-string]
                               [--db-name]
                               [--db-type {LocalMySql, MySql, PostgreSql, SqlAzure}]
                               [--frequency]
                               [--retain-one {false, true}]
                               [--retention]
                               [--slot]

Required Parameters

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--webapp-name

The name of the web app.

Optional Parameters

--backup-name

Name of the backup. If unspecified, the backup will be named with the web app name and a timestamp.

--container-url

URL with SAS token to the blob storage container.

--db-connection-string

Connection string for the database in the backup.

--db-name

Name of the database in the backup.

--db-type

Type of database in the backup.

Accepted values: LocalMySql, MySql, PostgreSql, SqlAzure
--frequency

How often to backup. Use a number followed by d or h, e.g. 5d = 5 days, 2h = 2 hours.

--retain-one

Always keep one backup, regardless of how old it is.

Accepted values: false, true
--retention

How many days to keep a backup before automatically deleting it. Set to 0 for indefinite retention.

--slot -s

The name of the slot. Default to the productions slot if not specified.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.