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

az cosmosdb

参考

注意

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

管理 Azure Cosmos DB 数据库帐户。

命令

名称	说明	类型	状态
az cosmosdb cassandra	管理 Azure Cosmos DB 帐户的 Cassandra 资源。	核心	GA
az cosmosdb cassandra keyspace	管理 Azure Cosmos DB Cassandra 密钥空间。	核心	GA
az cosmosdb cassandra keyspace create	在 Azure Cosmos DB 帐户下创建 Cassandra 密钥空间。	核心	GA
az cosmosdb cassandra keyspace delete	删除 Azure Cosmos DB 帐户下的 Cassandra 密钥空间。	核心	GA
az cosmosdb cassandra keyspace exists	检查 Azure Cosmos DB Cassandra 密钥空间是否存在。	核心	GA
az cosmosdb cassandra keyspace list	列出 Azure Cosmos DB 帐户下的 Cassandra 密钥空间。	核心	GA
az cosmosdb cassandra keyspace show	显示 Azure Cosmos DB 帐户下 Cassandra 密钥空间的详细信息。	核心	GA
az cosmosdb cassandra keyspace throughput	在 Azure Cosmos DB 帐户下管理 Cassandra 密钥空间的吞吐量。	核心	GA
az cosmosdb cassandra keyspace throughput migrate	在自动缩放和手动预配之间迁移 Cassandra 密钥空间的吞吐量。	核心	GA
az cosmosdb cassandra keyspace throughput show	获取 Azure Cosmos DB 帐户下 Cassandra 密钥空间的吞吐量。	核心	GA
az cosmosdb cassandra keyspace throughput update	更新 Azure Cosmos DB 帐户下 Cassandra 密钥空间的吞吐量。	核心	GA
az cosmosdb cassandra table	管理 Azure Cosmos DB Cassandra 表。	核心	GA
az cosmosdb cassandra table create	在 Azure Cosmos DB Cassandra 密钥空间下创建 Cassandra 表。	核心	GA
az cosmosdb cassandra table delete	删除 Azure Cosmos DB Cassandra 密钥空间下的 Cassandra 表。	核心	GA
az cosmosdb cassandra table exists	检查 Azure Cosmos DB Cassandra 表是否存在。	核心	GA
az cosmosdb cassandra table list	列出 Azure Cosmos DB Cassandra 密钥空间下的 Cassandra 表。	核心	GA
az cosmosdb cassandra table show	显示 Azure Cosmos DB Cassandra 密钥空间下 Cassandra 表的详细信息。	核心	GA
az cosmosdb cassandra table throughput	在 Azure Cosmos DB 帐户下管理 Cassandra 表的吞吐量。	核心	GA
az cosmosdb cassandra table throughput migrate	在自动缩放和手动预配之间迁移 Cassandra 表的吞吐量。	核心	GA
az cosmosdb cassandra table throughput show	获取 Azure Cosmos DB Cassandra 密钥空间下 Cassandra 表的吞吐量。	核心	GA
az cosmosdb cassandra table throughput update	更新 Azure Cosmos DB Cassandra 密钥空间下 Cassandra 表的吞吐量。	核心	GA
az cosmosdb cassandra table update	更新 Azure Cosmos DB Cassandra 密钥空间下的 Cassandra 表。	核心	GA
az cosmosdb check-name-exists	检查 Azure Cosmos DB 帐户名称是否存在。	核心	GA
az cosmosdb collection	管理 Azure Cosmos DB 集合。	核心	已放弃
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 copy	管理容器复制作业。	扩展	预览
az cosmosdb copy cancel	取消容器复制作业。	扩展	预览
az cosmosdb copy complete	完成联机容器复制作业。	扩展	预览
az cosmosdb copy create	创建容器复制作业。	扩展	预览
az cosmosdb copy list	获取容器复制作业。	扩展	预览
az cosmosdb copy pause	暂停容器复制作业。	扩展	预览
az cosmosdb copy resume	恢复容器复制作业。	扩展	预览
az cosmosdb copy show	获取容器复制作业。	扩展	预览
az cosmosdb create	创建新的 Azure Cosmos DB 数据库帐户。	核心	GA
az cosmosdb create (cosmosdb-preview 扩展)	创建新的 Azure Cosmos DB 数据库帐户。	扩展	预览
az cosmosdb database	管理 Azure Cosmos DB 数据库。	核心	已放弃
az cosmosdb database create	创建 Azure Cosmos DB 数据库。	核心	已放弃
az cosmosdb database delete	删除 Azure Cosmos DB 数据库。	核心	已放弃
az cosmosdb database exists	返回一个布尔值，该值指示数据库是否存在。	核心	已放弃
az cosmosdb database list	列出所有 Azure Cosmos DB 数据库。	核心	已放弃
az cosmosdb database show	显示 Azure Cosmos DB 数据库。	核心	已放弃
az cosmosdb delete	删除 Azure Cosmos DB 数据库帐户。	核心	GA
az cosmosdb dts	使用 cosmosdb 管理数据传输作业。	扩展	预览和弃用
az cosmosdb dts cancel	取消数据传输作业。	扩展	预览和弃用
az cosmosdb dts copy	创建数据传输复制作业。	扩展	预览和弃用
az cosmosdb dts list	获取数据传输作业的列表。	扩展	预览和弃用
az cosmosdb dts pause	暂停数据传输作业。	扩展	预览和弃用
az cosmosdb dts resume	恢复数据传输作业。	扩展	预览和弃用
az cosmosdb dts show	获取数据传输作业。	扩展	预览和弃用
az cosmosdb failover-priority-change	更改 Azure Cosmos DB 数据库帐户的故障转移优先级。	核心	GA
az cosmosdb gremlin	管理 Azure Cosmos DB 帐户的 Gremlin 资源。	核心和扩展	GA
az cosmosdb gremlin database	管理 Azure Cosmos DB Gremlin 数据库。	核心和扩展	GA
az cosmosdb gremlin database create	在 Azure Cosmos DB 帐户下创建 Gremlin 数据库。	核心	GA
az cosmosdb gremlin database delete	删除 Azure Cosmos DB 帐户下的 Gremlin 数据库。	核心	GA
az cosmosdb gremlin database exists	检查 Azure Cosmos DB Gremlin 数据库是否存在。	核心	GA
az cosmosdb gremlin database list	列出 Azure Cosmos DB 帐户下的 Gremlin 数据库。	核心	GA
az cosmosdb gremlin database restore	在同一帐户中还原已删除的 gremlin 数据库。	核心	GA
az cosmosdb gremlin database restore (cosmosdb-preview 扩展)	在同一帐户中还原已删除的 gremlin 数据库。	扩展	预览
az cosmosdb gremlin database show	显示 Azure Cosmos DB 帐户下 Gremlin 数据库的详细信息。	核心	GA
az cosmosdb gremlin database throughput	在 Azure Cosmos DB 帐户下管理 Gremlin 数据库的吞吐量。	核心	GA
az cosmosdb gremlin database throughput migrate	在自动缩放和手动预配之间迁移 Gremlin 数据库的吞吐量。	核心	GA
az cosmosdb gremlin database throughput show	获取 Azure Cosmos DB 帐户下 Gremlin 数据库的吞吐量。	核心	GA
az cosmosdb gremlin database throughput update	更新 Azure Cosmos DB 帐户下 Gremlin 数据库的吞吐量。	核心	GA
az cosmosdb gremlin graph	管理 Azure Cosmos DB Gremlin 图。	核心和扩展	GA
az cosmosdb gremlin graph create	在 Azure Cosmos DB Gremlin 数据库下创建 Gremlin 图形。	核心	GA
az cosmosdb gremlin graph delete	删除 Azure Cosmos DB Gremlin 数据库下的 Gremlin 图形。	核心	GA
az cosmosdb gremlin graph exists	检查 Azure Cosmos DB Gremlin 图形是否存在。	核心	GA
az cosmosdb gremlin graph list	列出 Azure Cosmos DB Gremlin 数据库下的 Gremlin 图形。	核心	GA
az cosmosdb gremlin graph restore	在同一帐户中还原已删除的 gremlin 图形。	核心	GA
az cosmosdb gremlin graph restore (cosmosdb-preview 扩展)	在同一帐户中还原已删除的 gremlin 图形。	扩展	预览
az cosmosdb gremlin graph show	显示 Azure Cosmos DB Gremlin 数据库下 Gremlin 图形的详细信息。	核心	GA
az cosmosdb gremlin graph throughput	在 Azure Cosmos DB 帐户下管理 Gremlin 图形的吞吐量。	核心	GA
az cosmosdb gremlin graph throughput migrate	在自动缩放和手动预配之间迁移 Gremlin Graph 的吞吐量。	核心	GA
az cosmosdb gremlin graph throughput show	获取 Azure Cosmos DB Gremlin 数据库下 Gremlin 图形的吞吐量。	核心	GA
az cosmosdb gremlin graph throughput update	更新 Azure Cosmos DB Gremlin 数据库下的 Gremlin 图形的吞吐量。	核心	GA
az cosmosdb gremlin graph update	在 Azure Cosmos DB Gremlin 数据库下更新 Gremlin 图形。	核心	GA
az cosmosdb gremlin restorable-database	管理 Azure Cosmos DB 帐户中可还原的不同版本的 gremlin 数据库。	核心和扩展	GA
az cosmosdb gremlin restorable-database list	列出在给定的可还原帐户中创建/修改/删除的所有 gremlin 数据库的所有版本。	核心	GA
az cosmosdb gremlin restorable-database list (cosmosdb-preview 扩展)	列出在给定的可还原帐户中创建/修改/删除的所有 gremlin 数据库的所有版本。	扩展	预览
az cosmosdb gremlin restorable-graph	管理 Azure Cosmos DB 帐户数据库中可还原的不同版本的 gremlin 图形。	核心和扩展	GA
az cosmosdb gremlin restorable-graph list	列出在给定数据库中创建/修改/删除的所有 gremlin 图形和可还原帐户的所有版本。	核心	GA
az cosmosdb gremlin restorable-graph list (cosmosdb-preview 扩展)	列出在给定数据库中创建/修改/删除的所有 gremlin 图形和可还原帐户的所有版本。	扩展	预览
az cosmosdb gremlin restorable-resource	管理可在给定时间戳和区域中的给定帐户中还原的数据库及其图形。	核心和扩展	GA
az cosmosdb gremlin restorable-resource list	列出可在给定时间戳和区域中的给定帐户中还原的所有数据库及其图形。	核心	GA
az cosmosdb gremlin restorable-resource list (cosmosdb-preview 扩展)	列出可在给定时间戳和区域中的给定帐户中还原的所有数据库及其图形。	扩展	预览
az cosmosdb gremlin retrieve-latest-backup-time	检索给定区域中给定 gremlin 图形的最新可还原时间戳。	核心	GA
az cosmosdb gremlin retrieve-latest-backup-time (cosmosdb-preview 扩展)	检索给定区域中给定 gremlin 图形的最新可还原时间戳。	扩展	预览
az cosmosdb identity	管理 Azure Cosmos DB 托管服务标识。	核心	预览
az cosmosdb identity assign	为 Azure Cosmos DB 数据库帐户分配 SystemAssigned 标识。	核心	预览
az cosmosdb identity remove	删除 Azure Cosmos DB 数据库帐户的 SystemAssigned 标识。	核心	预览
az cosmosdb identity show	显示 Azure Cosmos DB 数据库帐户的标识。	核心	预览
az cosmosdb keys	管理 Azure Cosmos DB 密钥。	核心	GA
az cosmosdb keys list	列出 Azure Cosmos DB 数据库帐户的访问密钥或连接字符串。	核心	GA
az cosmosdb keys regenerate	重新生成 Azure Cosmos DB 数据库帐户的访问密钥。	核心	GA
az cosmosdb list	列出 Azure Cosmos DB 数据库帐户。	核心	GA
az cosmosdb list (cosmosdb-preview 扩展)	列出 Azure Cosmos DB 数据库帐户。	扩展	GA
az cosmosdb list-connection-strings	列出 Azure Cosmos DB 数据库帐户的连接字符串。	核心	已放弃
az cosmosdb list-keys	列出 Azure Cosmos DB 数据库帐户的访问密钥。	核心	已放弃
az cosmosdb list-read-only-keys	列出 Azure Cosmos DB 数据库帐户的只读访问密钥。	核心	已放弃
az cosmosdb locations	管理 Azure Cosmos DB 位置属性。	核心	GA
az cosmosdb locations list	检索 cosmosdb 位置及其属性的列表。	核心	GA
az cosmosdb locations show	显示给定位置中的 Azure Cosmos DB 位置属性。	核心	GA
az cosmosdb mongocluster	Mongo 群集。	扩展	预览
az cosmosdb mongocluster create	创建 Mongo 群集。	扩展	预览
az cosmosdb mongocluster delete	删除 Mongo 群集资源。	扩展	预览
az cosmosdb mongocluster firewall	Mongo 群集防火墙。	扩展	预览
az cosmosdb mongocluster firewall rule	Mongo 群集防火墙规则。	扩展	预览
az cosmosdb mongocluster firewall rule create	创建 Mongo 群集防火墙规则。	扩展	预览
az cosmosdb mongocluster firewall rule delete	删除 Mongo 群集防火墙规则。	扩展	预览
az cosmosdb mongocluster firewall rule list	列出 Mongo 群集上的防火墙规则。	扩展	预览
az cosmosdb mongocluster firewall rule show	获取 Mongo 群集防火墙规则。	扩展	预览
az cosmosdb mongocluster firewall rule update	创建 Mongo 群集防火墙规则。	扩展	预览
az cosmosdb mongocluster list	列出 Mongo 群集资源。	扩展	预览
az cosmosdb mongocluster show	获取 Mongo 群集资源。	扩展	预览
az cosmosdb mongocluster update	更新 Mongo 群集。	扩展	预览
az cosmosdb mongodb	管理 Azure Cosmos DB 帐户的 MongoDB 资源。	核心和扩展	GA
az cosmosdb mongodb collection	管理 Azure Cosmos DB MongoDB 集合。	核心和扩展	GA
az cosmosdb mongodb collection create	在 Azure Cosmos DB MongoDB 数据库下创建 MongoDB 集合。	核心	GA
az cosmosdb mongodb collection delete	删除 Azure Cosmos DB MongoDB 数据库下的 MongoDB 集合。	核心	GA
az cosmosdb mongodb collection exists	检查 Azure Cosmos DB MongoDB 集合是否存在。	核心	GA
az cosmosdb mongodb collection list	列出 Azure Cosmos DB MongoDB 数据库下的 MongoDB 集合。	核心	GA
az cosmosdb mongodb collection merge	合并 mongodb 集合的分区。	扩展	预览
az cosmosdb mongodb collection redistribute-partition-throughput	重新分发 mongodb 集合的分区吞吐量。	扩展	预览
az cosmosdb mongodb collection restore	在同一帐户中还原已删除的 mongodb 集合。	核心	GA
az cosmosdb mongodb collection restore (cosmosdb-preview 扩展)	在同一帐户中还原已删除的 mongodb 集合。	扩展	预览
az cosmosdb mongodb collection retrieve-partition-throughput	检索 mongodb 集合的分区吞吐量。	扩展	预览
az cosmosdb mongodb collection show	显示 Azure Cosmos DB MongoDB 数据库下 MongoDB 集合的详细信息。	核心	GA
az cosmosdb mongodb collection throughput	在 Azure Cosmos DB 帐户下管理 MongoDB 集合的吞吐量。	核心	GA
az cosmosdb mongodb collection throughput migrate	在自动缩放和手动预配之间迁移 MongoDB 集合的吞吐量。	核心	GA
az cosmosdb mongodb collection throughput show	获取 Azure Cosmos DB MongoDB 数据库下的 MongoDB 集合的吞吐量。	核心	GA
az cosmosdb mongodb collection throughput update	更新 Azure Cosmos DB MongoDB 数据库下 MongoDB 集合的吞吐量。	核心	GA
az cosmosdb mongodb collection update	在 Azure Cosmos DB MongoDB 数据库下更新 MongoDB 集合。	核心	GA
az cosmosdb mongodb database	管理 Azure Cosmos DB MongoDB 数据库。	核心和扩展	GA
az cosmosdb mongodb database create	在 Azure Cosmos DB 帐户下创建 MongoDB 数据库。	核心	GA
az cosmosdb mongodb database delete	删除 Azure Cosmos DB 帐户下的 MongoDB 数据库。	核心	GA
az cosmosdb mongodb database exists	检查 Azure Cosmos DB MongoDB 数据库是否存在。	核心	GA
az cosmosdb mongodb database list	列出 Azure Cosmos DB 帐户下的 MongoDB 数据库。	核心	GA
az cosmosdb mongodb database merge	合并 mongodb 数据库的分区。	扩展	预览
az cosmosdb mongodb database restore	在同一帐户中还原已删除的 mongodb 数据库。	核心	GA
az cosmosdb mongodb database restore (cosmosdb-preview 扩展)	在同一帐户中还原已删除的 mongodb 数据库。	扩展	预览
az cosmosdb mongodb database show	显示 Azure Cosmos DB 帐户下的 MongoDB 数据库的详细信息。	核心	GA
az cosmosdb mongodb database throughput	在 Azure Cosmos DB 帐户下管理 MongoDB 数据库的吞吐量。	核心	GA
az cosmosdb mongodb database throughput migrate	在自动缩放和手动预配之间迁移 MongoDB 数据库的吞吐量。	核心	GA
az cosmosdb mongodb database throughput show	获取 Azure Cosmos DB 帐户下的 MongoDB 数据库的吞吐量。	核心	GA
az cosmosdb mongodb database throughput update	更新 Azure Cosmos DB 帐户下的 MongoDB 数据库的吞吐量。	核心	GA
az cosmosdb mongodb restorable-collection	管理 Azure Cosmos DB 帐户数据库中可还原的不同版本的 mongodb 集合。	核心和扩展	GA
az cosmosdb mongodb restorable-collection list	列出在给定数据库和可还原帐户中创建/修改/删除的所有 mongodb 集合的所有版本。	核心	GA
az cosmosdb mongodb restorable-collection list (cosmosdb-preview 扩展)	列出在给定数据库和可还原帐户中创建/修改/删除的所有 mongodb 集合的所有版本。	扩展	预览
az cosmosdb mongodb restorable-database	管理 Azure Cosmos DB 帐户中可还原的不同版本的 mongodb 数据库。	核心	GA
az cosmosdb mongodb restorable-database list	列出在给定的可还原帐户中创建/修改/删除的所有 mongodb 数据库的所有版本。	核心	GA
az cosmosdb mongodb restorable-resource	在给定的时间采样和区域管理可在给定帐户中还原的数据库及其集合。	核心	GA
az cosmosdb mongodb restorable-resource list	列出可在给定时间采样和区域在给定帐户中还原的所有数据库及其集合。	核心	GA
az cosmosdb mongodb retrieve-latest-backup-time	检索给定区域中给定 mongodb 集合的最新可还原时间戳。	核心	GA
az cosmosdb mongodb role	管理 Azure Cosmos DB Mongo 角色资源。	核心和扩展	GA
az cosmosdb mongodb role definition	管理 Azure Cosmos DB Mongo 角色定义。	核心和扩展	GA
az cosmosdb mongodb role definition create	在 Azure Cosmos DB 帐户下创建 Mongo DB 角色定义。	核心	GA
az cosmosdb mongodb role definition create (cosmosdb-preview 扩展)	在 Azure Cosmos DB 帐户下创建 Mongo DB 角色定义。	扩展	GA
az cosmosdb mongodb role definition delete	删除 Azure Cosmos DB 帐户下的 CosmosDb MongoDb 角色定义。	核心	GA
az cosmosdb mongodb role definition delete (cosmosdb-preview 扩展)	删除 Azure Cosmos DB 帐户下的 CosmosDb MongoDb 角色定义。	扩展	GA
az cosmosdb mongodb role definition exists	检查 Azure Cosmos DB MongoDb 角色定义是否存在。	核心	GA
az cosmosdb mongodb role definition exists (cosmosdb-preview 扩展)	检查 Azure Cosmos DB MongoDb 角色定义是否存在。	扩展	GA
az cosmosdb mongodb role definition list	列出 Azure Cosmos DB 帐户下的所有 MongoDb 角色定义。	核心	GA
az cosmosdb mongodb role definition list (cosmosdb-preview 扩展)	列出 Azure Cosmos DB 帐户下的所有 MongoDb 角色定义。	扩展	GA
az cosmosdb mongodb role definition show	显示 Azure Cosmos DB 帐户下 MongoDb 角色定义的属性。	核心	GA
az cosmosdb mongodb role definition show (cosmosdb-preview 扩展)	显示 Azure Cosmos DB 帐户下 MongoDb 角色定义的属性。	扩展	GA
az cosmosdb mongodb role definition update	在 Azure Cosmos DB 帐户下更新 MongoDb 角色定义。	核心	GA
az cosmosdb mongodb role definition update (cosmosdb-preview 扩展)	在 Azure Cosmos DB 帐户下更新 MongoDb 角色定义。	扩展	GA
az cosmosdb mongodb user	管理 Azure Cosmos DB Mongo 用户资源。	核心和扩展	GA
az cosmosdb mongodb user definition	管理 Azure Cosmos DB Mongo 用户定义。	核心和扩展	GA
az cosmosdb mongodb user definition create	在 Azure Cosmos DB 帐户下创建 Mongo DB 用户定义。	核心	GA
az cosmosdb mongodb user definition create (cosmosdb-preview 扩展)	在 Azure Cosmos DB 帐户下创建 Mongo DB 用户定义。	扩展	GA
az cosmosdb mongodb user definition delete	删除 Azure Cosmos DB 帐户下的 CosmosDb MongoDb 用户定义。	核心	GA
az cosmosdb mongodb user definition delete (cosmosdb-preview 扩展)	删除 Azure Cosmos DB 帐户下的 CosmosDb MongoDb 用户定义。	扩展	GA
az cosmosdb mongodb user definition exists	检查 Azure Cosmos DB MongoDb 用户定义是否存在。	核心	GA
az cosmosdb mongodb user definition exists (cosmosdb-preview 扩展)	检查 Azure Cosmos DB MongoDb 用户定义是否存在。	扩展	GA
az cosmosdb mongodb user definition list	列出 Azure Cosmos DB 帐户下的所有 MongoDb 用户定义。	核心	GA
az cosmosdb mongodb user definition list (cosmosdb-preview 扩展)	列出 Azure Cosmos DB 帐户下的所有 MongoDb 用户定义。	扩展	GA
az cosmosdb mongodb user definition show	显示 Azure Cosmos DB 帐户下 MongoDb 用户定义的属性。	核心	GA
az cosmosdb mongodb user definition show (cosmosdb-preview 扩展)	显示 Azure Cosmos DB 帐户下 MongoDb 用户定义的属性。	扩展	GA
az cosmosdb mongodb user definition update	在 Azure Cosmos DB 帐户下更新 MongoDb 用户定义。	核心	GA
az cosmosdb mongodb user definition update (cosmosdb-preview 扩展)	在 Azure Cosmos DB 帐户下更新 MongoDb 用户定义。	扩展	GA
az cosmosdb network-rule	管理 Azure Cosmos DB 网络规则。	核心	GA
az cosmosdb network-rule add	将虚拟网络规则添加到现有 Cosmos DB 数据库帐户。	核心	GA
az cosmosdb network-rule list	列出与 Cosmos DB 帐户关联的虚拟网络帐户。	核心	GA
az cosmosdb network-rule remove	从现有 Cosmos DB 数据库帐户中删除虚拟网络规则。	核心	GA
az cosmosdb postgres	管理 Azure Cosmos DB for PostgreSQL 资源。	核心	GA
az cosmosdb postgres check-name-availability	检查群集名称的可用性。群集名称应全局唯一;至少 3 个字符，最多 40 个字符;它们必须仅包含小写字母、数字和连字符;不得以连字符开头或结尾。	核心	GA
az cosmosdb postgres cluster	管理 Azure Cosmos DB for PostgreSQL 群集。	核心	GA
az cosmosdb postgres cluster create	使用节点创建新群集。	核心	GA
az cosmosdb postgres cluster delete	将群集与其中节点一起删除。	核心	GA
az cosmosdb postgres cluster list	列出订阅或资源组中的所有群集。	核心	GA
az cosmosdb postgres cluster promote	将读取副本 (replica)群集提升为独立的读写群集。	核心	GA
az cosmosdb postgres cluster restart	重启群集中的所有节点。	核心	GA
az cosmosdb postgres cluster server	管理用于 PostgreSQL 群集服务器的 Azure Cosmos DB。	核心	GA
az cosmosdb postgres cluster server list	列出群集的节点。	核心	GA
az cosmosdb postgres cluster server show	获取有关群集中的节点的信息。	核心	GA
az cosmosdb postgres cluster show	获取有关群集的信息，例如计算和存储配置以及群集生命周期元数据，例如群集创建日期和时间。	核心	GA
az cosmosdb postgres cluster start	在所有群集节点上启动停止计算。	核心	GA
az cosmosdb postgres cluster stop	停止所有群集节点上的计算。	核心	GA
az cosmosdb postgres cluster update	更新现有群集。请求正文可以包含群集定义的一个或多个属性。	核心	GA
az cosmosdb postgres cluster wait	将 CLI 置于等待状态，直到满足条件。	核心	GA
az cosmosdb postgres configuration	管理 Azure Cosmos DB for PostgreSQL 配置。	核心	GA
az cosmosdb postgres configuration coordinator	管理 Azure Cosmos DB for PostgreSQL 协调器配置。	核心	GA
az cosmosdb postgres configuration coordinator show	获取协调器配置的信息。	核心	GA
az cosmosdb postgres configuration coordinator update	群集中协调器汇报配置。	核心	GA
az cosmosdb postgres configuration coordinator wait	将 CLI 置于等待状态，直到满足条件。	核心	GA
az cosmosdb postgres configuration list	列出群集的所有配置。	核心	GA
az cosmosdb postgres configuration node	管理 Azure Cosmos DB for PostgreSQL 节点配置。	核心	GA
az cosmosdb postgres configuration node show	获取工作器节点的配置信息。	核心	GA
az cosmosdb postgres configuration node update	汇报群集中辅助角色节点的配置。	核心	GA
az cosmosdb postgres configuration node wait	将 CLI 置于等待状态，直到满足条件。	核心	GA
az cosmosdb postgres configuration server	管理 Azure Cosmos DB for PostgreSQL 服务器配置。	核心	GA
az cosmosdb postgres configuration server list	列出群集中服务器的所有配置。	核心	GA
az cosmosdb postgres configuration show	获取协调器和节点的配置信息。	核心	GA
az cosmosdb postgres firewall-rule	管理 Azure Cosmos DB for PostgreSQL 防火墙规则。	核心	GA
az cosmosdb postgres firewall-rule create	创建新的群集防火墙规则或更新现有的群集防火墙规则。	核心	GA
az cosmosdb postgres firewall-rule delete	删除群集防火墙规则。	核心	GA
az cosmosdb postgres firewall-rule list	列出群集上的所有防火墙规则。	核心	GA
az cosmosdb postgres firewall-rule show	获取有关群集防火墙规则的信息。	核心	GA
az cosmosdb postgres firewall-rule update	更新现有的群集防火墙规则。	核心	GA
az cosmosdb postgres firewall-rule wait	将 CLI 置于等待状态，直到满足条件。	核心	GA
az cosmosdb postgres role	管理用于 PostgreSQL 角色的 Azure Cosmos DB。	核心	GA
az cosmosdb postgres role create	创建新角色或更新现有角色。	核心	GA
az cosmosdb postgres role delete	删除群集角色。	核心	GA
az cosmosdb postgres role list	列出给定群集中的所有角色。	核心	GA
az cosmosdb postgres role show	获取有关群集角色的信息。	核心	GA
az cosmosdb postgres role update	更新现有角色。	核心	GA
az cosmosdb postgres role wait	将 CLI 置于等待状态，直到满足条件。	核心	GA
az cosmosdb private-endpoint-connection	管理 Azure Cosmos DB 专用终结点连接。	核心	GA
az cosmosdb private-endpoint-connection approve	批准与 Azure Cosmos DB 关联的指定专用终结点连接。	核心	GA
az cosmosdb private-endpoint-connection delete	删除与 Azure Cosmos DB 关联的指定专用终结点连接。	核心	GA
az cosmosdb private-endpoint-connection reject	拒绝与 Azure Cosmos DB 关联的指定专用终结点连接。	核心	GA
az cosmosdb private-endpoint-connection show	显示与 Azure Cosmos DB 关联的专用终结点连接的详细信息。	核心	GA
az cosmosdb private-link-resource	管理 Azure Cosmos DB 专用链接资源。	核心	GA
az cosmosdb private-link-resource list	列出 Azure Cosmos DB 支持的专用链接资源。	核心	GA
az cosmosdb regenerate-key	重新生成 Azure Cosmos DB 数据库帐户的访问密钥。	核心	已放弃
az cosmosdb restorable-database-account	管理可还原的 Azure Cosmos DB 帐户。	核心和扩展	GA
az cosmosdb restorable-database-account list	列出可以还原的所有数据库帐户。	核心	GA
az cosmosdb restorable-database-account list (cosmosdb-preview 扩展)	列出可以还原的所有数据库帐户。	扩展	GA
az cosmosdb restorable-database-account show	显示可以还原的数据库帐户的详细信息。	核心	GA
az cosmosdb restorable-database-account show (cosmosdb-preview 扩展)	显示可以还原的数据库帐户的详细信息。	扩展	GA
az cosmosdb restore	通过从现有数据库帐户还原来创建新的 Azure Cosmos DB 数据库帐户。	核心	GA
az cosmosdb restore (cosmosdb-preview 扩展)	通过从现有数据库帐户还原来创建新的 Azure Cosmos DB 数据库帐户。	扩展	预览
az cosmosdb service	用于对服务执行操作的命令。	核心和扩展	GA
az cosmosdb service create	创建 cosmosdb 服务资源。	核心	GA
az cosmosdb service create (cosmosdb-preview 扩展)	创建 cosmosdb 服务资源。	扩展	预览
az cosmosdb service delete	删除给定的 cosmosdb 服务资源。	核心	GA
az cosmosdb service delete (cosmosdb-preview 扩展)	删除给定的 cosmosdb 服务资源。	扩展	预览
az cosmosdb service list	列出帐户下的所有 cosmosdb 服务资源。	核心	GA
az cosmosdb service list (cosmosdb-preview 扩展)	列出帐户下的所有 cosmosdb 服务资源。	扩展	预览
az cosmosdb service show	在帐户下获取 cosmosdb 服务资源。	核心	GA
az cosmosdb service show (cosmosdb-preview 扩展)	在帐户下获取 cosmosdb 服务资源。	扩展	预览
az cosmosdb service update	更新 cosmosdb 服务资源。	核心	GA
az cosmosdb service update (cosmosdb-preview 扩展)	更新 cosmosdb 服务资源。	扩展	预览
az cosmosdb show	获取 Azure Cosmos DB 数据库帐户的详细信息。	核心	GA
az cosmosdb show (cosmosdb-preview 扩展)	获取 Azure Cosmos DB 数据库帐户的详细信息。	扩展	GA
az cosmosdb sql	管理 Azure Cosmos DB 帐户的 SQL 资源。	核心和扩展	GA
az cosmosdb sql container	管理 Azure Cosmos DB SQL 容器。	核心和扩展	GA
az cosmosdb sql container create	在 Azure Cosmos DB SQL 数据库下创建 SQL 容器。	核心	GA
az cosmosdb sql container create (cosmosdb-preview 扩展)	在 Azure Cosmos DB SQL 数据库下创建 SQL 容器。	扩展	GA
az cosmosdb sql container delete	删除 Azure Cosmos DB SQL 数据库下的 SQL 容器。	核心	GA
az cosmosdb sql container exists	检查 Azure Cosmos DB SQL 容器是否存在。	核心	GA
az cosmosdb sql container list	列出 Azure Cosmos DB SQL 数据库下的 SQL 容器。	核心	GA
az cosmosdb sql container merge	合并 sql 容器的分区。	扩展	预览
az cosmosdb sql container redistribute-partition-throughput	重新分发 sql 容器的分区吞吐量。	扩展	预览
az cosmosdb sql container restore	在同一帐户中还原已删除的 sql 容器。	核心	GA
az cosmosdb sql container restore (cosmosdb-preview 扩展)	在同一帐户中还原已删除的 sql 容器。	扩展	预览
az cosmosdb sql container retrieve-partition-throughput	检索 sql 容器的分区吞吐量。	扩展	预览
az cosmosdb sql container show	显示 Azure Cosmos DB SQL 数据库下 SQL 容器的详细信息。	核心	GA
az cosmosdb sql container throughput	在 Azure Cosmos DB 帐户下管理 SQL 容器的吞吐量。	核心	GA
az cosmosdb sql container throughput migrate	在自动缩放和手动预配之间迁移 SQL 容器的吞吐量。	核心	GA
az cosmosdb sql container throughput show	获取 Azure Cosmos DB SQL 数据库下的 SQL 容器的吞吐量。	核心	GA
az cosmosdb sql container throughput update	更新 Azure Cosmos DB SQL 数据库下的 SQL 容器的吞吐量。	核心	GA
az cosmosdb sql container update	更新 Azure Cosmos DB SQL 数据库下的 SQL 容器。	核心	GA
az cosmosdb sql container update (cosmosdb-preview 扩展)	更新 Azure Cosmos DB SQL 数据库下的 SQL 容器。	扩展	GA
az cosmosdb sql database	管理 Azure Cosmos DB SQL 数据库。	核心和扩展	GA
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 restorable-container	管理 Azure Cosmos DB 帐户数据库中可还原的不同版本的 sql 容器。	核心和扩展	GA
az cosmosdb sql restorable-container list	列出在给定数据库和可还原帐户中创建/修改/删除的所有 SQL 容器的所有版本。	核心	GA
az cosmosdb sql restorable-container list (cosmosdb-preview 扩展)	列出在给定数据库和可还原帐户中创建/修改/删除的所有 SQL 容器的所有版本。	扩展	预览
az cosmosdb sql restorable-database	管理 Azure Cosmos DB 帐户中可还原的不同版本的 sql 数据库。	核心	GA
az cosmosdb sql restorable-database list	列出在给定的可还原帐户中创建/修改/删除的所有 SQL 数据库的所有版本。	核心	GA
az cosmosdb sql restorable-resource	管理可在给定时间采样和区域中还原的给定帐户中的数据库及其容器。	核心	GA
az cosmosdb sql restorable-resource list	列出可在给定时间采样和区域在给定帐户中还原的所有数据库及其容器。	核心	GA
az cosmosdb sql retrieve-latest-backup-time	检索给定区域中给定 SQL 容器的最新可还原时间戳。	核心	GA
az cosmosdb sql role	管理 Azure Cosmos DB SQL 角色资源。	核心	GA
az cosmosdb sql role assignment	管理 Azure Cosmos DB SQL 角色分配。	核心	GA
az cosmosdb sql role assignment create	在 Azure Cosmos DB 帐户下创建 SQL 角色分配。	核心	GA
az cosmosdb sql role assignment delete	删除 Azure Cosmos DB 帐户下的 SQL 角色分配。	核心	GA
az cosmosdb sql role assignment exists	检查 Azure Cosmos DB 角色分配是否存在。	核心	GA
az cosmosdb sql role assignment list	列出 Azure Cosmos DB 帐户下的所有 SQL 角色分配。	核心	GA
az cosmosdb sql role assignment show	显示 Azure Cosmos DB 帐户下 SQL 角色分配的属性。	核心	GA
az cosmosdb sql role assignment update	在 Azure Cosmos DB 帐户下更新 SQL 角色分配。	核心	GA
az cosmosdb sql role assignment wait	轮询 SQL 角色分配，直到满足特定条件。	核心	GA
az cosmosdb sql role definition	管理 Azure Cosmos DB SQL 角色定义。	核心	GA
az cosmosdb sql role definition create	在 Azure Cosmos DB 帐户下创建 SQL 角色定义。	核心	GA
az cosmosdb sql role definition delete	删除 Azure Cosmos DB 帐户下的 SQL 角色定义。	核心	GA
az cosmosdb sql role definition exists	检查 Azure Cosmos DB 角色定义是否存在。	核心	GA
az cosmosdb sql role definition list	列出 Azure Cosmos DB 帐户下的所有 SQL 角色定义。	核心	GA
az cosmosdb sql role definition show	显示 Azure Cosmos DB 帐户下 SQL 角色定义的属性。	核心	GA
az cosmosdb sql role definition update	在 Azure Cosmos DB 帐户下更新 SQL 角色定义。	核心	GA
az cosmosdb sql role definition wait	轮询 SQL 角色定义，直到满足特定条件。	核心	GA
az cosmosdb sql stored-procedure	管理 Azure Cosmos DB SQL 存储过程。	核心	GA
az cosmosdb sql stored-procedure create	在 Azure Cosmos DB SQL 容器下创建 SQL 存储过程。	核心	GA
az cosmosdb sql stored-procedure delete	删除 Azure Cosmos DB SQL 容器下的 SQL 存储过程。	核心	GA
az cosmosdb sql stored-procedure list	列出 Azure Cosmos DB SQL 容器下的 SQL 存储过程。	核心	GA
az cosmosdb sql stored-procedure show	显示 Azure Cosmos DB SQL 容器下 SQL 存储过程的详细信息。	核心	GA
az cosmosdb sql stored-procedure update	创建或汇报 Azure Cosmos DB SQL 存储过程。	核心	GA
az cosmosdb sql trigger	管理 Azure Cosmos DB SQL 触发器。	核心	GA
az cosmosdb sql trigger create	在 Azure Cosmos DB SQL 容器下创建 SQL 触发器。	核心	GA
az cosmosdb sql trigger delete	删除 Azure Cosmos DB SQL 容器下的 SQL 触发器。	核心	GA
az cosmosdb sql trigger list	列出 Azure Cosmos DB SQL 容器下的 SQL 触发器。	核心	GA
az cosmosdb sql trigger show	显示 Azure Cosmos DB SQL 容器下 SQL 触发器的详细信息。	核心	GA
az cosmosdb sql trigger update	汇报 Azure Cosmos DB SQL 触发器。	核心	GA
az cosmosdb sql user-defined-function	管理 Azure Cosmos DB SQL 用户定义的函数。	核心	GA
az cosmosdb sql user-defined-function create	在 Azure Cosmos DB SQL 容器下创建 SQL 用户定义的函数。	核心	GA
az cosmosdb sql user-defined-function delete	删除 Azure Cosmos DB SQL 容器下的 SQL 用户定义的函数。	核心	GA
az cosmosdb sql user-defined-function list	列出 Azure Cosmos DB SQL 容器下的 SQL 用户定义的函数。	核心	GA
az cosmosdb sql user-defined-function show	显示 Azure Cosmos DB SQL 容器下 SQL 用户定义的函数的详细信息。	核心	GA
az cosmosdb sql user-defined-function update	创建或汇报 Azure Cosmos DB SQL 用户定义的函数。	核心	GA
az cosmosdb table	管理 Azure Cosmos DB 帐户的表资源。	核心和扩展	GA
az cosmosdb table create	在 Azure Cosmos DB 帐户下创建表。	核心	GA
az cosmosdb table delete	删除 Azure Cosmos DB 帐户下的表。	核心	GA
az cosmosdb table exists	检查 Azure Cosmos DB 表是否存在。	核心	GA
az cosmosdb table list	列出 Azure Cosmos DB 帐户下的表。	核心	GA
az cosmosdb table restorable-resource	在给定时间戳和区域中管理可在给定帐户中还原的表。	核心和扩展	GA
az cosmosdb table restorable-resource list	列出可在给定时间戳和区域中的给定帐户中还原的所有表。	核心	GA
az cosmosdb table restorable-resource list (cosmosdb-preview 扩展)	列出可在给定时间戳和区域中的给定帐户中还原的所有表。	扩展	预览
az cosmosdb table restorable-table	管理 Azure Cosmos DB 帐户中可还原的不同版本的表。	核心和扩展	GA
az cosmosdb table restorable-table list	列出在给定的可还原帐户中创建/修改/删除的所有表的所有版本。	核心	GA
az cosmosdb table restorable-table list (cosmosdb-preview 扩展)	列出在给定的可还原帐户中创建/修改/删除的所有表的所有版本。	扩展	预览
az cosmosdb table restore	在同一帐户中还原已删除的表。	核心	GA
az cosmosdb table restore (cosmosdb-preview 扩展)	在同一帐户中还原已删除的表。	扩展	预览
az cosmosdb table retrieve-latest-backup-time	检索给定区域中给定表的最新可还原时间戳。	核心	GA
az cosmosdb table retrieve-latest-backup-time (cosmosdb-preview 扩展)	检索给定区域中给定表的最新可还原时间戳。	扩展	预览
az cosmosdb table show	显示 Azure Cosmos DB 帐户下表的详细信息。	核心	GA
az cosmosdb table throughput	在 Azure Cosmos DB 帐户下管理表的吞吐量。	核心	GA
az cosmosdb table throughput migrate	在自动缩放和手动预配之间迁移表的吞吐量。	核心	GA
az cosmosdb table throughput show	获取 Azure Cosmos DB 帐户下表的吞吐量。	核心	GA
az cosmosdb table throughput update	更新 Azure Cosmos DB 帐户下表的吞吐量。	核心	GA
az cosmosdb update	更新 Azure Cosmos DB 数据库帐户。	核心	GA
az cosmosdb update (cosmosdb-preview 扩展)	更新 Azure Cosmos DB 数据库帐户。	扩展	GA

