az sql db ltr-backup

  • Preview
  • Reference

This command group is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage SQL database long term retention backups.

Commands

Name Description Type Status
az sql db ltr-backup delete

Delete a long term retention backup.

 Core Preview
az sql db ltr-backup list

List the long term retention backups for a location, server or database.

 Core Preview
az sql db ltr-backup restore

Restore a long term retention backup to a new database.

 Core Preview
az sql db ltr-backup show

Get a long term retention backup for a database.

 Core Preview
az sql db ltr-backup wait

Place the CLI in a waiting state until a condition of the database is met.

 Core Preview

az sql db ltr-backup delete

Edit
Preview

Command group 'sql db ltr-backup' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Delete a long term retention backup.

az sql db ltr-backup delete --database
                            --location
                            --name
                            --server
                            [--yes]

Examples

Delete long term retention backup for database.

az sql db ltr-backup delete -l southeastasia -s myserver -d mydb -n "3214b3fb-fba9-43e7-96a3-09e35ffcb336;132292152080000000"

Required Parameters

--database -d

Name of the Azure SQL Database. If specified (along with server name), retrieves all requested backups under this database.

--location -l

The location of the desired backups.

--name -n

The name of the LTR backup. Use 'az sql db ltr-backup show' or 'az sql db ltr-backup list' for backup name.

--server -s

Name of the Azure SQL Server. If specified, retrieves all requested backups under this server.

Optional Parameters

--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 sql db ltr-backup list

Edit
Preview

Command group 'sql db ltr-backup' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List the long term retention backups for a location, server or database.

az sql db ltr-backup list --location
                          [--database]
                          [--database-state]
                          [--latest]
                          [--resource-group]
                          [--server]

Examples

List long term retention backups for a database.

az sql db ltr-backup list -l southeastasia -s myserver -d mydb

List long term retention backups for a server (list only the latest LTR backups, which belong to live databases).

az sql db ltr-backup list -l southeastasia -s myserver --database-state Live --only-latest-per-database True

List long term retention backups for a server (with resource group argument).

az sql db ltr-backup list -l southeastasia -g mygroup -s myserver

List long term retention backups for a location (list only the latest LTR backups, which belong to live databases).

az sql db ltr-backup list -l southeastasia --database-state Live --only-latest-per-database True

List long term retention backups for a location (with resource group argument).

az sql db ltr-backup list -l southeastasia -g mygroup

Required Parameters

--location -l

The location of the desired backups.

Optional Parameters

--database -d

Name of the Azure SQL Database. If specified (along with server name), retrieves all requested backups under this database.

--database-state --state

'All', 'Live', or 'Deleted'. Will fetch backups only from databases of specified state. If no state provied, defaults to 'All'.

--latest --only-latest-per-database

If true, will only return the latest backup for each database.

--resource-group -g

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

--server -s

Name of the Azure SQL Server. If specified, retrieves all requested backups under this server.

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 sql db ltr-backup restore

Edit
Preview

Command group 'sql db ltr-backup' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Restore a long term retention backup to a new database.

az sql db ltr-backup restore --backup-id
                             --dest-database
                             --dest-resource-group
                             --dest-server
                             [--assign-identity {false, true}]
                             [--auto-pause-delay]
                             [--availability-zone]
                             [--backup-storage-redundancy]
                             [--capacity]
                             [--compute-model {Provisioned, Serverless}]
                             [--edition]
                             [--elastic-pool]
                             [--encryption-protector]
                             [--encryption-protector-auto-rotation {false, true}]
                             [--family]
                             [--federated-client-id]
                             [--ha-replicas]
                             [--keys]
                             [--license-type {BasePrice, LicenseIncluded}]
                             [--min-capacity]
                             [--no-wait]
                             [--preferred-enclave-type {Default, VBS}]
                             [--read-scale {Disabled, Enabled}]
                             [--service-level-objective]
                             [--tags]
                             [--umi]
                             [--zone-redundant {false, true}]

Examples

Restore LTR backup.

az sql db ltr-backup restore \
--dest-database targetdb --dest-server myserver --dest-resource-group mygroup \
--backup-id "/subscriptions/6caa113c-794c-42f8-ab9d-878d8aa104dc/resourceGroups/mygroup/providers/Microsoft.Sql/locations/southeastasia/longTermRetentionServers/myserver/longTermRetentionDatabases/sourcedb/longTermRetentionBackups/3214b3fb-fba9-43e7-96a3-09e35ffcb336;132292152080000000"

Required Parameters

--backup-id

