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

az sql db str-policy

管理 SQL 数据库短期保留策略。

命令

名称 说明 类型 Status
az sql db str-policy set

更新实时数据库的短期保留设置。

Core GA
az sql db str-policy show

显示实时数据库的短期保留策略。

Core GA
az sql db str-policy wait

将 CLI 置于等待状态,直到设置策略。

Core GA

az sql db str-policy set

更新实时数据库的短期保留设置。

锁定备份不可变性不可逆。 仅当 --lock-immutability 为 true 时才需要确认。 使用 --yes 跳过确认。 在锁定时包括 --retention-days。 若要保留保留期,请使用 str-policy 显示的当前值。 在锁定策略上增加保留期时,还指定 --lock-immutability true。 使用 str-policy show 在 --no-wait 更新后检查策略。

az sql db str-policy set [--acquire-policy-token]
                         [--change-reference]
                         [--diffbackup-hours]
                         [--ids]
                         [--lock-immutability {false, true}]
                         [--name]
                         [--no-wait]
                         [--resource-group]
                         [--retention-days]
                         [--server]
                         [--subscription]
                         [--yes]

示例

为实时数据库设置短期保留期。

az sql db str-policy set --resource-group mygroup --server myserver --name mydb --retention-days 7 --diffbackup-hours 24

将备份不可变性锁定为七天保留期,跳过确认。

az sql db str-policy set --resource-group mygroup --server myserver --name mydb --retention-days 7 --lock-immutability true --yes

可选参数

以下参数是可选的,但根据上下文,命令可能需要一个或多个参数才能成功执行。

--acquire-policy-token

为此资源操作自动获取Azure Policy令牌。

属性 值
参数组: Global Policy Arguments
--change-reference

此资源操作的相关更改引用 ID。

属性 值
参数组: Global Policy Arguments
--diffbackup-hours

新的备份短期保留策略差异备份间隔(以小时为单位)。实时数据库的有效差异备份间隔可以为 12 或 24 小时。

--ids

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

属性 值
参数组: Resource Id Arguments
--lock-immutability

是否锁定备份不可变性。 锁定不可逆。 设置 false 不会解锁已锁定的策略。

属性 值
接受的值: false, true
--name -n

Azure SQL 数据库的名称。

属性 值
参数组: Resource Id Arguments
--no-wait

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

属性 值
默认值: False
--resource-group -g

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

属性 值
参数组: Resource Id Arguments
--retention-days

新的备份短期保留策略保留期(以天为单位)。实时数据库的有效保留期(DTU)基本为 1-7 天;Rest 模型可以是 1-35 天。

--server -s

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

属性 值
参数组: Resource Id Arguments
--subscription

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

属性 值
参数组: Resource Id Arguments
--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/。

--verbose

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

属性 值
默认值: False

az sql db str-policy show

显示实时数据库的短期保留策略。

immutabilityStatus 输出属性报告服务返回时禁用、启用或锁定。

az sql db str-policy show [--ids]
                          [--name]
                          [--resource-group]
                          [--server]
                          [--subscription]

示例

显示实时数据库的短期保留策略。

az sql db str-policy show -g mygroup -s myserver -n mydb

显示当前备份不可变状态。

az sql db str-policy show --resource-group mygroup --server myserver --name mydb --query immutabilityStatus

可选参数

以下参数是可选的,但根据上下文,命令可能需要一个或多个参数才能成功执行。

--ids

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

属性 值
参数组: Resource Id Arguments
--name -n

Azure SQL 数据库的名称。

属性 值
参数组: Resource Id Arguments
--resource-group -g

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

属性 值
参数组: Resource Id Arguments
--server -s

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

属性 值
参数组: Resource Id Arguments
--subscription

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

属性 值
参数组: Resource Id Arguments
全局参数
--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

az sql db str-policy wait

将 CLI 置于等待状态,直到设置策略。

az sql db str-policy wait --policy-name
                          [--acquire-policy-token]
                          [--change-reference]
                          [--created]
                          [--custom]
                          [--deleted]
                          [--exists]
                          [--ids]
                          [--interval]
                          [--name]
                          [--resource-group]
                          [--server]
                          [--subscription]
                          [--timeout]
                          [--updated]

示例

等到默认的短期保留策略存在。

az sql db str-policy wait --resource-group mygroup --server myserver --name mydb --policy-name default --exists

等待备份不可变性被锁定。

az sql db str-policy wait --resource-group mygroup --server myserver --name mydb --policy-name default --custom "immutabilityStatus=='Locked'"

必需参数

--policy-name

策略名称。 应始终为“default”。

可选参数

以下参数是可选的,但根据上下文,命令可能需要一个或多个参数才能成功执行。

--acquire-policy-token

为此资源操作自动获取Azure Policy令牌。

属性 值
参数组: Global Policy Arguments
--change-reference

此资源操作的相关更改引用 ID。

属性 值
参数组: Global Policy Arguments
--created

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

属性 值
参数组: Wait Condition Arguments
默认值: False
--custom

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

属性 值
参数组: Wait Condition Arguments
--deleted

等到删除为止。

属性 值
参数组: Wait Condition Arguments
默认值: False
--exists

等待资源存在。

属性 值
参数组: Wait Condition Arguments
默认值: False
--ids

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

属性 值
参数组: Resource Id Arguments
--interval

轮询间隔(以秒为单位)。

属性 值
参数组: Wait Condition Arguments
默认值: 30
--name -n

Azure SQL 数据库的名称。

属性 值
参数组: Resource Id Arguments
--resource-group -g

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

属性 值
参数组: Resource Id Arguments
--server -s

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

属性 值
参数组: Resource Id Arguments
--subscription

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

属性 值
参数组: Resource Id Arguments
--timeout

最大等待(以秒为单位)。

属性 值
参数组: Wait Condition Arguments
默认值: 3600
--updated

等到 provisioningState 更新为“Succeeded”。

属性 值
参数组: 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