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

az sql db

管理数据库。

命令

名称	说明	类型	Status
az sql db advanced-threat-protection-setting	管理数据库的高级威胁防护设置。	核心	GA
az sql db advanced-threat-protection-setting show	获取高级威胁防护设置。	核心	GA
az sql db advanced-threat-protection-setting update	更新数据库的高级威胁防护设置。	核心	GA
az sql db audit-policy	管理数据库的审核策略。	核心	GA
az sql db audit-policy show	显示数据库审核策略。	核心	GA
az sql db audit-policy update	更新数据库的审核策略。	核心	GA
az sql db audit-policy wait	将 CLI 置于等待状态，直到满足数据库的审核策略的条件。	核心	GA
az sql db classification	管理敏感度分类。	核心	GA
az sql db classification delete	删除给定列的敏感度分类。	核心	GA
az sql db classification list	获取给定数据库的敏感度分类。	核心	GA
az sql db classification recommendation	管理敏感度分类建议。	核心	GA
az sql db classification recommendation disable	禁用给定列的敏感度建议（默认情况下对所有列启用建议）。	核心	GA
az sql db classification recommendation enable	为给定列启用敏感度建议（默认情况下对所有列启用建议）。	核心	GA
az sql db classification recommendation list	列出给定数据库的推荐敏感度分类。	核心	GA
az sql db classification show	获取给定列的敏感度分类。	核心	GA
az sql db classification update	更新列的敏感度分类。	核心	GA
az sql db copy	创建数据库的副本。	核心	GA
az sql db create	创建数据库。	核心	GA
az sql db delete	删除数据库。	核心	GA
az sql db export	将数据库导出到 bacpac。	核心	GA
az sql db geo-backup	管理 SQL 数据库异地冗余备份。	核心	预览
az sql db geo-backup list	获取可恢复数据库的列表。	核心	预览
az sql db geo-backup restore	将异地冗余备份还原到新数据库。	核心	预览
az sql db geo-backup show	获取一个可恢复的数据库，该数据库是表示数据库异地备份的资源。	核心	预览
az sql db import	将 bacpac 导入新数据库或现有的空数据库。	核心	GA
az sql db ledger-digest-uploads	管理账本摘要上传设置。	核心	GA
az sql db ledger-digest-uploads disable	禁用上传账本摘要。	核心	GA
az sql db ledger-digest-uploads enable	启用将账本摘要上传到Azure 存储帐户或 Azure 机密账本。 如果已启用上传账本摘要，cmdlet 会将摘要存储终结点重置为新值。	核心	GA
az sql db ledger-digest-uploads show	显示当前的账本摘要设置。	核心	GA
az sql db list	列出服务器或弹性池上的数据库。	核心	GA
az sql db list-deleted	获取可还原的已删除数据库的列表。	核心	GA
az sql db list-editions	显示当前活动订阅可用的数据库版本。	核心	GA
az sql db list-usages	获取数据库使用情况。	核心	GA
az sql db ltr-backup	管理 SQL 数据库长期保留备份。	核心	预览
az sql db ltr-backup delete	删除长期保留备份。	核心	预览
az sql db ltr-backup list	列出位置、服务器或数据库的长期保留备份。	核心	预览
az sql db ltr-backup restore	将长期保留备份还原到新数据库。	核心	预览
az sql db ltr-backup show	获取数据库的长期保留备份。	核心	预览
az sql db ltr-backup wait	将 CLI 置于等待状态，直到满足数据库条件。	核心	预览
az sql db ltr-policy	管理 SQL 数据库长期保留策略。	核心	预览
az sql db ltr-policy set	更新数据库的长期保留设置。	核心	预览
az sql db ltr-policy show	显示数据库的长期保留策略。	核心	预览
az sql db op	管理数据库上的操作。	核心	GA
az sql db op cancel	取消对数据库的异步操作。	核心	GA
az sql db op list	获取对数据库执行的操作的列表。	核心	GA
az sql db rename	重命名数据库。	核心	GA
az sql db replica	管理数据库之间的复制。	核心	GA
az sql db replica create	将数据库创建为现有数据库的可读次要副本。	核心	GA
az sql db replica delete-link	永久停止两个数据库副本之间的数据复制。	核心	GA
az sql db replica list-links	列出数据库的副本及其复制状态。	核心	GA
az sql db replica set-primary	通过从当前主副本数据库进行故障转移来设置主副本数据库。	核心	GA
az sql db restore	通过从备份还原来创建新数据库。	核心	GA
az sql db show	获取数据库的详细信息。	核心	GA
az sql db show-connection-string	生成数据库的连接字符串。	核心	GA
az sql db show-deleted	获取已删除数据库的详细信息。	核心	GA
az sql db str-policy	管理 SQL 数据库短期保留策略。	核心	预览
az sql db str-policy set	更新实时数据库的短期保留设置。	核心	预览
az sql db str-policy show	显示实时数据库的短期保留策略。	核心	预览
az sql db str-policy wait	将 CLI 置于等待状态，直到设置策略。	核心	预览
az sql db tde	管理数据库的透明数据加密。	核心	GA
az sql db tde key	管理数据库的加密保护程序。	核心	GA
az sql db tde key revalidate	重新评估数据库的加密保护程序密钥。	核心	GA
az sql db tde key revert	将数据库的加密保护程序密钥还原到服务器级别。	核心	GA
az sql db tde set	设置数据库的透明数据加密配置。	核心	GA
az sql db tde show	显示透明数据加密。	核心	GA
az sql db threat-policy	管理数据库的威胁检测策略。	核心	已放弃
az sql db threat-policy show	获取威胁检测策略。	核心	已放弃
az sql db threat-policy update	更新数据库的威胁检测策略。	核心	已放弃
az sql db update	更新数据库。	核心	GA

