az cosmosdb mongodb user definition

注意

此命令群組具有 Azure CLI 和至少一個擴充功能中定義的命令。 安裝每個擴充功能以受益于其擴充功能。 深入了解擴充功能。

管理 Azure Cosmos DB Mongo 使用者定義。

命令

名稱	Description	類型	狀態
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

具有識別碼的使用者定義主體（選擇性用於建立）、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

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 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

具有識別碼的使用者定義主體（選擇性用於建立）、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

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 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 使用者定義的唯一識別碼。

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

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 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 使用者定義的唯一識別碼。

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

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 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 使用者定義的唯一識別碼。

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

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 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 使用者定義的唯一識別碼。

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

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 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

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 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

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 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 使用者定義的唯一識別碼。

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

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 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 使用者定義的唯一識別碼。

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

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 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

具有識別碼的使用者定義主體（選擇性用於建立）、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

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 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

具有識別碼的使用者定義主體（選擇性用於建立）、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

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID 帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。