az cosmosdb check-name-exists

编辑

检查 Azure Cosmos DB 帐户名称是否存在。

az cosmosdb check-name-exists [--ids]
                              [--name]
                              [--subscription]

示例

检查 Azure Cosmos DB 帐户名称是否存在。（自动生成）

az cosmosdb check-name-exists --name MyCosmosDBDatabaseAccount

可选参数

--ids

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

--name -n

Cosmos DB 数据库帐户的名称。

--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 cosmosdb create

编辑

创建新的 Azure Cosmos DB 数据库帐户。

az cosmosdb create --name
                   --resource-group
                   [--analytical-storage-schema-type {FullFidelity, WellDefined}]
                   [--assign-identity]
                   [--backup-interval]
                   [--backup-policy-type {Continuous, Periodic}]
                   [--backup-redundancy {Geo, Local, Zone}]
                   [--backup-retention]
                   [--capabilities]
                   [--continuous-tier {Continuous30Days, Continuous7Days}]
                   [--databases-to-restore]
                   [--default-consistency-level {BoundedStaleness, ConsistentPrefix, Eventual, Session, Strong}]
                   [--default-identity]
                   [--disable-key-based-metadata-write-access {false, true}]
                   [--enable-analytical-storage {false, true}]
                   [--enable-automatic-failover {false, true}]
                   [--enable-burst-capacity {false, true}]
                   [--enable-free-tier {false, true}]
                   [--enable-multiple-write-locations {false, true}]
                   [--enable-partition-merge {false, true}]
                   [--enable-virtual-network {false, true}]
                   [--gremlin-databases-to-restore]
                   [--ip-range-filter]
                   [--is-restore-request {false, true}]
                   [--key-uri]
                   [--kind {GlobalDocumentDB, MongoDB, Parse}]
                   [--locations]
                   [--max-interval]
                   [--max-staleness-prefix]
                   [--minimal-tls-version {Tls, Tls11, Tls12}]
                   [--network-acl-bypass {AzureServices, None}]
                   [--network-acl-bypass-resource-ids]
                   [--public-network-access {DISABLED, ENABLED, SECUREDBYPERIMETER}]
                   [--restore-source]
                   [--restore-timestamp]
                   [--server-version {3.2, 3.6, 4.0, 4.2}]
                   [--tables-to-restore]
                   [--tags]
                   [--virtual-network-rules]

