az cosmosdb sql role assignment

  • リファレンス

Azure Cosmos DB SQL ロールの割り当てを管理します。

コマンド

名前 説明 型 Status
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 assignment create

編集

Azure Cosmos DB アカウントで SQL ロールの割り当てを作成します。

az cosmosdb sql role assignment create --account-name
                                       --principal-id
                                       --resource-group
                                       --scope
                                       [--no-wait]
                                       [--role-assignment-id]
                                       [--role-definition-id]
                                       [--role-definition-name]

例

ロール定義名を使用して、Azure Cosmos DB アカウントで SQL ロールの割り当てを作成します。

az cosmosdb sql role assignment create --account-name MyAccount --resource-group MyResourceGroup \
  --role-assignment-id cb8ed2d7-2371-4e3c-bd31-6cc1560e84f8 \
  --role-definition-name "My Read Only Role" \
  --scope "/dbs/mydb/colls/mycontainer" \
  --principal-id 6328f5f7-dbf7-4244-bba8-fbb9d8066506

ロール定義 ID を使用して、Azure Cosmos DB アカウントで SQL ロールの割り当てを作成します。

az cosmosdb sql role assignment create --account-name MyAccount --resource-group MyResourceGroup \
  --role-assignment-id cb8ed2d7-2371-4e3c-bd31-6cc1560e84f8 \
  --role-definition-id be79875a-2cc4-40d5-8958-566017875b39 \
  --scope "/dbs/mydb/colls/mycontainer" \
  --principal-id 6328f5f7-dbf7-4244-bba8-fbb9d8066506

必須のパラメーター

--account-name -a

Cosmosdb アカウント名。

--principal-id -p

このロールの割り当てが付与されているプリンシパルの AAD オブジェクト ID。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--scope -s

このロールの割り当てが付与されているデータ プレーン リソース パス。

省略可能のパラメーター

--no-wait

実行時間の長い操作の終了を待機しません。

既定値: False
--role-assignment-id -i

[作成] には省略可能です。 ロールの割り当ての一意の ID。 指定しない場合は、新しい GUID が使用されます。

--role-definition-id -d

このロール割り当てが参照するロール定義の一意の ID。

--role-definition-name -n

このロールの割り当てが参照するロール定義の一意の名前。 例: "Contoso 閲覧者ロール"。

グローバル パラメーター
--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc
既定値: json
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az cosmosdb sql role assignment delete

編集

Azure Cosmos DB アカウントで SQL ロールの割り当てを削除します。

az cosmosdb sql role assignment delete --account-name
                                       --resource-group
                                       --role-assignment-id
                                       [--no-wait]
                                       [--yes]

例

Azure Cosmos DB アカウントで SQL ロールの割り当てを削除します。

az cosmosdb sql role assignment delete --account-name MyAccount --resource-group MyResourceGroup --role-assignment-id cb8ed2d7-2371-4e3c-bd31-6cc1560e84f8

必須のパラメーター

--account-name -a

Cosmosdb アカウント名。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--role-assignment-id -i

[作成] には省略可能です。 ロールの割り当ての一意の ID。 指定しない場合は、新しい GUID が使用されます。

省略可能のパラメーター

--no-wait

実行時間の長い操作の終了を待機しません。

既定値: False
--yes -y

確認のダイアログを表示しません。

既定値: False
グローバル パラメーター
--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc
既定値: json
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az cosmosdb sql role assignment exists

編集

Azure Cosmos DB ロールの割り当てが存在するかどうかを確認します。

az cosmosdb sql role assignment exists --account-name
                                       --resource-group
                                       --role-assignment-id

例

Azure Cosmos DB ロールの割り当てが存在するかどうかを確認します。

az cosmosdb sql role assignment exists --account-name MyAccount --resource-group MyResourceGroup --role-assignment-id cb8ed2d7-2371-4e3c-bd31-6cc1560e84f8

必須のパラメーター

--account-name -a

Cosmosdb アカウント名。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--role-assignment-id -i

[作成] には省略可能です。 ロールの割り当ての一意の ID。 指定しない場合は、新しい GUID が使用されます。

グローバル パラメーター
--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc
既定値: json
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az cosmosdb sql role assignment list

編集

Azure Cosmos DB アカウントのすべての SQL ロールの割り当てを一覧表示します。

