通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

az sql db ltr-backup

管理 SQL 数据库长期保留备份。

命令

名称 说明 类型 Status
az sql db ltr-backup delete

删除长期保留备份。

 Core GA
az sql db ltr-backup list

列出位置、服务器或数据库的长期保留备份。

 Core GA
az sql db ltr-backup lock-time-based-immutability

锁定长期保留备份上基于时间的不可变性，以防止删除。

 Core Preview
az sql db ltr-backup remove-legal-hold-immutability

删除长期保留备份数据库的法律保留。

 Core Preview
az sql db ltr-backup remove-time-based-immutability

对长期保留备份禁用基于时间的不可变性。

 Core Preview
az sql db ltr-backup restore

将长期保留备份还原到新数据库。

 Core GA
az sql db ltr-backup set-legal-hold-immutability

设置长期保留备份数据库的法律保留。

 Core Preview
az sql db ltr-backup show

获取数据库的长期保留备份。

 Core GA
az sql db ltr-backup wait

将 CLI 置于等待状态，直到满足数据库条件。

 Core GA

az sql db ltr-backup delete

编辑

删除长期保留备份。

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

示例

删除数据库的长期保留备份。

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

必需参数

--database -d

Azure SQL 数据库的名称。 如果指定（以及服务器名称），则检索此数据库下的所有请求备份。

--location -l

所需备份的位置。

--name -n

LTR 备份的名称。 将“az sql db ltr-backup show”或“az sql db ltr-backup list”用于备份名称。

--server -s

Azure SQL Server 的名称。 如果指定，则检索此服务器下的所有请求备份。

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--yes -y

不要提示确认。

属性 值
默认值: False
全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

属性 值
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性 值
默认值: False
--output -o

输出格式。

属性 值
默认值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性 值
默认值: False

az sql db ltr-backup list

编辑

列出位置、服务器或数据库的长期保留备份。

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

示例

列出数据库的长期保留备份。

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

列出服务器的长期保留备份（仅列出属于实时数据库的最新 LTR 备份）。

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

列出服务器的长期保留备份（具有资源组参数）。

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

列出位置的长期保留备份（仅列出属于实时数据库的最新 LTR 备份）。

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

列出位置的长期保留备份（具有资源组参数）。

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

必需参数

--location -l

所需备份的位置。

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--database -d

Azure SQL 数据库的名称。 如果指定（以及服务器名称），则检索此数据库下的所有请求备份。

--database-state --state

“All”、“Live”或“Deleted”。 仅从处于指定状态的数据库提取备份。 如果没有状态支持，则默认为“全部”。

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

如果为 true，则仅返回每个数据库的最新备份。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。

--server -s

Azure SQL Server 的名称。 如果指定，则检索此服务器下的所有请求备份。

全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

属性 值
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性 值
默认值: False
--output -o

输出格式。

属性 值
默认值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性 值
默认值: False

az sql db ltr-backup lock-time-based-immutability

编辑
预览

此命令处于预览阶段，正在开发中。 参考和支持级别：https://aka.ms/CLI_refstatus

锁定长期保留备份上基于时间的不可变性，以防止删除。

az sql db ltr-backup lock-time-based-immutability --database
                                                  --location
                                                  --name
                                                  --server
                                                  [--resource-group]
                                                  [--yes]

示例

锁定数据库的长期保留备份。

az sql db ltr-backup lock-time-based-immutability -g mygroup -l southeastasia -s myserver -d mydb -n "3214b3fb-fba9-43e7-96a3-09e35ffcb336;132292152080000000"

必需参数

--database -d

Azure SQL 数据库的名称。 如果指定（以及服务器名称），则检索此数据库下的所有请求备份。

--location -l

所需备份的位置。

--name -n

LTR 备份的名称。 将“az sql db ltr-backup show”或“az sql db ltr-backup list”用于备份名称。

--server -s

Azure SQL Server 的名称。 如果指定，则检索此服务器下的所有请求备份。

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。

--yes -y

不要提示确认。

属性 值
默认值: False
全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

属性 值
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性 值
默认值: False
--output -o

输出格式。

属性 值
默认值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性 值
默认值: False
编辑
预览

此命令处于预览阶段，正在开发中。 参考和支持级别：https://aka.ms/CLI_refstatus

删除长期保留备份数据库的法律保留。

az sql db ltr-backup remove-legal-hold-immutability --database
                                                    --location
                                                    --name
                                                    --server
                                                    [--resource-group]
                                                    [--yes]

删除对数据库的长期保留备份的法律保留。

az sql db ltr-backup remove-legal-hold-immutability -g mygroup -l southeastasia -s myserver -d mydb -n "3214b3fb-fba9-43e7-96a3-09e35ffcb336;132292152080000000"
--database -d

Azure SQL 数据库的名称。 如果指定（以及服务器名称），则检索此数据库下的所有请求备份。

--location -l

所需备份的位置。

--name -n