az sql db copy

创建数据库的副本。

可以通过执行 az sql db list-editions -a -o table -l LOCATION来查看性能级别选项的完整列表。 复制目标数据库必须具有与源数据库相同的版本，但可以在复制完成后更改版本。

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

示例

创建性能级别为 S0 的数据库作为现有标准数据库的副本。

az sql db copy -g mygroup -s myserver -n originalDb --dest-name newDb --service-objective S0

使用 GeneralPurpose 版本、Gen4 硬件和 1 个 vcore 创建数据库作为现有 GeneralPurpose 数据库的副本。

az sql db copy -g mygroup -s myserver -n originalDb --dest-name newDb -f Gen4 -c 1

创建具有本地备份存储冗余的数据库作为现有数据库的副本

az sql db copy -g mygroup -s myserver -n originalDb --dest-name newDb --backup-storage-redundancy Local

必需参数

--dest-name

将创建为复制目标的数据库的名称。

可选参数

--assign-identity -i

为数据库分配标识。

接受的值: false, true

--auto-pause-delay

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

--availability-zone

可用性区域。

--backup-storage-redundancy --bsr

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

--capacity -c

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

--compute-model

数据库的计算模型。

接受的值: Provisioned, Serverless

--dest-resource-group

要在其中创建副本的资源组的名称。 如果未指定，则默认为源资源组。

--dest-server

要在其中创建副本的服务器的名称。 如果未指定，则默认为源服务器。

--elastic-pool

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

--encryption-protector

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

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

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

接受的值: false, true

--family -f

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

--federated-client-id

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

--ha-replicas --read-replicas

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

--ids

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

--keys

SQL 数据库的 AKV 键列表。

--license-type

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

接受的值: BasePrice, LicenseIncluded

--min-capacity

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

--name -n

Azure SQL 数据库的名称。

--no-wait

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

默认值: False

--preferred-enclave-type

指定此资源的 enclave 类型。

接受的值: Default, VBS

--read-scale

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

接受的值: Disabled, Enabled

--resource-group -g

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

--server -s

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

--service-level-objective --service-objective

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

--subscription

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

--tags

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

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

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

--zone-redundant -z

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

接受的值: false, true

全局参数