az cosmosdb sql role assignment list --account-name
                                     --resource-group

例

Azure Cosmos DB アカウントのすべての SQL ロールの割り当てを一覧表示します。

az cosmosdb sql role assignment list --account-name MyAccount --resource-group MyResourceGroup

必須のパラメーター

--account-name -a

Cosmosdb アカウント名。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

グローバル パラメーター
--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc
既定値: json
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az cosmosdb sql role assignment show

編集

Azure Cosmos DB アカウントの下に SQL ロールの割り当てのプロパティを表示します。

az cosmosdb sql role assignment show --account-name
                                     --resource-group
                                     --role-assignment-id

例

Azure Cosmos DB アカウントの下に SQL ロールの割り当てのプロパティを表示します。

az cosmosdb sql role assignment show --account-name MyAccount --resource-group MyResourceGroup --role-assignment-id cb8ed2d7-2371-4e3c-bd31-6cc1560e84f8

必須のパラメーター

--account-name -a

Cosmosdb アカウント名。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--role-assignment-id -i

[作成] には省略可能です。 ロールの割り当ての一意の ID。 指定しない場合は、新しい GUID が使用されます。

グローバル パラメーター
--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc
既定値: json
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az cosmosdb sql role assignment update

編集

Azure Cosmos DB アカウントで SQL ロールの割り当てを更新します。

az cosmosdb sql role assignment update --account-name
                                       --resource-group
                                       --role-assignment-id
                                       [--no-wait]
                                       [--principal-id]
                                       [--role-definition-id]
                                       [--role-definition-name]
                                       [--scope]

例

Azure Cosmos DB アカウントで SQL ロールの割り当てを更新します。

az cosmosdb sql role assignment update --account-name MyAccount --resource-group MyResourceGroup \
  --role-assignment-id cb8ed2d7-2371-4e3c-bd31-6cc1560e84f8 \
  --role-definition-id updated-role-definition-id

必須のパラメーター

--account-name -a

Cosmosdb アカウント名。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--role-assignment-id -i

[作成] には省略可能です。 ロールの割り当ての一意の ID。 指定しない場合は、新しい GUID が使用されます。

省略可能のパラメーター

--no-wait

実行時間の長い操作の終了を待機しません。

既定値: False
--principal-id -p

このロールの割り当てが付与されているプリンシパルの AAD オブジェクト ID。

--role-definition-id -d

このロール割り当てが参照するロール定義の一意の ID。

--role-definition-name -n

このロールの割り当てが参照するロール定義の一意の名前。 例: "Contoso 閲覧者ロール"。

--scope -s

このロールの割り当てが付与されているデータ プレーン リソース パス。

グローバル パラメーター
--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc
既定値: json
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az cosmosdb sql role assignment wait

編集

特定の条件が満たされるまで、SQL ロールの割り当てをポーリングします。

az cosmosdb sql role assignment wait --account-name
                                     --resource-group
                                     --role-assignment-id
                                     [--created]
                                     [--custom]
                                     [--deleted]
                                     [--exists]
                                     [--interval]
                                     [--timeout]
                                     [--updated]

例

SQL ロールの割り当てが削除されるまでポーリングします。

az cosmosdb sql role assignment wait --account-name MyAccount --resource-group MyResourceGroup --role-assignment-id cb8ed2d7-2371-4e3c-bd31-6cc1560e84f8 --deleted

必須のパラメーター

--account-name -a

Cosmosdb アカウント名。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--role-assignment-id -i

[作成] には省略可能です。 ロールの割り当ての一意の ID。 指定しない場合は、新しい GUID が使用されます。

省略可能のパラメーター

--created

'provisioningState' が 'Succeeded' で作成されるまで待ちます。

既定値: False
--custom

条件がカスタム JMESPath クエリを満たすまで待ちます。 例: provisioningState!='InProgress'、instanceView.statuses[?code=='PowerState/running']。

--deleted

削除されるまで待ちます。

既定値: False
--exists

リソースが存在するまで待ちます。

既定値: False
--interval

ポーリング間隔 (秒単位)。

既定値: 30
--timeout

最大待機時間 (秒単位)。

既定値: 3600
--updated

provisioningState が 'Succeeded' で更新されるまで待ちます。

既定値: 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 を使います。