LTR 备份的名称。 将“az sql db ltr-backup show”或“az sql db ltr-backup list”用于备份名称。

--server -s

Azure SQL Server 的名称。 如果指定，则检索此服务器下的所有请求备份。

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。

--yes -y

不要提示确认。

属性 值
默认值: False
全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

属性 值
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性 值
默认值: False
--output -o

输出格式。

属性 值
默认值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性 值
默认值: False

az sql db ltr-backup remove-time-based-immutability

编辑
预览

此命令处于预览阶段，正在开发中。 参考和支持级别：https://aka.ms/CLI_refstatus

对长期保留备份禁用基于时间的不可变性。

az sql db ltr-backup remove-time-based-immutability --database
                                                    --location
                                                    --name
                                                    --server
                                                    [--resource-group]
                                                    [--yes]

示例

对数据库的长期保留备份禁用基于时间的不可变性。

az sql db ltr-backup remove-time-based-immutability -g mygroup -l southeastasia -s myserver -d mydb -n "3214b3fb-fba9-43e7-96a3-09e35ffcb336;132292152080000000"

必需参数

--database -d

Azure SQL 数据库的名称。 如果指定（以及服务器名称），则检索此数据库下的所有请求备份。

--location -l

所需备份的位置。

--name -n

LTR 备份的名称。 将“az sql db ltr-backup show”或“az sql db ltr-backup list”用于备份名称。

--server -s

Azure SQL Server 的名称。 如果指定，则检索此服务器下的所有请求备份。

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。

--yes -y

不要提示确认。

属性 值
默认值: False
全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

属性 值
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性 值
默认值: False
--output -o

输出格式。

属性 值
默认值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性 值
默认值: False

az sql db ltr-backup restore

编辑

将长期保留备份还原到新数据库。

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 --bsr]
                             [--capacity]
                             [--compute-model {Provisioned, Serverless}]
                             [--edition --tier]
                             [--elastic-pool]
                             [--encryption-protector]
                             [--encryption-protector-auto-rotation --epauto {false, true}]
                             [--family]
                             [--federated-client-id]
                             [--ha-replicas --read-replicas]
                             [--keys]
                             [--license-type {BasePrice, LicenseIncluded}]
                             [--min-capacity]
                             [--no-wait]
                             [--preferred-enclave-type {Default, VBS}]
                             [--read-scale {Disabled, Enabled}]
                             [--service-level-objective --service-objective]
                             [--tags]
                             [--umi --user-assigned-identity-id]
                             [--zone-redundant {false, true}]

示例

还原 LTR 备份。

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"

必需参数

--backup-id

要还原的长期保留备份的资源 ID。 将“az sql db ltr-backup show”或“az sql db ltr-backup list”用于备份 ID。

--dest-database

将创建为还原目标的数据库的名称。

--dest-resource-group

要还原数据库的服务器资源组的名称。

--dest-server

要还原数据库的服务器的名称。

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--assign-identity -i

为数据库分配标识。

属性 值
接受的值: false, true
--auto-pause-delay

数据库自动暂停的时间（以分钟为单位）。 -1 值表示禁用自动暂停。

属性 值
Parameter group: Serverless offering Arguments
--availability-zone

可用性区域。

--backup-storage-redundancy --bsr

用于存储备份的备份存储冗余。 允许的值包括：Local、Zone、Geo、GeoZone。

--capacity -c

SKU 的容量组件（整数数为 DTU 或 vcore）。

属性 值
Parameter group: Performance Level (components) Arguments
--compute-model

数据库的计算模型。

属性 值
Parameter group: Serverless offering Arguments
接受的值: Provisioned, Serverless
--edition --tier -e

SKU 的版本组件。 允许的值包括：基本、标准、高级、GeneralPurpose、BusinessCritical、超大规模。

属性 值
Parameter group: Performance Level (components) Arguments
--elastic-pool

要在其中创建数据库的弹性池的名称或资源 ID。

属性 值
Parameter group: Performance Level Arguments
--encryption-protector

指定要用作数据库加密保护程序密钥的 Azure 密钥保管库密钥。

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

指定数据库加密保护程序密钥自动轮换标志。 可以是 true、false 或 null。

属性 值
接受的值: false, true
--family -f

SKU 的计算生成组件（仅适用于 vcore SKU）。 允许的值包括：Gen4、Gen5。

属性 值
Parameter group: Performance Level (components) Arguments
--federated-client-id

SQL 数据库的联合客户端 ID。 它用于跨租户 CMK 方案。

--ha-replicas --read-replicas

要为数据库预配的高可用性副本数。 仅适用于超大规模版本。

--keys

SQL 数据库的 AKV 密钥列表。

--license-type

要申请此数据库的许可证类型。如果需要许可证，LicenseIncluded 如果拥有许可证并且有资格使用 Azure HybridBenefit，BasePrice。

属性 值
接受的值: BasePrice, LicenseIncluded
--min-capacity