示例

创建新的 Azure Cosmos DB 数据库帐户。（自动生成）

az cosmosdb create --name MyCosmosDBDatabaseAccount --resource-group MyResourceGroup --subscription MySubscription

使用两个区域创建新的 Azure Cosmos DB 数据库帐户。英国南部是区域冗余。

az cosmosdb create -n myaccount -g mygroup --locations regionName=eastus failoverPriority=0 isZoneRedundant=False --locations regionName=uksouth failoverPriority=1 isZoneRedundant=True --enable-multiple-write-locations --network-acl-bypass AzureServices --network-acl-bypass-resource-ids /subscriptions/subId/resourceGroups/rgName/providers/Microsoft.Synapse/workspaces/wsName

通过从给定位置的现有帐户还原来创建新的 Azure Cosmos DB 数据库帐户

az cosmosdb create -n restoredaccount -g mygroup --is-restore-request true --restore-source /subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDB/locations/westus/restorableDatabaseAccounts/d056a4f8-044a-436f-80c8-cd3edbc94c68 --restore-timestamp 2020-07-13T16:03:41+0000 --locations regionName=westus failoverPriority=0 isZoneRedundant=False

必需参数

--name -n

Cosmos DB 数据库帐户的名称。

--resource-group -g

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

可选参数

