次の方法で共有

az cosmosdb gremlin role definition

Note

このリファレンスは、Azure CLI (バージョン 2.17.1 以降) の cosmosdb-preview 拡張機能の一部です。 拡張機能は、 az cosmosdb gremlin ロール定義 コマンドを初めて実行するときに自動的にインストールされます。 拡張機能の詳細については、 を参照してください。

Azure Cosmos DB Gremlin ロール定義を管理します。

コマンド

名前 説明 型 状態
az cosmosdb gremlin role definition create

Azure Cosmos DB アカウントの下に Gremlin ロール定義を作成します。

 Extension GA
az cosmosdb gremlin role definition delete

Azure Cosmos DB アカウントで Gremlin ロール定義を削除します。

 Extension GA
az cosmosdb gremlin role definition exists

Azure Cosmos DB ロール定義が存在するかどうかを確認します。

 Extension GA
az cosmosdb gremlin role definition list

Azure Cosmos DB アカウントのすべての Gremlin ロール定義を一覧表示します。

 Extension GA
az cosmosdb gremlin role definition show

Azure Cosmos DB アカウントの下に Gremlin ロール定義のプロパティを表示します。

 Extension GA
az cosmosdb gremlin role definition update

Azure Cosmos DB アカウントで Gremlin ロール定義を更新します。

 Extension GA

az cosmosdb gremlin role definition create

Azure Cosmos DB アカウントの下に Gremlin ロール定義を作成します。

az cosmosdb gremlin role definition create --account-name
                                           --body
                                           --resource-group

例

JSON 文字列を使用して、Azure Cosmos DB アカウントの下に Gremlin ロール定義を作成します。

az cosmosdb gremlin role definition create --account-name MyAccount --resource-group MyResourceGroup --body '{
  "Id": "be79875a-2cc4-40d5-8958-566017875b39",
  "RoleName": "My Read Only Role",
  "Type": "CustomRole",
  "AssignableScopes": ["/dbs/mydb/colls/mycontainer"],
  "Permissions": [{
    "DataActions": [
      "Microsoft.DocumentDB/databaseAccounts/readMetadata",
      "Microsoft.DocumentDB/databaseAccounts/gremlin/containers/entities/read",
      "Microsoft.DocumentDB/databaseAccounts/gremlin/containers/executeQuery",
      "Microsoft.DocumentDB/databaseAccounts/gremlin/containers/readChangeFeed"
    ]
  }]
}'

JSON ファイルを使用して、Azure Cosmos DB アカウントの下に Gremlin ロール定義を作成します。

az cosmosdb gremlin role definition create --account-name MyAccount --resource-group MyResourceGroup --body @role-definition.json

必須のパラメーター

--account-name -a

Cosmosdb アカウント名。

--body -b

ID を持つロール定義本文 (作成の場合は省略可能)、種類 (既定値は CustomRole)、RoleName、Description、AssignableScopes、Permissions。 文字列またはファイルとして入力できます(例: --body @gremlin-role_definition-body-file.json、--body "{ "Id": "be79875a-2cc4-40d5-8958-566017875b39"、"RoleName": "MyTestRole"、 "type": "CustomRole", "description": "AssignableScopes":["/subscriptions/{0}/resourceGroups/{1}/providers/Microsoft.DocumentDB/databaseAccounts/MyDBAccountName"], "Permissions": [{"dataActions": ["Microsoft.DocumentDB/databaseAccounts/readMetadata"}] }"

--resource-group -g

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

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

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ 値
規定値: False
--help -h

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

--only-show-errors

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

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ 値
規定値: False

az cosmosdb gremlin role definition delete

Azure Cosmos DB アカウントで Gremlin ロール定義を削除します。

az cosmosdb gremlin role definition delete --account-name
                                           --resource-group
                                           --role-definition-id
                                           [--yes]

例

Azure Cosmos DB アカウントで Gremlin ロール定義を削除します。

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

必須のパラメーター

--account-name -a

Cosmosdb アカウント名。

--resource-group -g

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

--role-definition-id -i

Gremlin ロール定義の一意の ID。

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--yes -y

確認を求めないでください。

プロパティ 値
規定値: False
グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ 値
規定値: False
--help -h

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

--only-show-errors

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

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ 値
規定値: False

az cosmosdb gremlin role definition exists

Azure Cosmos DB ロール定義が存在するかどうかを確認します。

az cosmosdb gremlin role definition exists --account-name
                                           --resource-group
                                           --role-definition-id

例

Azure Cosmos DB ロール定義が存在するかどうかを確認します。

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

必須のパラメーター

--account-name -a

Cosmosdb アカウント名。

--resource-group -g

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

--role-definition-id -i

Gremlin ロール定義の一意の ID。

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

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ 値
規定値: False
--help -h

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

--only-show-errors

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

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ 値
規定値: False

az cosmosdb gremlin role definition list

Azure Cosmos DB アカウントのすべての Gremlin ロール定義を一覧表示します。

az cosmosdb gremlin role definition list --account-name
                                         --resource-group

例

Azure Cosmos DB アカウントのすべての Gremlin ロール定義を一覧表示します。

az cosmosdb gremlin role definition list --account-name MyAccount --resource-group MyResourceGroup

必須のパラメーター

--account-name -a

Cosmosdb アカウント名。

--resource-group -g

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

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

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ 値
規定値: False
--help -h

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

--only-show-errors

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

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ 値
規定値: False

az cosmosdb gremlin role definition show

Azure Cosmos DB アカウントの下に Gremlin ロール定義のプロパティを表示します。

az cosmosdb gremlin role definition show --account-name
                                         --resource-group
                                         --role-definition-id

例

Azure Cosmos DB アカウントの下に Gremlin ロール定義のプロパティを表示します。

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

必須のパラメーター

--account-name -a

Cosmosdb アカウント名。

--resource-group -g

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

--role-definition-id -i

Gremlin ロール定義の一意の ID。

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

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ 値
規定値: False
--help -h

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

--only-show-errors

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

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ 値
規定値: False

az cosmosdb gremlin role definition update

Azure Cosmos DB アカウントで Gremlin ロール定義を更新します。

az cosmosdb gremlin role definition update --account-name
                                           --body
                                           --resource-group

例

Azure Cosmos DB アカウントで Gremlin ロール定義を更新します。

az cosmosdb gremlin role definition update --account-name MyAccount --resource-group MyResourceGroup --body @role-definition.json

必須のパラメーター

--account-name -a

Cosmosdb アカウント名。

--body -b

ID を持つロール定義本文 (作成の場合は省略可能)、種類 (既定値は CustomRole)、RoleName、Description、AssignableScopes、Permissions。 文字列またはファイルとして入力できます(例: --body @gremlin-role_definition-body-file.json、--body "{ "Id": "be79875a-2cc4-40d5-8958-566017875b39"、"RoleName": "MyTestRole"、 "type": "CustomRole", "description": "AssignableScopes":["/subscriptions/{0}/resourceGroups/{1}/providers/Microsoft.DocumentDB/databaseAccounts/MyDBAccountName"], "Permissions": [{"dataActions": ["Microsoft.DocumentDB/databaseAccounts/readMetadata"}] }"

--resource-group -g

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

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

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ 値
規定値: False
--help -h

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

--only-show-errors

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

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ 値
規定値: False