az sql db geo-backup
Manage SQL database geo redundant backups.
Commands
Name | Description | Type | Status |
---|---|---|---|
az sql db geo-backup list |
Gets a list of recoverable databases. |
Core | GA |
az sql db geo-backup restore |
Restore a geo-redundant backup to a new database. |
Core | GA |
az sql db geo-backup show |
Gets a recoverable database, which is a resource representing a database's geo backup. |
Core | GA |
az sql db geo-backup list
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
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.
Retrieves all requested geo-redundant backups under this resource group.
Retrieves all requested geo-redundant backups under this server.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
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.
az sql db geo-backup restore
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
Name of the database that will be created as the restore destination.
Name of the server to restore database to.
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.
Name of the target resource group of the server to restore database to.
Optional Parameters
Assign identity for database.
Time in minutes after which database is automatically paused. A value of -1 means that automatic pause is disabled.
Availability zone.
Backup storage redundancy used to store backups. Allowed values include: Local, Zone, Geo, GeoZone.
The capacity component of the sku in integer number of DTUs or vcores.
The compute model of the database.
The edition component of the sku. Allowed values include: Basic, Standard, Premium, GeneralPurpose, BusinessCritical, Hyperscale.
The name or resource id of the elastic pool to create the database in.
Specifies the Azure key vault key to be used as database encryption protector key.
Specifies the database encryption protector key auto rotation flag. Can be either true, false or null.
The compute generation component of the sku (for vcore skus only). Allowed values include: Gen4, Gen5.
The federated client id for the SQL Database. It is used for cross tenant CMK scenario.
The number of high availability replicas to provision for the database. Only settable for Hyperscale edition.
The list of AKV keys for the SQL Database.
The license type to apply for this database.LicenseIncluded
if you need a license, or BasePrice
if you have a license and are eligible for the Azure HybridBenefit.
Minimal capacity that database will always have allocated, if not paused.
Specifies type of enclave for this resource.
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.
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.
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
The list of user assigned identity for the SQL Database.
Specifies whether to enable zone redundancy. Default is true if no value is specified.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
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.
az sql db geo-backup show
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
Retrieves a requested geo-redundant backup under this database.
Expand the AKV keys for the database.
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.
Expand the AKV keys for the database.
Retrieves a requested geo-redundant backup under this resource group.
Retrieves a requested geo-redundant backup under this server.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
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.