--analytical-storage-schema-type --as-schema

分析存储的架构类型。

接受的值: FullFidelity, WellDefined

--assign-identity

分配由空格分隔的系统或用户分配标识。使用“[system]”引用系统分配的标识。

--backup-interval

创建备份的频率（以分钟为单位）（仅适用于定期模式备份的帐户）。

--backup-policy-type

要创建的帐户的备份策略的类型。

接受的值: Continuous, Periodic

--backup-redundancy

备份存储帐户的冗余类型。

接受的值: Geo, Local, Zone

--backup-retention

保留每个备份的时间（以小时为单位）（仅适用于定期模式备份的帐户）。

--capabilities

在 Cosmos DB 数据库帐户上设置自定义功能。

--continuous-tier

连续备份的层。

接受的值: Continuous30Days, Continuous7Days

--databases-to-restore

添加数据库及其集合名称以还原。

用法：--databases-to-restore name=DatabaseName collections=collection1 [collection2 ...]。

--default-consistency-level

Cosmos DB 数据库帐户的默认一致性级别。

接受的值: BoundedStaleness, ConsistentPrefix, Eventual, Session, Strong

--default-identity

用于访问 CMK 相关功能中的密钥保管库的主要标识。例如“FirstPartyIdentity”、“SystemAssignedIdentity”等。用户分配的标识以“UserAssignedIdentity=”格式指定。

