az webapp config backup
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
URL with SAS token to the blob storage container.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
The name of the web app.
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Name of the backup. If unspecified, the backup will be named with the web app name and a timestamp.
Connection string for the database in the backup.
Property | Value |
---|---|
Parameter group: | Database Arguments |
Name of the database in the backup.
Property | Value |
---|---|
Parameter group: | Database Arguments |
Type of database in the backup.
Property | Value |
---|---|
Parameter group: | Database Arguments |
Accepted values: | LocalMySql, MySql, PostgreSql, SqlAzure |
The name of the slot. Default to the productions slot if not specified.
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
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
Id of the backup.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
The name of the web app.
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
The name of the slot.
Do not prompt for confirmation.
Property | Value |
---|---|
Default value: | False |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
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
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
The name of the web app.
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
The name of the slot. Default to the productions slot if not specified.
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
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
Name of the backup to restore.
URL with SAS token to the blob storage container.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
The name of the web app.
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Connection string for the database in the backup.
Property | Value |
---|---|
Parameter group: | Database Arguments |
Name of the database in the backup.
Property | Value |
---|---|
Parameter group: | Database Arguments |
Type of database in the backup.
Property | Value |
---|---|
Parameter group: | Database Arguments |
Accepted values: | LocalMySql, MySql, PostgreSql, SqlAzure |
Ignores custom hostnames stored in the backup.
Overwrite the source web app, if --target-name is not specified.
The name of the slot. Default to the productions slot if not specified.
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
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
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
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
The name of the web app.
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
The name of the slot. Default to the productions slot if not specified.
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
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
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
The name of the web app.
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Name of the backup. If unspecified, the backup will be named with the web app name and a timestamp.
URL with SAS token to the blob storage container.
Connection string for the database in the backup.
Property | Value |
---|---|
Parameter group: | Database Arguments |
Name of the database in the backup.
Property | Value |
---|---|
Parameter group: | Database Arguments |
Type of database in the backup.
Property | Value |
---|---|
Parameter group: | Database Arguments |
Accepted values: | LocalMySql, MySql, PostgreSql, SqlAzure |
How often to backup. Use a number followed by d or h, e.g. 5d = 5 days, 2h = 2 hours.
Always keep one backup, regardless of how old it is.
Property | Value |
---|---|
Accepted values: | false, true |
How many days to keep a backup before automatically deleting it. Set to 0 for indefinite retention.
The name of the slot. Default to the productions slot if not specified.
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |