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

az cosmosdb sql database

注意

此命令组具有在 Azure CLI 和至少一个扩展中定义的命令。 安装每个扩展,使其受益于其扩展功能。 详细了解扩展。

管理 Azure Cosmos DB SQL 数据库。

命令

名称 说明 类型 Status
az cosmosdb sql database create

在 Azure Cosmos DB 帐户下创建 SQL 数据库。

核心 GA
az cosmosdb sql database delete

删除 Azure Cosmos DB 帐户下的 SQL 数据库。

核心 GA
az cosmosdb sql database exists

检查 Azure Cosmos DB SQL 数据库是否存在。

核心 GA
az cosmosdb sql database list

列出 Azure Cosmos DB 帐户下的 SQL 数据库。

核心 GA
az cosmosdb sql database merge

合并 sql 数据库的分区。

扩展 预览
az cosmosdb sql database restore

在同一帐户中还原已删除的 sql 数据库。

核心 GA
az cosmosdb sql database restore (cosmosdb-preview 扩展)

在同一帐户中还原已删除的 sql 数据库。

扩展 预览
az cosmosdb sql database show

显示 Azure Cosmos DB 帐户下的 SQL 数据库的详细信息。

核心 GA
az cosmosdb sql database throughput

在 Azure Cosmos DB 帐户下管理 SQL 数据库的吞吐量。

核心 GA
az cosmosdb sql database throughput migrate

在自动缩放和手动预配之间迁移 SQL 数据库的吞吐量。

核心 GA
az cosmosdb sql database throughput show

获取 Azure Cosmos DB 帐户下的 SQL 数据库的吞吐量。

核心 GA
az cosmosdb sql database throughput update

更新 Azure Cosmos DB 帐户下的 SQL 数据库的吞吐量。

核心 GA

az cosmosdb sql database create

在 Azure Cosmos DB 帐户下创建 SQL 数据库。

az cosmosdb sql database create --account-name
                                --name
                                --resource-group
                                [--max-throughput]
                                [--throughput]

必需参数

--account-name -a

Cosmosdb 帐户名称。

--name -n

数据库名称。

--resource-group -g

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

可选参数

--max-throughput

最大吞吐量资源可以扩展到 (RU/秒)。 在启用资源自动缩放时提供。 最小值可以为 4000 (RU/秒)。

--throughput

SQL 数据库的吞吐量(RU/秒)。 默认值为 400。

全局参数
--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 cosmosdb sql database delete

删除 Azure Cosmos DB 帐户下的 SQL 数据库。

az cosmosdb sql database delete --account-name
                                --name
                                --resource-group
                                [--yes]

必需参数

--account-name -a

Cosmosdb 帐户名称。

--name -n

数据库名称。

--resource-group -g

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

可选参数

--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 cosmosdb sql database exists

检查 Azure Cosmos DB SQL 数据库是否存在。

az cosmosdb sql database exists --account-name
                                --name
                                --resource-group

必需参数

--account-name -a

Cosmosdb 帐户名称。

--name -n

数据库名称。

--resource-group -g

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

全局参数
--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 cosmosdb sql database list

列出 Azure Cosmos DB 帐户下的 SQL 数据库。

az cosmosdb sql database list --account-name
                              --resource-group

示例

列出 Azure Cosmos DB 帐户下的 SQL 数据库(自动生成)

az cosmosdb sql database list --account-name MyAccount --resource-group MyResourceGroup

必需参数

--account-name -a

Cosmosdb 帐户名称。

--resource-group -g

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

全局参数
--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 cosmosdb sql database merge

预览

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

合并 sql 数据库的分区。

az cosmosdb sql database merge --account-name
                               --name
                               --resource-group

示例

合并数据库 my-database 的分区

az cosmosdb sql database merge -g my-resource-group -a my-account --name my-database

必需参数

--account-name -a

CosmosDB 数据库帐户的名称。

--name -n

CosmosDB 数据库名称的名称。

--resource-group -g

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

全局参数
--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 cosmosdb sql database restore

在同一帐户中还原已删除的 sql 数据库。

az cosmosdb sql database restore --account-name
                                 --name
                                 --resource-group
                                 [--restore-timestamp]

示例

在同一帐户中还原已删除的 sql 数据库。

az cosmosdb sql database restore --resource-group resource_group --account-name database_account_name --name name_of_database_needs_to_be_restored --restore-timestamp 2020-07-13T16:03:41+0000

必需参数

--account-name -a

Cosmosdb 帐户名称。

--name -n

数据库名称。

--resource-group -g

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

可选参数

--restore-timestamp -t

数据库需要还原到的时间戳。

全局参数
--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 cosmosdb sql database restore (cosmosdb-preview 扩展)

预览

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

在同一帐户中还原已删除的 sql 数据库。

az cosmosdb sql database restore --account-name
                                 --name
                                 --resource-group
                                 [--disable-ttl {false, true}]
                                 [--restore-timestamp]

示例

在同一帐户中还原已删除的 sql 数据库。

az cosmosdb sql database restore --resource-group resource_group --account-name database_account_name --name name_of_database_needs_to_be_restored --restore-timestamp 2020-07-13T16:03:41+0000

必需参数

--account-name -a

Cosmosdb 帐户名称。

--name -n

数据库名称。

--resource-group -g

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

可选参数

--disable-ttl
预览

禁用或禁用 ttl 还原。

接受的值: false, true
--restore-timestamp -t

数据库需要还原到的时间戳。

全局参数
--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 cosmosdb sql database show

显示 Azure Cosmos DB 帐户下的 SQL 数据库的详细信息。

az cosmosdb sql database show --account-name
                              --name
                              --resource-group

必需参数

--account-name -a

Cosmosdb 帐户名称。

--name -n

数据库名称。

--resource-group -g

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

全局参数
--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 获取完整的调试日志。