--disable-key-based-metadata-write-access

通过帐户密钥对元数据资源（数据库、容器、吞吐量）禁用写入操作。

接受的值: false, true

--enable-analytical-storage

用于在帐户上启用日志存储的标志。

接受的值: false, true

--enable-automatic-failover

在极少数情况下启用写入区域的自动故障转移，因为服务中断导致该区域不可用。自动故障转移将导致帐户的新写入区域，并根据为帐户配置的故障转移优先级进行选择。

接受的值: false, true

--enable-burst-capacity

用于启用/禁用突发容量功能的标志。

用法：--enable-burst-capacity true 默认值：false 启用突发容量的接受值为 true 和 false。

接受的值: false, true

--enable-free-tier

预览

如果启用帐户是免费层。

接受的值: false, true

--enable-multiple-write-locations

启用多个写入位置。

接受的值: false, true

--enable-partition-merge

用于在帐户上启用分区合并的标志。

接受的值: false, true

--enable-virtual-network

在 Cosmos DB 数据库帐户上启用虚拟网络。

接受的值: false, true

--gremlin-databases-to-restore

添加 gremlin 数据库及其图形名称以还原。

用法：--gremlin-databases-to-restore name=DatabaseName graphs=graph1 [graph2 ...]。

--ip-range-filter

防火墙支持。以 CIDR 形式指定要作为给定数据库帐户的客户端 IP 允许列表包含的 IP 地址或 IP 地址范围集。 IP 地址/范围必须以逗号分隔，并且不能包含任何空格。

--is-restore-request -r

从现有/已删除的帐户还原。

接受的值: false, true

--key-uri

密钥保管库的 URI。

--kind

要创建的 Cosmos DB 数据库帐户的类型。

接受的值: GlobalDocumentDB, MongoDB, Parse

默认值: GlobalDocumentDB

--locations

将位置添加到 Cosmos DB 数据库帐户。

用法：--locations KEY=VALUE [KEY=VALUE ...]必需密钥：regionName、failoverPriority 可选密钥：isZoneRedundant Default：指定资源组的位置中的单个区域帐户。对于写入区域，故障转移优先级值为 0，读取区域大于 0。故障转移优先级值必须唯一且小于区域总数。可以使用多个 --locations 参数指定多个位置。

--max-interval

与有限过期一致性一起使用时，此值表示允许的过期时间（以秒为单位）。此值的接受范围为 5 - 86400。

默认值: 5

--max-staleness-prefix

与有限过期一致性一起使用时，此值表示允许的过时请求数。此值的接受范围为 10 - 2,147,483,647。

默认值: 100

--minimal-tls-version

指示允许的最低 TLS 版本。

用法：--minimal-tls-version TLSVersion Default：Tls，Cassandra 和 Mongo API 除外，它们仅适用于 Tls12 最低 TLS 版本的接受值为“Tls”、“Tls11”和“Tls12”，对应于 TLS 版本 1.0、1.1 和 1.2。

接受的值: Tls, Tls11, Tls12

--network-acl-bypass

用于启用或禁用网络 Acl 旁路的标志。

接受的值: AzureServices, None

--network-acl-bypass-resource-ids -i

允许绕过网络 Acl 的资源 ID 列表。

--public-network-access -p

将服务器中的公用网络访问设置为“已启用”、“已禁用”或“SecuredByPerimeter”。

接受的值: DISABLED, ENABLED, SECUREDBYPERIMETER

--restore-source

必须从中还原帐户的源帐户的可还原数据库帐户 ID。如果 --is-restore-request 设置为 true，则为必需。

--restore-timestamp

帐户必须还原到的时间戳。如果 --is-restore-request 设置为 true，则为必需。

--server-version

仅适用于 MongoDB 帐户。

接受的值: 3.2, 3.6, 4.0, 4.2

--tables-to-restore

添加表名称以还原。

用法：--tables-to-restore tables=table1 [table2 ...]。

--tags

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

--virtual-network-rules

ACL 用于虚拟网络。

全局参数

--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 create (cosmosdb-preview 扩展)

预览

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

创建新的 Azure Cosmos DB 数据库帐户。