数据库始终分配的最小容量（如果未暂停）。

属性 值
Parameter group: Serverless offering Arguments
--no-wait

不等待长时间运行的操作完成。

属性 值
默认值: False
--preferred-enclave-type

指定此资源的 enclave 类型。

属性 值
接受的值: Default, VBS
--read-scale

如果启用，其连接字符串中将应用程序意向设置为只读的连接可能会路由到只读次要副本。 此属性仅适用于高级数据库和业务关键数据库。

属性 值
接受的值: Disabled, Enabled
--service-level-objective --service-objective

新数据库的服务目标。 例如：基本、S0、P1、GP_Gen4_1、GP_S_Gen5_8、BC_Gen5_2、HS_Gen5_32。

属性 值
Parameter group: Performance Level Arguments
--tags

空格分隔标记：key[=value] [key[=value] ...]。使用“”清除现有标记。

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

SQL 数据库的用户分配标识列表。

--zone-redundant -z

指定是否启用区域冗余。 如果未指定任何值，则默认值为 true。

属性 值
接受的值: false, true
全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

属性 值
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性 值
默认值: False
--output -o

输出格式。

属性 值
默认值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性 值
默认值: False
编辑
预览

此命令处于预览阶段，正在开发中。 参考和支持级别：https://aka.ms/CLI_refstatus

设置长期保留备份数据库的法律保留。

az sql db ltr-backup set-legal-hold-immutability --database
                                                 --location
                                                 --name
                                                 --server
                                                 [--resource-group]
                                                 [--yes]

为数据库设置长期保留备份的法律保留。

az sql db ltr-backup set-legal-hold-immutability -g mygroup -l southeastasia -s myserver -d mydb -n "3214b3fb-fba9-43e7-96a3-09e35ffcb336;132292152080000000"
--database -d

Azure SQL 数据库的名称。 如果指定（以及服务器名称），则检索此数据库下的所有请求备份。

--location -l

所需备份的位置。

--name -n

LTR 备份的名称。 将“az sql db ltr-backup show”或“az sql db ltr-backup list”用于备份名称。

--server -s

Azure SQL Server 的名称。 如果指定，则检索此服务器下的所有请求备份。

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。

--yes -y

不要提示确认。

属性 值
默认值: False
全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

属性 值
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性 值
默认值: False
--output -o

输出格式。

属性 值
默认值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性 值
默认值: False

az sql db ltr-backup show

编辑

获取数据库的长期保留备份。

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

示例

显示数据库的长期保留备份。

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

必需参数

--database -d

Azure SQL 数据库的名称。 如果指定（以及服务器名称），则检索此数据库下的所有请求备份。

--location -l

所需备份的位置。

--name -n

LTR 备份的名称。 将“az sql db ltr-backup show”或“az sql db ltr-backup list”用于备份名称。

--server -s

Azure SQL Server 的名称。 如果指定，则检索此服务器下的所有请求备份。

全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

属性 值
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性 值
默认值: False
--output -o

输出格式。

属性 值
默认值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性 值
默认值: False

az sql db ltr-backup wait

编辑

将 CLI 置于等待状态，直到满足数据库条件。

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

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--created

等待在“Succeeded”中使用“provisioningState”创建。

属性 值
Parameter group: Wait Condition Arguments
默认值: False
--custom

等待条件满足自定义 JMESPath 查询。 例如 provisioningState！='InProgress'， instanceView.statuses[？code=='PowerState/running']。

属性 值
Parameter group: Wait Condition Arguments
--deleted

等到删除为止。

属性 值
Parameter group: Wait Condition Arguments
默认值: False
--exists

等待资源存在。

属性 值
Parameter group: Wait Condition Arguments
默认值: False
--expand

要包含在响应中的子资源。 默认值为无。

--filter

一个 OData 筛选器表达式，用于筛选集合中的元素。 默认值为无。

--ids

一个或多个资源 ID（以空格分隔）。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。

属性 值
Parameter group: Resource Id Arguments
--interval

轮询间隔（以秒为单位）。

属性 值
Parameter group: Wait Condition Arguments
默认值: 30
--name -n

Azure SQL 数据库的名称。

属性 值
Parameter group: Resource Id Arguments
--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。

属性 值
Parameter group: Resource Id Arguments
--server -s

Azure SQL Server 的名称。 可以使用 < a0/a0> 配置默认值 az configure --defaults sql-server=<name>。

属性 值
Parameter group: Resource Id Arguments
--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

属性 值
Parameter group: Resource Id Arguments
--timeout

最大等待（以秒为单位）。

属性 值
Parameter group: Wait Condition Arguments
默认值: 3600
--updated

等到 provisioningState 更新为“Succeeded”。

属性 值
Parameter group: Wait Condition Arguments
默认值: False
全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

属性 值
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性 值
默认值: False
--output -o

输出格式。

属性 值
默认值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性 值
默认值: False