--debug

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

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

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

--subscription

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

--verbose

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

az sql db create

创建数据库。

可以通过执行 az sql db list-editions -a -o table -l LOCATION来查看性能级别选项的完整列表。

az sql db create --name
                 --resource-group
                 --server
                 [--assign-identity {false, true}]
                 [--auto-pause-delay]
                 [--availability-zone]
                 [--backup-storage-redundancy]
                 [--capacity]
                 [--catalog-collation {DATABASE_DEFAULT, SQL_Latin1_General_CP1_CI_AS}]
                 [--collation]
                 [--compute-model {Provisioned, Serverless}]
                 [--edition]
                 [--elastic-pool]
                 [--encryption-protector]
                 [--encryption-protector-auto-rotation {false, true}]
                 [--exhaustion-behavior {AutoPause, BillOverUsage}]
                 [--family]
                 [--federated-client-id]
                 [--free-limit {false, true}]
                 [--ha-replicas]
                 [--keys]
                 [--ledger-on {Disabled, Enabled}]
                 [--license-type {BasePrice, LicenseIncluded}]
                 [--maint-config-id]
                 [--max-size]
                 [--min-capacity]
                 [--no-wait]
                 [--preferred-enclave-type {Default, VBS}]
                 [--read-scale {Disabled, Enabled}]
                 [--sample-name {AdventureWorksLT}]
                 [--service-level-objective]
                 [--tags]
                 [--umi]
                 [--yes]
                 [--zone-redundant {false, true}]

示例

创建标准 S0 数据库。

az sql db create -g mygroup -s myserver -n mydb --service-objective S0

使用 GeneralPurpose 版本、Gen4 硬件和 1 个 vcore 创建数据库

az sql db create -g mygroup -s myserver -n mydb -e GeneralPurpose -f Gen4 -c 1

创建启用了区域冗余的数据库

az sql db create -g mygroup -s myserver -n mydb -z

创建显式禁用区域冗余的数据库

az sql db create -g mygroup -s myserver -n mydb -z false

创建 GeneralPurpose Gen5 2 vcore 无服务器数据库，自动暂停延迟 120 分钟

az sql db create -g mygroup -s myserver -n mydb -e GeneralPurpose -f Gen5 -c 2 --compute-model Serverless --auto-pause-delay 120

创建具有 2 个只读副本的超大规模 Gen5 2 vcore 数据库

az sql db create -g mygroup -s myserver -n mydb -e Hyperscale -f Gen5 -c 2 --read-replicas 2

创建具有本地冗余备份存储的 GeneralPurpose 数据库

az sql db create -g mygroup -s myserver -n mydb -e GeneralPurpose --backup-storage-redundancy Local

创建启用了 VBS enclave 的数据库。

az sql db create -g mygroup -s myserver -n mydb --preferred-enclave-type VBS

创建应用免费限制的数据库

az sql db create -g mygroup -s myserver -n mydb -e GeneralPurpose -f Gen5 -c 2 --compute-model Serverless --use-free-limit --free-limit-exhaustion-behavior AutoPause

必需参数

--name -n

Azure SQL 数据库的名称。

--resource-group -g

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

--server -s

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

可选参数

--assign-identity -i

为数据库分配标识。

接受的值: false, true

--auto-pause-delay

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

--availability-zone

可用性区域。

--backup-storage-redundancy --bsr

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

--capacity -c

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

--catalog-collation

元数据目录的排序规则。

接受的值: DATABASE_DEFAULT, SQL_Latin1_General_CP1_CI_AS

--collation

数据库的排序规则。

--compute-model

数据库的计算模型。

接受的值: Provisioned, Serverless

--edition --tier -e

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

--elastic-pool

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

--encryption-protector

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

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

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

接受的值: false, true

--exhaustion-behavior --fleb --free-limit-exhaustion-behavior

指定免费数据库使用每月免费限制时的行为。AutoPause：当剩余月份的可用限制用尽时，数据库将自动暂停。BillForUsage：在耗尽免费限制后，数据库将继续联机，并会收取任何超额费用。