The resource id of the long term retention backup to be restored. Use 'az sql db ltr-backup show' or 'az sql db ltr-backup list' for backup id.

--dest-database

Name of the database that will be created as the restore destination.

--dest-resource-group

Name of the resource group of the server to restore database to.

--dest-server

Name of the server to restore database to.

Optional Parameters

--assign-identity -i

Assign identity for database.

accepted values: false, true
--auto-pause-delay

Time in minutes after which database is automatically paused. A value of -1 means that automatic pause is disabled.

--availability-zone

Availability zone.

--backup-storage-redundancy --bsr

Backup storage redundancy used to store backups. Allowed values include: Local, Zone, Geo, GeoZone.

--capacity -c

The capacity component of the sku in integer number of DTUs or vcores.

--compute-model

The compute model of the database.

accepted values: Provisioned, Serverless
--edition --tier -e

The edition component of the sku. Allowed values include: Basic, Standard, Premium, GeneralPurpose, BusinessCritical, Hyperscale.

--elastic-pool

The name or resource id of the elastic pool to create the database in.

--encryption-protector

Specifies the Azure key vault key to be used as database encryption protector key.

--encryption-protector-auto-rotation --epauto

Specifies the database encryption protector key auto rotation flag. Can be either true, false or null.

accepted values: false, true
--family -f

The compute generation component of the sku (for vcore skus only). Allowed values include: Gen4, Gen5.

--federated-client-id

The federated client id for the SQL Database. It is used for cross tenant CMK scenario.

--ha-replicas --read-replicas

The number of high availability replicas to provision for the database. Only settable for Hyperscale edition.

--keys

The list of AKV keys for the SQL Database.

--license-type

The license type to apply for this database.LicenseIncluded if you need a license, or BasePriceif you have a license and are eligible for the Azure HybridBenefit.

accepted values: BasePrice, LicenseIncluded
--min-capacity

Minimal capacity that database will always have allocated, if not paused.

--no-wait

Do not wait for the long-running operation to finish.

default value: False
--preferred-enclave-type

Specifies type of enclave for this resource.

accepted values: Default, VBS
--read-scale

If enabled, connections that have application intent set to readonly in their connection string may be routed to a readonly secondary replica. This property is only settable for Premium and Business Critical databases.

accepted values: Disabled, Enabled
--service-level-objective --service-objective

The service objective for the new database. For example: Basic, S0, P1, GP_Gen4_1, GP_S_Gen5_8, BC_Gen5_2, HS_Gen5_32.

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

--umi --user-assigned-identity-id

The list of user assigned identity for the SQL Database.

--zone-redundant -z

Specifies whether to enable zone redundancy. Default is true if no value is specified.

accepted values: false, true
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 sql db ltr-backup show

Edit
Preview

Command group 'sql db ltr-backup' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Get a long term retention backup for a database.

az sql db ltr-backup show --database
                          --location
                          --name
                          --server

Examples

Show long term retention backup for a database.

az sql db ltr-backup show -l southeastasia -s myserver -d mydb -n "3214b3fb-fba9-43e7-96a3-09e35ffcb336;132292152080000000;Hot"

Required Parameters

--database -d

Name of the Azure SQL Database. If specified (along with server name), retrieves all requested backups under this database.

--location -l

The location of the desired backups.

--name -n

The name of the LTR backup. Use 'az sql db ltr-backup show' or 'az sql db ltr-backup list' for backup name.

--server -s

Name of the Azure SQL Server. If specified, retrieves all requested backups under this server.

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 sql db ltr-backup wait

Edit
Preview

Command group 'sql db ltr-backup' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Place the CLI in a waiting state until a condition of the database is met.

az sql db ltr-backup wait [--created]
                          [--custom]
                          [--deleted]
                          [--exists]
                          [--expand]
                          [--filter]
                          [--ids]
                          [--interval]
                          [--name]
                          [--resource-group]
                          [--server]
                          [--subscription]
                          [--timeout]
                          [--updated]

Optional Parameters

--created

Wait until created with 'provisioningState' at 'Succeeded'.

default value: False
--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Wait until deleted.

default value: False
--exists

Wait until the resource exists.

default value: False
--expand

The child resources to include in the response. Default value is None.

--filter

An OData filter expression that filters elements in the collection. Default value is None.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--interval

Polling interval in seconds.

default value: 30
--name -n

Name of the Azure SQL Database.

--resource-group -g

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

--server -s

Name of the Azure SQL Server. You can configure the default using az configure --defaults sql-server=<name>.

--subscription

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

--timeout

Maximum wait in seconds.

default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

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.