az cosmosdb create --name
                   --resource-group
                   [--analytical-storage-schema-type {FullFidelity, WellDefined}]
                   [--assign-identity]
                   [--backup-interval]
                   [--backup-policy-type {Continuous, Periodic}]
                   [--backup-redundancy {Geo, Local, Zone}]
                   [--backup-retention]
                   [--capabilities]
                   [--continuous-tier {Continuous30Days, Continuous7Days}]
                   [--databases-to-restore]
                   [--default-consistency-level {BoundedStaleness, ConsistentPrefix, Eventual, Session, Strong}]
                   [--default-identity]
                   [--default-priority-level {High, Low}]
                   [--disable-key-based-metadata-write-access {false, true}]
                   [--enable-analytical-storage {false, true}]
                   [--enable-automatic-failover {false, true}]
                   [--enable-burst-capacity {false, true}]
                   [--enable-free-tier {false, true}]
                   [--enable-materialized-views {false, true}]
                   [--enable-multiple-write-locations {false, true}]
                   [--enable-partition-merge {false, true}]
                   [--enable-pbe {false, true}]
                   [--enable-prpp-autoscale {false, true}]
                   [--enable-virtual-network {false, true}]
                   [--gremlin-databases-to-restore]
                   [--ip-range-filter]
                   [--is-restore-request {false, true}]
                   [--key-uri]
                   [--kind {GlobalDocumentDB, MongoDB, Parse}]
                   [--locations]
                   [--max-interval]
                   [--max-staleness-prefix]
                   [--network-acl-bypass {AzureServices, None}]
                   [--network-acl-bypass-resource-ids]
                   [--public-network-access {DISABLED, ENABLED, SECUREDBYPERIMETER}]
                   [--restore-source]
                   [--restore-timestamp]
                   [--server-version {3.2, 3.6, 4.0, 4.2}]
                   [--tables-to-restore]
                   [--tags]
                   [--virtual-network-rules]

示例

DB 数据库帐户。（自动生成）

az cosmosdb create --name MyCosmosDBDatabaseAccount --resource-group MyResourceGroup --subscription MySubscription

使用两个区域创建新的 Azure Cosmos DB 数据库帐户。英国南部是区域冗余。

az cosmosdb create -n myaccount -g mygroup --locations regionName=eastus failoverPriority=0 isZoneRedundant=False --locations regionName=uksouth failoverPriority=1 isZoneRedundant=True --enable-multiple-write-locations --network-acl-bypass AzureServices --network-acl-bypass-resource-ids /subscriptions/subId/resourceGroups/rgName/providers/Microsoft.Synapse/workspaces/wsName

通过从给定位置的现有帐户还原来创建新的 Azure Cosmos DB 数据库帐户

az cosmosdb create -n restoredaccount -g mygroup --is-restore-request true --restore-source /subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDB/locations/westus/restorableDatabaseAccounts/d056a4f8-044a-436f-80c8-cd3edbc94c68 --restore-timestamp 2020-07-13T16:03:41+0000 --locations regionName=westus failoverPriority=0 isZoneRedundant=False

创建启用了具体化视图和 cassandra 功能的新 Azure Cosmos DB 数据库帐户。

az cosmosdb create --name MyCosmosDBDatabaseAccount --resource-group MyResourceGroup --enable-materialized-views true --capabilities EnableCassandra CassandraEnableMaterializedViews

必需参数

--name -n

Cosmos DB 数据库帐户的名称。

--resource-group -g

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

可选参数

--analytical-storage-schema-type --as-schema

分析存储的架构类型。

接受的值: FullFidelity, WellDefined

--assign-identity

分配由空格分隔的系统或用户分配标识。使用“[system]”引用系统分配的标识。

--backup-interval

创建备份的频率（以分钟为单位）（仅适用于定期模式备份的帐户）。

--backup-policy-type

要创建的帐户的备份策略的类型。

接受的值: Continuous, Periodic

--backup-redundancy

备份存储帐户的冗余类型。

接受的值: Geo, Local, Zone

--backup-retention

保留每个备份的时间（以小时为单位）（仅适用于定期模式备份的帐户）。

--capabilities

在 Cosmos DB 数据库帐户上设置自定义功能。

--continuous-tier

连续备份的层。

接受的值: Continuous30Days, Continuous7Days

--databases-to-restore

预览

添加数据库及其集合名称以还原。

用法：--databases-to-restore name=DatabaseName collections=collection1 [collection2 ...]。

--default-consistency-level

Cosmos DB 数据库帐户的默认一致性级别。

接受的值: BoundedStaleness, ConsistentPrefix, Eventual, Session, Strong

--default-identity

用于访问 CMK 相关功能中的密钥保管库的主要标识。例如“FirstPartyIdentity”、“SystemAssignedIdentity”等。

--default-priority-level

预览

如果未指定，则默认的请求优先级。

接受的值: High, Low

--disable-key-based-metadata-write-access

通过帐户密钥对元数据资源（数据库、容器、吞吐量）禁用写入操作。

接受的值: false, true

--enable-analytical-storage

用于在帐户上启用日志存储的标志。

接受的值: false, true

--enable-automatic-failover

接受的值: false, true

--enable-burst-capacity

预览

用于在帐户上启用突发容量的标志。

接受的值: false, true

--enable-free-tier

预览

如果启用帐户是免费层。

接受的值: false, true

--enable-materialized-views --enable-mv

预览

用于在帐户上启用 MaterializedViews 的标志。

接受的值: false, true

--enable-multiple-write-locations

启用多个写入位置。

接受的值: false, true

--enable-partition-merge

用于在帐户上启用分区合并的标志。

接受的值: false, true

--enable-pbe --enable-priority-based-execution

预览

标志以启用基于帐户执行的优先级。

接受的值: false, true

--enable-prpp-autoscale

预览

启用或禁用 PerRegionPerPartitionAutoscale。

接受的值: false, true

--enable-virtual-network

在 Cosmos DB 数据库帐户上启用虚拟网络。

接受的值: false, true

--gremlin-databases-to-restore

预览

添加 gremlin 数据库及其图形名称以还原。

用法：--gremlin-databases-to-restore name=DatabaseName graphs=graph1 [graph2 ...]。

--ip-range-filter

--is-restore-request -r

预览

从现有/已删除的帐户还原。

接受的值: false, true

--key-uri

密钥保管库的 URI。

--kind

要创建的 Cosmos DB 数据库帐户的类型。

接受的值: GlobalDocumentDB, MongoDB, Parse

默认值: GlobalDocumentDB

--locations

将位置添加到 Cosmos DB 数据库帐户。

--max-interval

与有限过期一致性一起使用时，此值表示允许的过期时间（以秒为单位）。此值的接受范围为 1 - 100。

默认值: 5

--max-staleness-prefix

与有限过期一致性一起使用时，此值表示允许的过时请求数。此值的接受范围为 1 - 2,147,483,647。

默认值: 100

--network-acl-bypass

用于启用或禁用网络 Acl 旁路的标志。

接受的值: AzureServices, None

--network-acl-bypass-resource-ids -i

允许绕过网络 Acl 的资源 ID 列表。

--public-network-access -p

将服务器中的公用网络访问设置为“已启用”、“已禁用”或“SecuredByPerimeter”。

接受的值: DISABLED, ENABLED, SECUREDBYPERIMETER

--restore-source

预览

必须从中还原帐户的源帐户的可还原数据库帐户 ID。如果 --is-restore-request 设置为 true，则为必需。

--restore-timestamp

预览

帐户必须还原到的时间戳。如果 --is-restore-request 设置为 true，则为必需。

--server-version

仅适用于 MongoDB 帐户。

接受的值: 3.2, 3.6, 4.0, 4.2

--tables-to-restore

预览

添加表名称以还原。

用法：--tables-to-restore tables=table1 [table2 ...]。

--tags

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

--virtual-network-rules

ACL 用于虚拟网络。

全局参数

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

编辑

删除 Azure Cosmos DB 数据库帐户。

az cosmosdb delete [--ids]
                   [--name]
                   [--resource-group]
                   [--subscription]
                   [--yes]

示例

删除 Azure Cosmos DB 数据库帐户。（自动生成）

az cosmosdb delete --name MyCosmosDBDatabaseAccount --resource-group MyResourceGroup

可选参数

--ids

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

--name -n

Cosmos DB 数据库帐户的名称。

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<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 cosmosdb failover-priority-change

编辑

更改 Azure Cosmos DB 数据库帐户的故障转移优先级。

az cosmosdb failover-priority-change --failover-policies
                                     [--ids]
                                     [--name]
                                     [--resource-group]
                                     [--subscription]

示例

更改 Azure Cosmos DB 数据库帐户的故障转移优先级。

az cosmosdb failover-priority-change --failover-policies southafricanorth=0 westus=8 northeurope=3 --name MyCosmosDBDatabaseAccount --resource-group MyResourceGroup

必需参数

--failover-policies

采用“regionName=failoverPriority”格式的空间分隔故障转移策略。策略数必须与帐户当前副本 (replica)的区域数匹配。所有 regionName 值必须与帐户当前副本 (replica)的区域匹配。所有 failoverPriority 值必须是唯一的。必须指定一个 failoverPriority 值零（0）。所有剩余的 failoverPriority 值都可以是任何正整数，它们不必是串联值，也不是以任何特定顺序写入的。例如 eastus=0 westus=1。

可选参数

--ids

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

--name -n

Cosmos DB 数据库帐户的名称。

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<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 cosmosdb list

编辑

列出 Azure Cosmos DB 数据库帐户。

az cosmosdb list [--resource-group]

可选参数

--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 list (cosmosdb-preview 扩展)

列出 Azure Cosmos DB 数据库帐户。

az cosmosdb list [--resource-group]

可选参数

--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 list-connection-strings

编辑

已放弃

此命令已弃用，将在将来的版本中删除。请改用“cosmosdb 密钥列表 --type connection-strings”。

列出 Azure Cosmos DB 数据库帐户的连接字符串。

az cosmosdb list-connection-strings [--ids]
                                    [--name]
                                    [--resource-group]
                                    [--subscription]

示例

列出 Azure Cosmos DB 数据库帐户的连接字符串。（自动生成）

az cosmosdb list-connection-strings --name MyCosmosDBDatabaseAccount --resource-group MyResourceGroup

可选参数

--ids

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

--name -n

Cosmos DB 数据库帐户的名称。

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<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 cosmosdb list-keys

编辑

已放弃

此命令已弃用，将在将来的版本中删除。请改用“cosmosdb 密钥列表”。

列出 Azure Cosmos DB 数据库帐户的访问密钥。

az cosmosdb list-keys [--ids]
                      [--name]
                      [--resource-group]
                      [--subscription]

示例

列出 Azure Cosmos DB 数据库帐户的访问密钥。（自动生成）

az cosmosdb list-keys --name MyCosmosDBDatabaseAccount --resource-group MyResourceGroup --subscription MySubscription

可选参数

--ids

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

--name -n

Cosmos DB 数据库帐户的名称。

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<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 cosmosdb list-read-only-keys

编辑

已放弃

此命令已弃用，将在将来的版本中删除。请改用“cosmosdb 密钥列表 --type read-only-keys”。

列出 Azure Cosmos DB 数据库帐户的只读访问密钥。

az cosmosdb list-read-only-keys [--ids]
                                [--name]
                                [--resource-group]
                                [--subscription]