接受的值: AutoPause, BillOverUsage

--family -f

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

--federated-client-id

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

--free-limit --use-free-limit

数据库是否使用免费的每月限制。 在订阅中的一个数据库上允许。

接受的值: false, true

--ha-replicas --read-replicas

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

--keys

SQL 数据库的 AKV 键列表。

--ledger-on

创建账本数据库，其中所有数据的完整性受账本功能保护。 账本数据库中的所有表必须是账本表。 注意：创建数据库后，无法更改此属性的值。

接受的值: Disabled, Enabled

--license-type

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

接受的值: BasePrice, LicenseIncluded

--maint-config-id -m

为此资源指定维护配置 ID 或名称。

--max-size

最大存储大小。 如果未指定单位，则默认为字节（B）。

--min-capacity

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

--no-wait

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

默认值: False

--preferred-enclave-type

指定此资源的 enclave 类型。

接受的值: Default, VBS

--read-scale

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

接受的值: Disabled, Enabled

--sample-name

创建 thisdatabase 时要应用的示例架构的名称。

接受的值: AdventureWorksLT

--service-level-objective --service-objective

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

--tags

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

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

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

--yes -y

不提示确认。

--zone-redundant -z

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

接受的值: false, true

全局参数

--debug

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

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

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

--subscription

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

--verbose

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

az sql db delete

删除数据库。

az sql db delete [--ids]
                 [--name]
                 [--no-wait]
                 [--resource-group]
                 [--server]
                 [--subscription]
                 [--yes]

示例

删除数据库。 （自动生成）

az sql db delete --name MyAzureSQLDatabase --resource-group MyResourceGroup --server myserver

可选参数

--ids

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

--name -n

Azure SQL 数据库的名称。

--no-wait

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

默认值: False

--resource-group -g

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

--server -s

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

--subscription

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

--yes -y

不提示确认。

默认值: False

全局参数

--debug

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

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

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

--subscription

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

--verbose

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

az sql db export

将数据库导出到 bacpac。

az sql db export --admin-password
                 --admin-user
                 --storage-key
                 --storage-key-type {SharedAccessKey, StorageAccessKey}
                 --storage-uri
                 [--auth-type {ADPassword, SQL}]
                 [--ids]
                 [--name]
                 [--no-wait]
                 [--resource-group]
                 [--server]
                 [--subscription]

示例

获取用于导出操作的 SAS 密钥。

az storage blob generate-sas --account-name myAccountName -c myContainer -n myBacpac.bacpac \
    --permissions rw --expiry 2018-01-01T00:00:00Z

使用 SAS 密钥导出 bacpac。

az sql db export -s myserver -n mydatabase -g mygroup -p password -u login \
    --storage-key "?sr=b&sp=rw&se=2018-01-01T00%3A00%3A00Z&sig=mysignature&sv=2015-07-08" \
    --storage-key-type SharedAccessKey \
    --storage-uri https://myAccountName.blob.core.windows.net/myContainer/myBacpac.bacpac

使用存储帐户密钥导出 bacpac。

az sql db export -s myserver -n mydatabase -g mygroup -p password -u login \
    --storage-key MYKEY== --storage-key-type StorageAccessKey \
    --storage-uri https://myAccountName.blob.core.windows.net/myContainer/myBacpac.bacpac

必需参数

--admin-password -p

必需。 管理员登录密码。

--admin-user -u

必需。 管理员登录名。

--storage-key

必需。 存储密钥。

--storage-key-type

必需。 存储密钥类型。

接受的值: SharedAccessKey, StorageAccessKey

--storage-uri

必需。 存储 URI。

可选参数

--auth-type -a

身份验证类型。

接受的值: ADPassword, SQL

--ids

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

--name -n

Azure SQL 数据库的名称。

--no-wait

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

默认值: False

--resource-group -g

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

--server -s

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

--subscription

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

全局参数

--debug

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

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

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

--subscription

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

--verbose

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

az sql db import

