مشاركة عبر

az sql db geo-backup

  • Preview
  • Reference

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

Manage SQL database geo redundant backups.

Commands

Name Description Type Status
az sql db geo-backup list

Gets a list of recoverable databases.

 Core Preview
az sql db geo-backup restore

Restore a geo-redundant backup to a new database.

 Core Preview
az sql db geo-backup show

Gets a recoverable database, which is a resource representing a database's geo backup.

 Core Preview

az sql db geo-backup list

Edit
Preview

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

Gets a list of recoverable databases.

az sql db geo-backup list [--ids]
                          [--resource-group]
                          [--server]
                          [--subscription]

Examples

Gets a list of recoverable databases.

az sql db geo-backup list -s myserver -g mygroup

Optional Parameters

--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.

--resource-group -g

Retrieves all requested geo-redundant backups under this resource group.

--server --server-name -s

Retrieves all requested geo-redundant backups under this server.

--subscription

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

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 geo-backup restore

Edit
Preview

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

Restore a geo-redundant backup to a new database.

az sql db geo-backup restore --dest-database
                             --dest-server
                             --geo-backup-id
                             --resource-group
                             [--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]
                             [--preferred-enclave-type {Default, VBS}]
                             [--read-scale {Disabled, Enabled}]
                             [--service-level-objective]
                             [--tags]
                             [--umi]
                             [--zone-redundant {false, true}]

Examples

Restore Geo-redundant backup.

az sql db geo-backup restore \
--dest-database targetdb --dest-server myserver --resource-group mygroup \
--geo-backup-id "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup/providers/Microsoft.Sql/servers/myserver/databases/mydb/geoBackupPolicies/Default"

Required Parameters

--dest-database

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

--dest-server

Name of the server to restore database to.

--geo-backup-id

The resource id of the geo-redundant backup to be restored. Use 'az sql db geo-backup list' or 'az sql db geo-backup show' for backup id.

--resource-group

Name of the target resource group 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.

--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 geo-backup show

Edit
Preview

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

Gets a recoverable database, which is a resource representing a database's geo backup.

az sql db geo-backup show [--database]
                          [--expand-keys {false, true}]
                          [--ids]
                          [--keys-filter]
                          [--resource-group]
                          [--server]
                          [--subscription]

Examples

Gets a recoverable database, which represents a database's geo backup.

az sql db geo-backup show --server myserver --database mydb --resource-group mygroup

Optional Parameters

--database --database-name -d

Retrieves a requested geo-redundant backup under this database.

--expand-keys

Expand the AKV keys for the database.

Accepted values: false, true
Default value: False
--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.

--keys-filter

Expand the AKV keys for the database.

--resource-group -g

Retrieves a requested geo-redundant backup under this resource group.

--server --server-name -s

Retrieves a requested geo-redundant backup under this server.

--subscription

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

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.