通过

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

az cosmosdb mongodb user definition

  • 参考

注意

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

管理 Azure Cosmos DB Mongo 用户定义。

命令

名称 说明 类型 Status
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 mongodb user definition create

编辑

在 Azure Cosmos DB 帐户下创建 Mongo DB 用户定义。

az cosmosdb mongodb user definition create --account-name
                                           --body
                                           --resource-group

示例

使用 JSON 字符串在 Azure Cosmos DB 帐户下创建 Mongo DB 用户定义。

az cosmosdb mongodb user definition create --account-name MyAccount --resource-group MyResourceGroup --body '{
  "Id": "MyDB.MyUName",
  "UserName": "MyUName",
  "Password": "MyPass",
  "DatabaseName": "MyDB",
  "CustomData": "TestCustomData",
  "Mechanisms": "SCRAM-SHA-256",
  "Roles": [
    {
      "Role": "myReadRole",
      "Db": "MyDB"
    }
  ]
}'

使用 JSON 文件在 Azure Cosmos DB 帐户下创建 Mongo DB 用户定义。

az cosmosdb mongodb user definition create --account-name MyAccount --resource-group MyResourceGroup --body @mongo-user-definition.json

必需参数

--account-name -a

Cosmosdb 帐户名称。

--body -b

具有 ID 的用户定义正文（可选用于创建）、UserName、Password、DatabaseName、CustomData、机制、角色。 可以将其输入为字符串或文件，例如 --body @mongo-user_definition-body-file.json 或 --body “{”Id“： ”be79875a-2cc4-40d5-8958-566017875b39“，”UserName“： ”MyUserName“，”Password“： MyPass”，“CustomData”： “MyCustomData”，“Mechanisms”： “SCRAM-SHA-256”“DatabaseName”： “MyDb”，“Roles”： [ {“Role”： “myReadRole”，“Db”： “MyDb”}]}”。

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

在 Azure Cosmos DB 帐户下创建 Mongo DB 用户定义。

az cosmosdb mongodb user definition create --account-name
                                           --body
                                           --resource-group

示例

使用 JSON 字符串在 Azure Cosmos DB 帐户下创建 Mongo DB 用户定义。

az cosmosdb mongodb user definition create --account-name MyAccount --resource-group MyResourceGroup --body '{
  "Id": "MyDB.MyUName",
  "UserName": "MyUName",
  "Password": "MyPass",
  "DatabaseName": "MyDB",
  "CustomData": "TestCustomData",
  "Mechanisms": "SCRAM-SHA-256",
  "Roles": [
    {
      "Role": "myReadRole",
      "Db": "MyDB"
    }
  ]
}'

使用 JSON 文件在 Azure Cosmos DB 帐户下创建 Mongo DB 用户定义。

az cosmosdb mongodb user definition create --account-name MyAccount --resource-group MyResourceGroup --body @mongo-user-definition.json

必需参数

--account-name -a

Cosmosdb 帐户名称。

--body -b

具有 ID 的用户定义正文（可选用于创建）、UserName、Password、DatabaseName、CustomData、机制、角色。 可以将其输入为字符串或文件，例如 --body 或 --body @mongo-user_definition-body-file.json “{ ”Id“： ”be79875a-2cc4-40d5-8958-566017875b39“， ”UserName“： ”MyUserName“， ”Password“： ”MyPass“， ”CustomData“： ”MyCustomData“， ”Mechanisms“： ”SCRAM-SHA-256“ ”DatabaseName“： ”MyDb“， ”Roles“： [ {”Role“： ”myReadRole“，”Db“： ”MyDb“}] }”。

--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 mongodb user definition delete

编辑

删除 Azure Cosmos DB 帐户下的 CosmosDb MongoDb 用户定义。

az cosmosdb mongodb user definition delete --account-name
                                           --id
                                           --resource-group
                                           [--yes]

示例

删除 Azure Cosmos DB 帐户下的 Mongo 用户定义。

az cosmosdb mongodb user definition delete --account-name MyAccount --resource-group MyResourceGroup --id be79875a-2cc4-40d5-8958-566017875b39

必需参数

--account-name -a

Cosmosdb 帐户名称。

--id -i

Mongo 用户定义的唯一 ID。

--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 mongodb user definition delete (cosmosdb-preview 扩展)

删除 Azure Cosmos DB 帐户下的 CosmosDb MongoDb 用户定义。

az cosmosdb mongodb user definition delete --account-name
                                           --id
                                           --resource-group
                                           [--yes]

示例

删除 Azure Cosmos DB 帐户下的 Mongo 用户定义。

az cosmosdb mongodb user definition delete --account-name MyAccount --resource-group MyResourceGroup --id be79875a-2cc4-40d5-8958-566017875b39

必需参数

--account-name -a

Cosmosdb 帐户名称。

--id -i

Mongo 用户定义的唯一 ID。

--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 mongodb user definition exists

编辑

检查 Azure Cosmos DB MongoDb 用户定义是否存在。

az cosmosdb mongodb user definition exists --account-name
                                           --id
                                           --resource-group