将 bacpac 导入新数据库或现有的空数据库。

az sql db import --admin-password
                 --admin-user
                 --storage-key
                 --storage-key-type {SharedAccessKey, StorageAccessKey}
                 --storage-uri
                 [--auth-type {ADPassword, SQL}]
                 [--ids]
                 [--name]
                 [--no-wait]
                 [--resource-group]
                 [--server]
                 [--subscription]

示例

获取用于导入操作的 SAS 密钥。

az storage blob generate-sas --account-name myAccountName -c myContainer -n myBacpac.bacpac \
    --permissions rw --expiry 2018-01-01T00:00:00Z

使用 SAS 密钥将 bacpac 导入现有数据库。

az sql db import -s myserver -n mydatabase -g mygroup -p password -u login \
    --storage-key "?sr=b&sp=rw&se=2018-01-01T00%3A00%3A00Z&sig=mysignature&sv=2015-07-08" \
    --storage-key-type SharedAccessKey \
    --storage-uri https://myAccountName.blob.core.windows.net/myContainer/myBacpac.bacpac

使用存储帐户密钥将 bacpac 导入现有数据库。

az sql db import -s myserver -n mydatabase -g mygroup -p password -u login --storage-key MYKEY== \
    --storage-key-type StorageAccessKey \
    --storage-uri https://myAccountName.blob.core.windows.net/myContainer/myBacpac.bacpac

必需参数

--admin-password -p

必需。 管理员登录密码。

--admin-user -u

必需。 管理员登录名。

--storage-key

必需。 存储密钥。

--storage-key-type

必需。 存储密钥类型。

接受的值: SharedAccessKey, StorageAccessKey

--storage-uri

必需。 存储 URI。

可选参数

--auth-type -a

身份验证类型。

接受的值: ADPassword, SQL

--ids

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

--name -n

Azure SQL 数据库的名称。

--no-wait

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

默认值: False

--resource-group -g

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

--server -s

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

--subscription

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

全局参数

--debug

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

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

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

--subscription

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

--verbose

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

az sql db list

列出服务器或弹性池上的数据库。

az sql db list [--elastic-pool]
               [--ids]
               [--resource-group]
               [--server]
               [--subscription]

示例

列出服务器或弹性池上的数据库。 （自动生成）

az sql db list --resource-group MyResourceGroup --server myserver

可选参数

--elastic-pool

如果指定，则仅列出此弹性池中的数据库。

--ids

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

--resource-group -g

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

--server -s

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

--subscription

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

全局参数

--debug

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

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

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

--subscription

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

--verbose

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

az sql db list-deleted

获取可还原的已删除数据库的列表。

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

可选参数

--ids

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

--resource-group -g

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

--server -s

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

--subscription

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

全局参数

--debug

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

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

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

--subscription

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

--verbose

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

az sql db list-editions

显示当前活动订阅可用的数据库版本。

包括可用的服务目标和存储限制。 为了减少详细程度，默认情况下会隐藏有意减少存储限制的设置。

az sql db list-editions --location
                        [--available]
                        [--dtu]
                        [--edition]
                        [--service-objective]
                        [--show-details {max-size}]
                        [--vcores]

示例

显示位置中的所有数据库版本。

az sql db list-editions -l westus -o table

显示标准版的所有可用数据库服务目标。

az sql db list-editions -l westus --edition Standard -o table

显示 P1 服务目标可用的最大数据库大小

az sql db list-editions -l westus --service-objective P1 --show-details max-size

必需参数

--location -l

Location。 az account list-locations 中的值。 可以使用 az configure --defaults location=<location> 配置默认位置。

可选参数

--available -a

如果指定，则仅显示指定区域中可用的结果。

默认值: False

--dtu

要搜索的 DTU 数。 如果未指定，将显示所有 DTU 大小。

--edition --tier -e

要搜索的版本。 如果未指定，则显示所有版本。

--service-objective

要搜索的服务目标。 如果未指定，将显示所有服务目标。

--show-details -d

要包含在输出中的其他详细信息的列表。

