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

az cosmosdb collection

此命令已弃用，将在将来的版本中删除。 改用“cosmosdb sql 容器、cosmosdb mongodb 集合、cosmosdb cassandra 表、cosmosdb gremlin 图形或 cosmosdb 表”。

管理 Azure Cosmos DB 集合。

命令

名称	说明	类型	Status
az cosmosdb collection create	创建 Azure Cosmos DB 集合。	核心	已放弃
az cosmosdb collection delete	删除 Azure Cosmos DB 集合。	核心	已放弃
az cosmosdb collection exists	返回一个布尔值，该值指示集合是否存在。	核心	已放弃
az cosmosdb collection list	列出所有 Azure Cosmos DB 集合。	核心	已放弃
az cosmosdb collection show	显示 Azure Cosmos DB 集合及其产品/服务。	核心	已放弃
az cosmosdb collection update	汇报 Azure Cosmos DB 集合。	核心	已放弃

az cosmosdb collection create

已放弃

此命令已隐式弃用，因为命令组“cosmosdb 集合”已弃用，将在将来的版本中删除。 改用“cosmosdb sql 容器、cosmosdb mongodb 集合、cosmosdb cassandra 表、cosmosdb gremlin 图形或 cosmosdb 表”。

创建 Azure Cosmos DB 集合。

az cosmosdb collection create --collection-name
                              --db-name
                              [--cep]
                              [--default-ttl]
                              [--indexing-policy]
                              [--key]
                              [--name]
                              [--partition-key-path]
                              [--resource-group-name]
                              [--throughput]
                              [--url-connection]

必需参数

--collection-name -c

集合名称。

--db-name -d

数据库名称。

可选参数

--cep

客户端加密策略，可以将其输入为字符串或文件，例如 --cep 或 --cep @policy-file.json “{”includedPaths“： [{”path“： ”/path1“，”clientEncryptionKeyId“： ”key1“，”encryptionAlgorithm“： ”AEAD_AES_256_CBC_HMAC_SHA256“，”encryptionType“： ”Deterministic“}]，”policyFormatVersion“： 2}”。

--default-ttl

默认 TTL。 提供 0 以禁用。

--indexing-policy

索引策略，可以将其输入为字符串或文件，例如 --indexing-policy @policy-file.json)。

默认值: { "indexingMode": "consistent", "automatic": true, "includedPaths": [ { "path": "/*" } ], "excludedPaths": [ { "path": "/\"_etag\"/?" } ] }

--key

Cosmos DB 帐户密钥。 必须与 cosmosdb 帐户名称或 url 连接结合使用。

--name -n

Cosmos DB 帐户名称。 必须与资源组或 cosmosdb 帐户密钥的名称结合使用。

--partition-key-path

分区键路径，例如“/properties/name”。

--resource-group-name -g

资源组的名称。 必须与 cosmosdb 帐户名称结合使用。

--throughput

产品/服务吞吐量（RU/秒）。

--url-connection

Cosmos DB 帐户 URL 连接。 必须与 cosmosdb 帐户密钥结合使用。

全局参数

--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 collection delete

已放弃

此命令已隐式弃用，因为命令组“cosmosdb 集合”已弃用，将在将来的版本中删除。 改用“cosmosdb sql 容器、cosmosdb mongodb 集合、cosmosdb cassandra 表、cosmosdb gremlin 图形或 cosmosdb 表”。

删除 Azure Cosmos DB 集合。

az cosmosdb collection delete --collection-name
                              --db-name
                              [--key]
                              [--name]
                              [--resource-group-name]
                              [--url-connection]
                              [--yes]

必需参数

--collection-name -c

集合名称。

--db-name -d

数据库名称。

可选参数

--key

Cosmos DB 帐户密钥。 必须与 cosmosdb 帐户名称或 url 连接结合使用。

--name -n

Cosmos DB 帐户名称。 必须与资源组或 cosmosdb 帐户密钥的名称结合使用。

--resource-group-name -g

资源组的名称。 必须与 cosmosdb 帐户名称结合使用。

--url-connection

Cosmos DB 帐户 URL 连接。 必须与 cosmosdb 帐户密钥结合使用。

--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 collection exists

已放弃

此命令已隐式弃用，因为命令组“cosmosdb 集合”已弃用，将在将来的版本中删除。 改用“cosmosdb sql 容器、cosmosdb mongodb 集合、cosmosdb cassandra 表、cosmosdb gremlin 图形或 cosmosdb 表”。