示例

检查 Azure Cosmos DB MongoDb 用户定义是否存在。

az cosmosdb mongodb user definition exists --account-name MyAccount --resource-group MyResourceGroup --id be79875a-2cc4-40d5-8958-566017875b39

必需参数

--account-name -a

Cosmosdb 帐户名称。

--id -i

Mongo 用户定义的唯一 ID。

--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 mongodb user definition exists (cosmosdb-preview 扩展)

检查 Azure Cosmos DB MongoDb 用户定义是否存在。

az cosmosdb mongodb user definition exists --account-name
                                           --id
                                           --resource-group

示例

检查 Azure Cosmos DB MongoDb 用户定义是否存在。

az cosmosdb mongodb user definition exists --account-name MyAccount --resource-group MyResourceGroup --id be79875a-2cc4-40d5-8958-566017875b39

必需参数

--account-name -a

Cosmosdb 帐户名称。

--id -i

Mongo 用户定义的唯一 ID。

--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 mongodb user definition list

编辑

列出 Azure Cosmos DB 帐户下的所有 MongoDb 用户定义。

az cosmosdb mongodb user definition list --account-name
                                         --resource-group

示例

列出 Azure Cosmos DB 帐户下的所有 Mongodb 用户定义。

az cosmosdb mongodb user definition 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 mongodb user definition list (cosmosdb-preview 扩展)

列出 Azure Cosmos DB 帐户下的所有 MongoDb 用户定义。

az cosmosdb mongodb user definition list --account-name
                                         --resource-group

示例

列出 Azure Cosmos DB 帐户下的所有 Mongodb 用户定义。

az cosmosdb mongodb user definition 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 mongodb user definition show

编辑

显示 Azure Cosmos DB 帐户下 MongoDb 用户定义的属性。

az cosmosdb mongodb user definition show --account-name
                                         --id
                                         --resource-group

示例

显示 Azure Cosmos DB 帐户下 MongoDb 用户定义的属性。

az cosmosdb mongodb user definition show --account-name MyAccount --resource-group MyResourceGroup --id be79875a-2cc4-40d5-8958-566017875b39

必需参数

--account-name -a

Cosmosdb 帐户名称。

--id -i

Mongo 用户定义的唯一 ID。

--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 mongodb user definition show (cosmosdb-preview 扩展)

显示 Azure Cosmos DB 帐户下 MongoDb 用户定义的属性。

az cosmosdb mongodb user definition show --account-name
                                         --id
                                         --resource-group

示例

显示 Azure Cosmos DB 帐户下 MongoDb 用户定义的属性。

az cosmosdb mongodb user definition show --account-name MyAccount --resource-group MyResourceGroup --id be79875a-2cc4-40d5-8958-566017875b39

必需参数

--account-name -a

Cosmosdb 帐户名称。

--id -i

Mongo 用户定义的唯一 ID。

--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 mongodb user definition update

编辑

在 Azure Cosmos DB 帐户下更新 MongoDb 用户定义。

az cosmosdb mongodb user definition update --account-name
                                           --body
                                           --resource-group

示例

在 Azure Cosmos DB 帐户下更新 MongoDb 用户定义。

az cosmosdb mongodb user definition update --account-name MyAccount --resource-group MyResourceGroup --body @mongo-user-definition.json

必需参数

--account-name -a

Cosmosdb 帐户名称。

--body -b

具有 ID 的用户定义正文（可选用于创建）、UserName、Password、DatabaseName、CustomData、机制、角色。 可以将其输入为字符串或文件，例如 --body @mongo-user_definition-body-file.json 或 --body “{”Id“： ”be79875a-2cc4-40d5-8958-566017875b39“，”UserName“： ”MyUserName“，”Password“： MyPass”，“CustomData”： “MyCustomData”，“Mechanisms”： “SCRAM-SHA-256”“DatabaseName”： “MyDb”，“Roles”： [ {“Role”： “myReadRole”，“Db”： “MyDb”}]}”。

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

在 Azure Cosmos DB 帐户下更新 MongoDb 用户定义。

az cosmosdb mongodb user definition update --account-name
                                           --body
                                           --resource-group

示例

在 Azure Cosmos DB 帐户下更新 MongoDb 用户定义。

az cosmosdb mongodb user definition update --account-name MyAccount --resource-group MyResourceGroup --body @mongo-user-definition.json

必需参数

--account-name -a

Cosmosdb 帐户名称。

--body -b

具有 ID 的用户定义正文（可选用于创建）、UserName、Password、DatabaseName、CustomData、机制、角色。 可以将其输入为字符串或文件，例如 --body 或 --body @mongo-user_definition-body-file.json “{ ”Id“： ”be79875a-2cc4-40d5-8958-566017875b39“， ”UserName“： ”MyUserName“， ”Password“： ”MyPass“， ”CustomData“： ”MyCustomData“， ”Mechanisms“： ”SCRAM-SHA-256“ ”DatabaseName“： ”MyDb“， ”Roles“： [ {”Role“： ”myReadRole“，”Db“： ”MyDb“}] }”。

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