接受的值: max-size

--vcores

要搜索的 vcore 数。 如果未指定，将显示所有 vcore 大小。

全局参数

--debug

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

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

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

--subscription

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

--verbose

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

az sql db list-usages

获取数据库使用情况。

az sql db list-usages [--ids]
                      [--name]
                      [--resource-group]
                      [--server]
                      [--subscription]

可选参数

--ids

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

--name -n

Azure SQL 数据库的名称。

--resource-group -g

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

--server -s

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

--subscription

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

全局参数

--debug

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

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

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

--subscription

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

--verbose

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

az sql db rename

重命名数据库。

az sql db rename --new-name
                 [--ids]
                 [--name]
                 [--resource-group]
                 [--server]
                 [--subscription]

示例

重命名数据库。 （自动生成）

az sql db rename --name MyAzureSQLDatabase --new-name MyNew --resource-group MyResourceGroup --server myserver

必需参数

--new-name

将数据库重命名为的新名称。

可选参数

--ids

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

--name -n

Azure SQL 数据库的名称。

--resource-group -g

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

--server -s

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

--subscription

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

全局参数

--debug

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

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

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

--subscription

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

--verbose

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

az sql db restore

通过从备份还原来创建新数据库。

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

示例

通过从备份还原来创建新数据库。 （自动生成）

az sql db restore --dest-name MyDest --edition GeneralPurpose --name MyAzureSQLDatabase --resource-group MyResourceGroup --server myserver --subscription MySubscription --time "2018-05-20T05:34:22"

通过从备份还原，创建具有异地冗余备份存储的新数据库。 （自动生成）

az sql db restore --dest-name MyDest --edition GeneralPurpose --name MyAzureSQLDatabase --resource-group MyResourceGroup --server myserver --subscription MySubscription --time "2018-05-20T05:34:22" --backup-storage-redundancy Geo

必需参数

--dest-name

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

可选参数

--assign-identity -i

为数据库分配标识。

接受的值: false, true

--auto-pause-delay

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

--availability-zone

可用性区域。

--backup-storage-redundancy --bsr

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

--capacity -c

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

--compute-model

数据库的计算模型。

接受的值: Provisioned, Serverless

--deleted-time

如果指定，请从已删除的数据库而不是从现有数据库还原。 必须与同一服务器中删除的数据库的已删除时间匹配。 必须指定 --time 或 --deleted-time（或两者）。 时间应采用以下格式：“YYYY-MM-DDTHH：MM：SS”。

--edition --tier -e

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

--elastic-pool

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

--encryption-protector

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

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

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

接受的值: false, true

--family -f

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

--federated-client-id

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

--ha-replicas --read-replicas

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

--ids

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

--keys

SQL 数据库的 AKV 键列表。

--license-type

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

接受的值: BasePrice, LicenseIncluded

--min-capacity

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

--name -n

Azure SQL 数据库的名称。

--no-wait

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

默认值: False

--preferred-enclave-type

指定此资源的 enclave 类型。

接受的值: Default, VBS

--read-scale

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

接受的值: Disabled, Enabled

--resource-group -g

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

--server -s

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

--service-level-objective --service-objective

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

--subscription

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

--tags

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

--time -t

将还原以创建新数据库的源数据库的时间点。 必须大于或等于源数据库的最早RestoreDate 值。 必须指定 --time 或 --deleted-time（或两者）。 时间应采用以下格式：“YYYY-MM-DDTHH：MM：SS”。

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

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

--zone-redundant -z

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

接受的值: false, true

全局参数

--debug

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

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

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

--subscription

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

--verbose

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

az sql db show

获取数据库的详细信息。

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

示例

获取数据库的详细信息。 （自动生成）

az sql db show --name MyAzureSQLDatabase --resource-group MyResourceGroup --server myserver

可选参数

--expand-keys

展开数据库的 AKV 密钥。

接受的值: false, true

默认值: False

--ids

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

--keys-filter

展开数据库的 AKV 密钥。

--name -n

Azure SQL 数据库的名称。