示例

列出 Azure Cosmos DB 数据库帐户的只读访问密钥。（自动生成）

az cosmosdb list-read-only-keys --name MyCosmosDBDatabaseAccount --resource-group MyResourceGroup

可选参数

--ids

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

--name -n

Cosmos DB 数据库帐户的名称。

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<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 cosmosdb regenerate-key

编辑

已放弃

此命令已弃用，将在将来的版本中删除。请改用“cosmosdb 密钥重新生成”。

重新生成 Azure Cosmos DB 数据库帐户的访问密钥。

az cosmosdb regenerate-key --key-kind {primary, primaryReadonly, secondary, secondaryReadonly}
                           [--ids]
                           [--name]
                           [--resource-group]
                           [--subscription]

示例

重新生成 Azure Cosmos DB 数据库帐户的访问密钥。（自动生成）

az cosmosdb regenerate-key --key-kind primary --name MyCosmosDBDatabaseAccount --resource-group MyResourceGroup

必需参数

--key-kind

要重新生成的访问密钥。

接受的值: primary, primaryReadonly, secondary, secondaryReadonly

可选参数

--ids

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

--name -n

Cosmos DB 数据库帐户的名称。

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<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 cosmosdb restore

编辑

通过从现有数据库帐户还原来创建新的 Azure Cosmos DB 数据库帐户。

az cosmosdb restore --account-name
                    --location
                    --resource-group
                    --restore-timestamp
                    --target-database-account-name
                    [--assign-identity]
                    [--databases-to-restore]
                    [--default-identity]
                    [--gremlin-databases-to-restore]
                    [--public-network-access {DISABLED, ENABLED}]
                    [--tables-to-restore]

示例

通过从现有数据库帐户还原来创建新的 Azure Cosmos DB 数据库帐户。

az cosmosdb restore --target-database-account-name MyRestoredCosmosDBDatabaseAccount --account-name MySourceAccount --restore-timestamp 2020-07-13T16:03:41+0000 -g MyResourceGroup --location westus

通过仅从现有数据库帐户还原所选数据库和集合，创建新的 Azure Cosmos DB Sql 或 MongoDB 数据库帐户。

az cosmosdb restore -g MyResourceGroup --target-database-account-name MyRestoredCosmosDBDatabaseAccount --account-name MySourceAccount --restore-timestamp 2020-07-13T16:03:41+0000 --location westus --databases-to-restore name=MyDB1 collections=collection1 collection2 --databases-to-restore name=MyDB2 collections=collection3 collection4

通过仅从现有数据库帐户还原所选数据库或图形，创建新的 Azure Cosmos DB Gremlin 数据库帐户。

az cosmosdb restore -g MyResourceGroup --target-database-account-name MyRestoredCosmosDBDatabaseAccount --account-name MySourceAccount --restore-timestamp 2020-07-13T16:03:41+0000 --location westus --gremlin-databases-to-restore name=graphdb1 graphs=graph1 graph2

通过仅从现有数据库帐户还原所选表来创建新的 Azure Cosmos DB 表数据库帐户。

az cosmosdb restore -g MyResourceGroup --target-database-account-name MyRestoredCosmosDBDatabaseAccount --account-name MySourceAccount --restore-timestamp 2020-07-13T16:03:41+0000 --location westus --tables-to-restore table1,table2

必需参数

--account-name -a

还原的源 Cosmos DB 数据库帐户的名称。

--location -l

从中触发还原的源帐户的位置。这也是已还原帐户的写入区域。

--resource-group -g

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

--restore-timestamp -t

帐户必须还原到的时间戳。

--target-database-account-name -n

还原后的新目标 Cosmos DB 数据库帐户的名称。

可选参数

--assign-identity

分配由空格分隔的系统或用户分配标识。使用“[system]”引用系统分配的标识。

--databases-to-restore

添加数据库及其集合名称以还原。

用法：--databases-to-restore name=DatabaseName collections=collection1 [collection2 ...]可以使用多个 --databases-to-restore 参数来指定多个数据库。

--default-identity

用于访问 CMK 相关功能中的密钥保管库的主要标识。例如“FirstPartyIdentity”、“SystemAssignedIdentity”等。

--gremlin-databases-to-restore

添加 gremlin 数据库及其图形名称以还原。

用法：--gremlin-databases-to-restore name=DatabaseName graphs=graph1 [graph2 ...]。

--public-network-access -p

将服务器中的公共网络访问设置为“启用或禁用”。

接受的值: DISABLED, ENABLED

--tables-to-restore

添加表名称以还原。

用法：--tables-to-restore table1 [table2 ...]。

全局参数

--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 restore (cosmosdb-preview 扩展)

预览

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

通过从现有数据库帐户还原来创建新的 Azure Cosmos DB 数据库帐户。

az cosmosdb restore --account-name
                    --location
                    --resource-group
                    --restore-timestamp
                    --target-database-account-name
                    [--assign-identity]
                    [--databases-to-restore]
                    [--default-identity]
                    [--disable-ttl {false, true}]
                    [--gremlin-databases-to-restore]
                    [--public-network-access {DISABLED, ENABLED}]
                    [--source-backup-location]
                    [--tables-to-restore]

示例

通过从现有数据库帐户还原来创建新的 Azure Cosmos DB 数据库帐户。

az cosmosdb restore --target-database-account-name MyRestoredCosmosDBDatabaseAccount --account-name MySourceAccount --restore-timestamp 2020-07-13T16:03:41+0000 -g MyResourceGroup --location westus

通过仅从现有数据库帐户还原所选数据库和集合，创建新的 Azure Cosmos DB Sql 或 MongoDB 数据库帐户。

az cosmosdb restore -g MyResourceGroup --target-database-account-name MyRestoredCosmosDBDatabaseAccount --account-name MySourceAccount --restore-timestamp 2020-07-13T16:03:41+0000 --location westus --databases-to-restore name=MyDB1 collections=collection1 collection2 --databases-to-restore name=MyDB2 collections=collection3 collection4

通过仅从现有数据库帐户还原所选数据库或图形，创建新的 Azure Cosmos DB Gremlin 数据库帐户。

az cosmosdb restore -g MyResourceGroup --target-database-account-name MyRestoredCosmosDBDatabaseAccount --account-name MySourceAccount --restore-timestamp 2020-07-13T16:03:41+0000 --location westus --gremlin-databases-to-restore name=graphdb1 graphs=graph1 graph2

通过仅从现有数据库帐户还原所选表来创建新的 Azure Cosmos DB 表数据库帐户。

az cosmosdb restore -g MyResourceGroup --target-database-account-name MyRestoredCosmosDBDatabaseAccount --account-name MySourceAccount --restore-timestamp 2020-07-13T16:03:41+0000 --location westus --tables-to-restore table1,table2

必需参数

--account-name -a

还原的源 Cosmos DB 数据库帐户的名称。

--location -l

这是已还原帐户的写入区域。如果未提供source_backup_location，则这也是源帐户的位置。

--resource-group -g

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

--restore-timestamp -t

帐户必须还原到的时间戳。

--target-database-account-name -n

还原后的新目标 Cosmos DB 数据库帐户的名称。

可选参数

--assign-identity

分配由空格分隔的系统或用户分配标识。使用“[system]”引用系统分配的标识。

--databases-to-restore

添加数据库及其集合名称以还原。

用法：--databases-to-restore name=DatabaseName collections=collection1 [collection2 ...]可以使用多个 --databases-to-restore 参数来指定多个数据库。

--default-identity

用于访问 CMK 相关功能中的密钥保管库的主要标识。例如“FirstPartyIdentity”、“SystemAssignedIdentity”等。

--disable-ttl

预览

禁用或禁用 ttl 还原。

接受的值: false, true

--gremlin-databases-to-restore

预览

添加 gremlin 数据库及其图形名称以还原。

用法：--gremlin-databases-to-restore name=DatabaseName graphs=graph1 [graph2 ...]。

--public-network-access -p

将服务器中的公共网络访问设置为“启用或禁用”。

接受的值: DISABLED, ENABLED

--source-backup-location

预览

这是备份所在的源帐户的位置。如果源和目标位于不同的位置，请提供此值。

--tables-to-restore

预览

添加表名称以还原。

用法：--tables-to-restore table1 [table2 ...]。

全局参数

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

编辑

获取 Azure Cosmos DB 数据库帐户的详细信息。

az cosmosdb show [--ids]
                 [--name]
                 [--resource-group]
                 [--subscription]

示例

获取 Azure Cosmos DB 数据库帐户的详细信息。（自动生成）

az cosmosdb show --name MyCosmosDBDatabaseAccount --resource-group MyResourceGroup

可选参数

--ids

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

--name -n

Cosmos DB 数据库帐户的名称。

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<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 cosmosdb show (cosmosdb-preview 扩展)

获取 Azure Cosmos DB 数据库帐户的详细信息。

az cosmosdb show [--ids]
                 [--name]
                 [--resource-group]
                 [--subscription]

示例

获取 Azure Cosmos DB 数据库帐户的详细信息。（自动生成）

az cosmosdb show --name MyCosmosDBDatabaseAccount --resource-group MyResourceGroup

可选参数

--ids

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

--name -n

Cosmos DB 数据库帐户的名称。

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<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 cosmosdb update

编辑

更新 Azure Cosmos DB 数据库帐户。

az cosmosdb update [--analytical-storage-schema-type {FullFidelity, WellDefined}]
                   [--backup-interval]
                   [--backup-policy-type {Continuous, Periodic}]
                   [--backup-redundancy {Geo, Local, Zone}]
                   [--backup-retention]
                   [--capabilities]
                   [--continuous-tier {Continuous30Days, Continuous7Days}]
                   [--default-consistency-level {BoundedStaleness, ConsistentPrefix, Eventual, Session, Strong}]
                   [--default-identity]
                   [--disable-key-based-metadata-write-access {false, true}]
                   [--enable-analytical-storage {false, true}]
                   [--enable-automatic-failover {false, true}]
                   [--enable-burst-capacity {false, true}]
                   [--enable-multiple-write-locations {false, true}]
                   [--enable-partition-merge {false, true}]
                   [--enable-virtual-network {false, true}]
                   [--ids]
                   [--ip-range-filter]
                   [--key-uri]
                   [--locations]
                   [--max-interval]
                   [--max-staleness-prefix]
                   [--minimal-tls-version {Tls, Tls11, Tls12}]
                   [--name]
                   [--network-acl-bypass {AzureServices, None}]
                   [--network-acl-bypass-resource-ids]
                   [--public-network-access {DISABLED, ENABLED, SECUREDBYPERIMETER}]
                   [--resource-group]
                   [--server-version {3.2, 3.6, 4.0, 4.2}]
                   [--subscription]
                   [--tags]
                   [--virtual-network-rules]