返回一个布尔值，该值指示集合是否存在。

az cosmosdb collection exists --collection-name
                              --db-name
                              [--key]
                              [--name]
                              [--resource-group-name]
                              [--url-connection]

必需参数

--collection-name -c

集合名称。

--db-name -d

数据库名称。

可选参数

--key

Cosmos DB 帐户密钥。 必须与 cosmosdb 帐户名称或 url 连接结合使用。

--name -n

Cosmos DB 帐户名称。 必须与资源组或 cosmosdb 帐户密钥的名称结合使用。

--resource-group-name -g

资源组的名称。 必须与 cosmosdb 帐户名称结合使用。

--url-connection

Cosmos DB 帐户 URL 连接。 必须与 cosmosdb 帐户密钥结合使用。

全局参数

--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 collection list

已放弃

此命令已隐式弃用，因为命令组“cosmosdb 集合”已弃用，将在将来的版本中删除。 改用“cosmosdb sql 容器、cosmosdb mongodb 集合、cosmosdb cassandra 表、cosmosdb gremlin 图形或 cosmosdb 表”。

列出所有 Azure Cosmos DB 集合。

az cosmosdb collection list --db-name
                            [--key]
                            [--name]
                            [--resource-group-name]
                            [--url-connection]

必需参数

--db-name -d

数据库名称。

可选参数

--key

Cosmos DB 帐户密钥。 必须与 cosmosdb 帐户名称或 url 连接结合使用。

--name -n

Cosmos DB 帐户名称。 必须与资源组或 cosmosdb 帐户密钥的名称结合使用。

--resource-group-name -g

资源组的名称。 必须与 cosmosdb 帐户名称结合使用。

--url-connection

Cosmos DB 帐户 URL 连接。 必须与 cosmosdb 帐户密钥结合使用。

全局参数

--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 collection show

已放弃

此命令已隐式弃用，因为命令组“cosmosdb 集合”已弃用，将在将来的版本中删除。 改用“cosmosdb sql 容器、cosmosdb mongodb 集合、cosmosdb cassandra 表、cosmosdb gremlin 图形或 cosmosdb 表”。

显示 Azure Cosmos DB 集合及其产品/服务。

az cosmosdb collection show --collection-name
                            --db-name
                            [--key]
                            [--name]
                            [--resource-group-name]
                            [--url-connection]

必需参数

--collection-name -c

集合名称。

--db-name -d

数据库名称。

可选参数

--key

Cosmos DB 帐户密钥。 必须与 cosmosdb 帐户名称或 url 连接结合使用。

--name -n

Cosmos DB 帐户名称。 必须与资源组或 cosmosdb 帐户密钥的名称结合使用。

--resource-group-name -g

资源组的名称。 必须与 cosmosdb 帐户名称结合使用。

--url-connection

Cosmos DB 帐户 URL 连接。 必须与 cosmosdb 帐户密钥结合使用。

全局参数

--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 collection update

已放弃

此命令已隐式弃用，因为命令组“cosmosdb 集合”已弃用，将在将来的版本中删除。 改用“cosmosdb sql 容器、cosmosdb mongodb 集合、cosmosdb cassandra 表、cosmosdb gremlin 图形或 cosmosdb 表”。

汇报 Azure Cosmos DB 集合。

az cosmosdb collection update --collection-name
                              --db-name
                              [--default-ttl]
                              [--indexing-policy]
                              [--key]
                              [--name]
                              [--resource-group-name]
                              [--throughput]
                              [--url-connection]

必需参数

--collection-name -c

集合名称。

--db-name -d

数据库名称。

可选参数

--default-ttl

默认 TTL。 提供 0 以禁用。

--indexing-policy

索引策略，可以将其输入为字符串或文件，例如 --indexing-policy @policy-file.json)。

--key

Cosmos DB 帐户密钥。 必须与 cosmosdb 帐户名称或 url 连接结合使用。

--name -n

Cosmos DB 帐户名称。 必须与资源组或 cosmosdb 帐户密钥的名称结合使用。

--resource-group-name -g

资源组的名称。 必须与 cosmosdb 帐户名称结合使用。

--throughput

产品/服务吞吐量（RU/秒）。

--url-connection

Cosmos DB 帐户 URL 连接。 必须与 cosmosdb 帐户密钥结合使用。

全局参数

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