--resource-group -g

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

--server -s

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

--subscription

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

全局参数

--debug

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

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

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

--subscription

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

--verbose

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

az sql db show-connection-string

生成数据库的连接字符串。

az sql db show-connection-string --client {ado.net, jdbc, odbc, php, php_pdo, sqlcmd}
                                 [--auth-type {ADIntegrated, ADPassword, SqlPassword}]
                                 [--ids]
                                 [--name]
                                 [--server]
                                 [--subscription]

示例

为 ado.net 生成连接字符串

az sql db show-connection-string -s myserver -n mydb -c ado.net

必需参数

--client -c

客户端连接提供程序的类型。

接受的值: ado.net, jdbc, odbc, php, php_pdo, sqlcmd

可选参数

--auth-type -a

身份验证的类型。

接受的值: ADIntegrated, ADPassword, SqlPassword

默认值: SqlPassword

--ids

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

--name -n

Azure SQL 数据库的名称。

默认值: <databasename>

--server -s

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

默认值: <servername>

--subscription

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

全局参数

--debug

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

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

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

--subscription

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

--verbose

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

az sql db show-deleted

获取已删除数据库的详细信息。

az sql db show-deleted --restorable-dropped-database-id
                       [--expand-keys {false, true}]
                       [--ids]
                       [--keys-filter]
                       [--resource-group]
                       [--server]
                       [--subscription]

示例

获取已删除数据库的详细信息。 （自动生成）

az sql db show-deleted --resource-group MyResourceGroup --server myserver --restorable-dropped-database-id "MyAzureSQLDatabase,133203966918270000"

必需参数

--restorable-dropped-database-id -r

可还原的已删除数据库 ID。

可选参数

--expand-keys

展开数据库的 AKV 密钥。

接受的值: false, true

默认值: False

--ids

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

--keys-filter

展开数据库的 AKV 密钥。

--resource-group -g

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

--server -s

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

--subscription

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

全局参数

--debug

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

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

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

--subscription

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

--verbose

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

az sql db update

更新数据库。

az sql db update [--add]
                 [--assign-identity {false, true}]
                 [--auto-pause-delay]
                 [--backup-storage-redundancy]
                 [--capacity]
                 [--compute-model {Provisioned, Serverless}]
                 [--edition]
                 [--elastic-pool]
                 [--encryption-protector]
                 [--encryption-protector-auto-rotation {false, true}]
                 [--exhaustion-behavior {AutoPause, BillOverUsage}]
                 [--family]
                 [--federated-client-id]
                 [--filter]
                 [--force-string]
                 [--free-limit {false, true}]
                 [--ha-replicas]
                 [--ids]
                 [--keys]
                 [--keys-to-remove]
                 [--maint-config-id]
                 [--manual-cutover {false, true}]
                 [--max-size]
                 [--min-capacity]
                 [--name]
                 [--no-wait]
                 [--perform-cutover {false, true}]
                 [--preferred-enclave-type {Default, VBS}]
                 [--read-scale {Disabled, Enabled}]
                 [--remove]
                 [--resource-group]
                 [--server]
                 [--service-objective]
                 [--set]
                 [--subscription]
                 [--umi]
                 [--zone-redundant {false, true}]

示例

通过指定 DTU 容量将数据库更新到标准版 S0 性能级别（10 DTU）。 请注意，GeneralPurpose 允许比标准版更大的最大大小范围。

az sql db update -g mygroup -s myserver -n mydb --edition Standard --capacity 10 --max-size 250GB

通过指定性能级别名称将数据库更新到标准版 S1 性能级别（20 DTU）。 请注意，GeneralPurpose 允许比标准版更大的最大大小范围。

az sql db update -g mygroup -s myserver -n mydb --edition Standard --service-objective S1 --max-size 250GB

使用 Gen5 硬件将数据库更新到 GeneralPurpose 版本、4 个 vcore

az sql db update -g mygroup -s myserver -n mydb --edition GeneralPurpose --capacity 4 --family Gen5