示例

更新 Azure Cosmos DB 数据库帐户。（自动生成）

az cosmosdb update --capabilities EnableGremlin --name MyCosmosDBDatabaseAccount --resource-group MyResourceGroup

使用两个区域创建新的 Azure Cosmos DB 数据库帐户。英国南部是区域冗余。

az cosmosdb update -n myaccount -g mygroup --locations regionName=eastus failoverPriority=0 isZoneRedundant=False --locations regionName=uksouth failoverPriority=1 isZoneRedundant=True --enable-multiple-write-locations --network-acl-bypass AzureServices --network-acl-bypass-resource-ids /subscriptions/subId/resourceGroups/rgName/providers/Microsoft.Synapse/workspaces/wsName

可选参数

--analytical-storage-schema-type --as-schema

分析存储的架构类型。

接受的值: FullFidelity, WellDefined

--backup-interval

创建备份的频率（以分钟为单位）（仅适用于定期模式备份的帐户）。

--backup-policy-type

要创建的帐户的备份策略的类型。

接受的值: Continuous, Periodic

--backup-redundancy

备份存储帐户的冗余类型。

接受的值: Geo, Local, Zone

--backup-retention

保留每个备份的时间（以小时为单位）（仅适用于定期模式备份的帐户）。

--capabilities

在 Cosmos DB 数据库帐户上设置自定义功能。

--continuous-tier

连续备份的层。

接受的值: Continuous30Days, Continuous7Days

--default-consistency-level

Cosmos DB 数据库帐户的默认一致性级别。

接受的值: BoundedStaleness, ConsistentPrefix, Eventual, Session, Strong

--default-identity

--disable-key-based-metadata-write-access

通过帐户密钥对元数据资源（数据库、容器、吞吐量）禁用写入操作。

接受的值: false, true

--enable-analytical-storage

用于在帐户上启用日志存储的标志。

接受的值: false, true

--enable-automatic-failover

接受的值: false, true

--enable-burst-capacity

用于启用/禁用突发容量功能的标志。

用法：--enable-burst-capacity true 默认值：false 启用突发容量的接受值为 true 和 false。

接受的值: false, true

--enable-multiple-write-locations

启用多个写入位置。

接受的值: false, true

--enable-partition-merge

用于在帐户上启用分区合并的标志。

接受的值: false, true

--enable-virtual-network

在 Cosmos DB 数据库帐户上启用虚拟网络。

接受的值: false, true

--ids

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

--ip-range-filter

--key-uri

预览

密钥保管库的 URI。

--locations

将位置添加到 Cosmos DB 数据库帐户。

--max-interval

与有限过期一致性一起使用时，此值表示允许的过期时间（以秒为单位）。此值的接受范围为 5 - 86400。

--max-staleness-prefix

与有限过期一致性一起使用时，此值表示允许的过时请求数。此值的接受范围为 10 - 2,147,483,647。

--minimal-tls-version

指示允许的最低 TLS 版本。

接受的值: Tls, Tls11, Tls12

--name -n

Cosmos DB 数据库帐户的名称。

--network-acl-bypass

用于启用或禁用网络 Acl 旁路的标志。

接受的值: AzureServices, None

--network-acl-bypass-resource-ids -i

允许绕过网络 Acl 的资源 ID 列表。

--public-network-access -p

将服务器中的公用网络访问设置为“已启用”、“已禁用”或“SecuredByPerimeter”。

接受的值: DISABLED, ENABLED, SECUREDBYPERIMETER

--resource-group -g

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

--server-version

仅适用于 MongoDB 帐户。

接受的值: 3.2, 3.6, 4.0, 4.2

--subscription

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

--tags

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

--virtual-network-rules

ACL 用于虚拟网络。

全局参数

--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 update (cosmosdb-preview 扩展)

更新 Azure Cosmos DB 数据库帐户。

az cosmosdb update [--analytical-storage-schema-type {FullFidelity, WellDefined}]
                   [--backup-interval]
                   [--backup-policy-type {Continuous, Periodic}]
                   [--backup-redundancy {Geo, Local, Zone}]
                   [--backup-retention]
                   [--capabilities]
                   [--continuous-tier {Continuous30Days, Continuous7Days}]
                   [--default-consistency-level {BoundedStaleness, ConsistentPrefix, Eventual, Session, Strong}]
                   [--default-identity]
                   [--default-priority-level {High, Low}]
                   [--disable-key-based-metadata-write-access {false, true}]
                   [--enable-analytical-storage {false, true}]
                   [--enable-automatic-failover {false, true}]
                   [--enable-burst-capacity {false, true}]
                   [--enable-materialized-views {false, true}]
                   [--enable-multiple-write-locations {false, true}]
                   [--enable-partition-merge {false, true}]
                   [--enable-pbe {false, true}]
                   [--enable-prpp-autoscale {false, true}]
                   [--enable-virtual-network {false, true}]
                   [--ids]
                   [--ip-range-filter]
                   [--locations]
                   [--max-interval]
                   [--max-staleness-prefix]
                   [--name]
                   [--network-acl-bypass {AzureServices, None}]
                   [--network-acl-bypass-resource-ids]
                   [--public-network-access {DISABLED, ENABLED, SECUREDBYPERIMETER}]
                   [--resource-group]
                   [--server-version {3.2, 3.6, 4.0, 4.2}]
                   [--subscription]
                   [--tags]
                   [--virtual-network-rules]

示例

更新 Azure Cosmos DB 数据库帐户。（自动生成）

az cosmosdb update --capabilities EnableGremlin --name MyCosmosDBDatabaseAccount --resource-group MyResourceGroup

更新 Azure Cosmos DB 数据库帐户以启用具体化视图。

az cosmosdb update --name MyCosmosDBDatabaseAccount --resource-group MyResourceGroup --enable-materialized-views true

可选参数

--analytical-storage-schema-type --as-schema

分析存储的架构类型。

接受的值: FullFidelity, WellDefined

--backup-interval

创建备份的频率（以分钟为单位）（仅适用于定期模式备份的帐户）。

--backup-policy-type

要创建的帐户的备份策略的类型。

接受的值: Continuous, Periodic

--backup-redundancy

备份存储帐户的冗余类型。

接受的值: Geo, Local, Zone

--backup-retention

保留每个备份的时间（以小时为单位）（仅适用于定期模式备份的帐户）。

--capabilities

在 Cosmos DB 数据库帐户上设置自定义功能。

--continuous-tier

连续备份的层。

接受的值: Continuous30Days, Continuous7Days

--default-consistency-level

Cosmos DB 数据库帐户的默认一致性级别。

接受的值: BoundedStaleness, ConsistentPrefix, Eventual, Session, Strong

--default-identity

用于访问 CMK 相关功能中的密钥保管库的主要标识。例如“FirstPartyIdentity”、“SystemAssignedIdentity”等。

--default-priority-level

预览

如果未指定，则默认的请求优先级。

接受的值: High, Low

--disable-key-based-metadata-write-access

通过帐户密钥对元数据资源（数据库、容器、吞吐量）禁用写入操作。

接受的值: false, true

--enable-analytical-storage

用于在帐户上启用日志存储的标志。

接受的值: false, true

--enable-automatic-failover

接受的值: false, true

--enable-burst-capacity

预览

用于在帐户上启用突发容量的标志。

接受的值: false, true

--enable-materialized-views --enable-mv

预览

用于在帐户上启用 MaterializedViews 的标志。

接受的值: false, true

--enable-multiple-write-locations

启用多个写入位置。

接受的值: false, true

--enable-partition-merge

用于在帐户上启用分区合并的标志。

接受的值: false, true

--enable-pbe --enable-priority-based-execution

预览

标志以启用基于帐户执行的优先级。

接受的值: false, true

--enable-prpp-autoscale

预览

启用或禁用 PerRegionPerPartitionAutoscale。

接受的值: false, true

--enable-virtual-network

在 Cosmos DB 数据库帐户上启用虚拟网络。

接受的值: false, true

--ids

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

--ip-range-filter

--locations

将位置添加到 Cosmos DB 数据库帐户。

--max-interval

与有限过期一致性一起使用时，此值表示允许的过期时间（以秒为单位）。此值的接受范围为 1 - 100。

--max-staleness-prefix

与有限过期一致性一起使用时，此值表示允许的过时请求数。此值的接受范围为 1 - 2,147,483,647。

--name -n

Cosmos DB 数据库帐户的名称。

--network-acl-bypass

用于启用或禁用网络 Acl 旁路的标志。

接受的值: AzureServices, None

--network-acl-bypass-resource-ids -i

允许绕过网络 Acl 的资源 ID 列表。

--public-network-access -p

将服务器中的公用网络访问设置为“已启用”、“已禁用”或“SecuredByPerimeter”。

接受的值: DISABLED, ENABLED, SECUREDBYPERIMETER

--resource-group -g

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

--server-version

仅适用于 MongoDB 帐户。

接受的值: 3.2, 3.6, 4.0, 4.2

--subscription

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

--tags

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

--virtual-network-rules

ACL 用于虚拟网络。

全局参数

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

命令

az cosmosdb check-name-exists

示例

可选参数

az cosmosdb create

示例

必需参数

可选参数

az cosmosdb create (cosmosdb-preview 扩展)

示例

必需参数

可选参数

az cosmosdb delete

示例

可选参数

az cosmosdb failover-priority-change

示例

必需参数

可选参数

az cosmosdb list

可选参数

az cosmosdb list (cosmosdb-preview 扩展)

可选参数

az cosmosdb list-connection-strings

示例

可选参数

az cosmosdb list-keys

示例

可选参数

az cosmosdb list-read-only-keys

示例

可选参数

az cosmosdb regenerate-key

示例

必需参数

可选参数

az cosmosdb restore

示例

必需参数

可选参数

az cosmosdb restore (cosmosdb-preview 扩展)

示例

必需参数

可选参数

az cosmosdb show

示例

可选参数

az cosmosdb show (cosmosdb-preview 扩展)

示例

可选参数

az cosmosdb update

示例

可选参数

az cosmosdb update (cosmosdb-preview 扩展)

示例

可选参数

反馈

其他资源