更新最大大小增加的数据库

az sql db update -g mygroup -s myserver -n mydb --max-size 500GB

更新启用了区域冗余的数据库

az sql db update -g mygroup -s myserver -n mydb -z

使用显式禁用区域冗余更新数据库

az sql db update -g mygroup -s myserver -n mydb -z false

将数据库更新到无服务器计算模型

az sql db update -g mygroup -s myserver -n mydb --edition GeneralPurpose --capacity 2 --family Gen5 --compute-model Serverless

使用本地冗余备份存储更新数据库

az sql db update -g mygroup -s myserver -n mydb --backup-storage-redundancy Local

使用已启用 VBS enclave 更新数据库。

az sql db update -g mygroup -s myserver -n mydb --preferred-enclave-type VBS

将免费限制数据库的耗尽行为更新为 BillOverUsage

az sql db update -g mygroup -s myserver -n mydb --free-limit-exhaustion-behavior BillOverUsage

使用手动直接转换选项将数据库更新到超大规模版本、2 个具有 Gen5 硬件的 vcore

az sql db update -g mygroup -s myserver -n mydb --edition Hyperscale --service-objective HS_Gen5_2 --manual-cutover

将数据库更新到超大规模版本时，使用执行直接转换选项触发直接转换

az sql db update -g mygroup -s myserver -n mydb --perform-cutover

可选参数

--add

通过指定路径和键值对将对象添加到对象列表。 示例：--add property.listProperty <key=value, string or JSON string>。

默认值: []

--assign-identity -i

为数据库分配标识。

接受的值: false, true

默认值: False

--auto-pause-delay

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

--backup-storage-redundancy --bsr

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

--capacity -c

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

--compute-model

数据库的计算模型。

接受的值: Provisioned, Serverless

--edition --tier -e

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

--elastic-pool

要将数据库移动到的弹性池的名称或资源 ID。

--encryption-protector

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

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

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

接受的值: false, true

--exhaustion-behavior --fleb --free-limit-exhaustion-behavior

指定免费数据库使用每月免费限制时的行为。AutoPause：当剩余月份的可用限制用尽时，数据库将自动暂停。BillForUsage：在耗尽免费限制后，数据库将继续联机，并会收取任何超额费用。

接受的值: AutoPause, BillOverUsage

--family -f

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

--federated-client-id

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

--filter

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

--force-string

使用“set”或“add”时，保留字符串文本，而不是尝试转换为 JSON。

默认值: False

--free-limit --use-free-limit

数据库是否使用免费的每月限制。 在订阅中的一个数据库上允许。

接受的值: false, true

--ha-replicas --read-replicas

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

--ids

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

--keys

SQL 数据库的 AKV 键列表。

--keys-to-remove

要从SQL 数据库中删除的 AKV 键列表。

--maint-config-id -m

为此资源指定维护配置 ID 或名称。

--manual-cutover

是否在更新 SLO 期间执行手动直接转换。 在将数据库更新到“超大规模”层时允许。

接受的值: false, true

--max-size

以字节表示的数据库的新最大大小。

--min-capacity

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

--name -n

Azure SQL 数据库的名称。

--no-wait

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

默认值: False

--perform-cutover

在将数据库更新到“超大规模”层时是否执行直接转换。

接受的值: false, true

--preferred-enclave-type

指定此资源的 enclave 类型。

接受的值: Default, VBS

--read-scale

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

接受的值: Disabled, Enabled

--remove

从列表中删除属性或元素。 示例： --remove property.list <indexToRemove> OR --remove propertyToRemove.

默认值: []

--resource-group -g

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

--server -s

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

--service-objective

新服务目标的名称。 如果这是独立的数据库服务目标，并且该数据库当前位于弹性池中，则会从池中删除该数据库。

--set

通过指定要设置的属性路径和值来更新对象。 示例：--set property1.property2=<value>。

默认值: []

--subscription

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

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

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

--zone-redundant -z

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

接受的值: false, true

全局参数

--debug

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

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

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

--subscription

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

--verbose

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