Share via

az synapse role assignment

  • リファレンス

Synapse のロールの割り当てを管理します。

コマンド

名前 説明 型 Status
az synapse role assignment create

ロールの割り当てを作成します。

 コア GA
az synapse role assignment delete

ワークスペースのロールの割り当てを削除します。

 コア GA
az synapse role assignment list

ロールの割り当てを一覧表示します。

 コア GA
az synapse role assignment show

ID でロールの割り当てを取得します。

 コア GA

az synapse role assignment create

編集

ロールの割り当てを作成します。

az synapse role assignment create --role
                                  --workspace-name
                                  [--assignee]
                                  [--assignee-object-id]
                                  [--assignee-principal-type {Group, ServicePrincipal, User}]
                                  [--assignment-id]
                                  [--item]
                                  [--item-type {bigDataPools, credentials, integrationRuntimes, linkedServices}]
                                  [--scope]

例

サービス プリンシパル名を使用してロールの割り当てを作成します。

az synapse role assignment create --workspace-name testsynapseworkspace \
--role "Synapse Administrator" --assignee sp_name

ユーザー プリンシパル名を使用してロールの割り当てを作成します。

az synapse role assignment create --workspace-name testsynapseworkspace \
--role "Synapse Administrator" --assignee username@contoso.com

ユーザー、グループ、またはサービス プリンシパルの objectId を使用してロールの割り当てを作成します。

az synapse role assignment create --workspace-name testsynapseworkspace \
--role "Synapse Administrator" --assignee 00000000-0000-0000-0000-000000000000

スコープでロールの割り当てを作成します。

az synapse role assignment create --workspace-name testsynapseworkspace \
--scope "workspaces/{workspaceName}" --role "Synapse Administrator" --assignee username@contoso.com

アイテムの種類とアイテム名の組み合わせのスコープでロールの割り当てを作成します。

az synapse role assignment create --workspace-name testsynapseworkspace \
--item-type "bigDataPools" --item "bigDataPoolName" --role "Synapse Administrator" \
--assignee username@contoso.com

ワークスペースで Azure RBAC ロールの割り当てを管理するアクセス許可を持つユーザーであり、Synapse 管理istrator ではない場合は、-role roleid によるロールの割り当てを作成してください。 その理由は、"Synapse 管理istrator" ロールを追加しようとすると、コマンドレットは、現在のユーザーが持っていないワークスペースの読み取りアクセス許可を必要とするロール名からロール ID を取得する必要があります。

az synapse role assignment create \
--workspace-name testsynapseworkspace \
--role "6e4bf58a-b8e1-4cc3-bbf9-d73143322b78" \
--assignee username@contoso.com

必須のパラメーター

--role

プリンシパルに割り当てられているロール名/ID。

--workspace-name

ワークスペース名。

省略可能のパラメーター

--assignee

ユーザーまたはサービス プリンシパルを表します。 サポートされている形式: オブジェクト ID、ユーザー サインイン名、またはサービス プリンシパル名。

--assignee-object-id

特権が不十分な場合に Graph API 呼び出しをバイパスするには、'--assignee' の代わりにこのパラメーターを使用します。 このパラメーターは、ユーザー、グループ、サービス プリンシパル、およびマネージド ID のオブジェクト ID でのみ機能します。 マネージド ID の場合は、プリンシパル ID を使用します。サービス プリンシパルの場合は、アプリ ID ではなくオブジェクト ID を使用します。

--assignee-principal-type --assignee-type

AAD Graph の伝達待機時間によって発生するエラーを回避するには、--assignee-object-id と共に使用します。

承認された値: Group, ServicePrincipal, User
--assignment-id

GUID 形式のカスタム ロールの割り当て ID が指定されていない場合は、割り当て ID がランダムに生成されます。

--item

ワークスペースでアクセス権が付与されたアイテム。 --item-type と共に使用して割り当てのスコープを組み合わせる。

--item-type

ワークスペースでアクセス権が付与されたアイテムの種類。 --item と共に使用して割り当てのスコープを組み合わせる。

承認された値: bigDataPools, credentials, integrationRuntimes, linkedServices
--scope

"スコープ" は、アクセスが適用されるリソースまたは成果物を定義します。 Synapse では、階層型スコープがサポートされています。 上位のスコープで付与されたアクセス許可は、下位のオブジェクトによって継承されます。 Synapse RBAC では、最上位のスコープはワークスペースです。 ワークスペース スコープでロールを割り当てると、ワークスペース内の該当するすべてのオブジェクトにアクセス許可が付与されます。

グローバル パラメーター
--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 synapse role assignment delete

編集

ワークスペースのロールの割り当てを削除します。

az synapse role assignment delete --workspace-name
                                  [--assignee]
                                  [--assignee-object-id]
                                  [--ids]
                                  [--item]
                                  [--item-type {bigDataPools, credentials, integrationRuntimes, linkedServices}]
                                  [--role]
                                  [--scope]
                                  [--yes]

例

ロールと割り当て先ごとにロールの割り当てを削除します。

az synapse role assignment delete --workspace-name testsynapseworkspace \
--role "Synapse Administrator" --assignee sp_name

ロール ID/名前でロールの割り当てを削除します。

az synapse role assignment delete --workspace-name testsynapseworkspace \
--role "Synapse Administrator"

サービス プリンシパル名でロールの割り当てを削除します。

az synapse role assignment delete --workspace-name testsynapseworkspace \
--assignee sp_name

ユーザー プリンシパル名でロールの割り当てを削除します。

az synapse role assignment delete --workspace-name testsynapseworkspace \
--assignee username@contoso.com

ユーザー、グループ、またはサービス プリンシパルの objectId によってロールの割り当てを削除します。

az synapse role assignment delete --workspace-name testsynapseworkspace \
--assignee 00000000-0000-0000-0000-000000000001

ID でロールの割り当てを削除します。

az synapse role assignment delete --workspace-name testsynapseworkspace \
--ids 10000000-0000-0000-0000-10000000-10000000-0000-0000-0000-10000000

スコープ別にロールの割り当てを削除します。

az synapse role assignment delete --workspace-name testsynapseworkspace \
--scope "workspaces/testsynapseworkspace/linkedServices/testlinkedServices"

必須のパラメーター

--workspace-name

ワークスペース名。

省略可能のパラメーター

--assignee

ユーザーまたはサービス プリンシパルを表します。 サポートされている形式: オブジェクト ID、ユーザー サインイン名、またはサービス プリンシパル名。

--assignee-object-id

特権が不十分な場合に Graph API 呼び出しをバイパスするには、'--assignee' の代わりにこのパラメーターを使用します。 このパラメーターは、ユーザー、グループ、サービス プリンシパル、およびマネージド ID のオブジェクト ID でのみ機能します。 マネージド ID の場合は、プリンシパル ID を使用します。サービス プリンシパルの場合は、アプリ ID ではなくオブジェクト ID を使用します。

--ids

領域で区切られたロールの割り当て ID。 --ids が指定されている場合は、--role または --assignee を指定しないでください。

--item

ワークスペースでアクセス権が付与されたアイテム。 --item-type と共に使用して割り当てのスコープを組み合わせる。削除操作を実行する前に、az role assignment とフィルター条件を使用して、削除される割り当てを明確に認識します。

--item-type

ワークスペースでアクセス権が付与されたアイテムの種類。 --item と共に使用して割り当てのスコープを組み合わせる。削除操作を実行する前に、az role assignment とフィルター条件を使用して、削除される割り当てを明確に認識します。

承認された値: bigDataPools, credentials, integrationRuntimes, linkedServices
--role

プリンシパルに割り当てられているロール名/ID。

--scope

"スコープ" は、アクセスが適用されるリソースまたは成果物を定義します。 Synapse では、階層型スコープがサポートされています。 上位のスコープで付与されたアクセス許可は、下位のオブジェクトによって継承されます。 Synapse RBAC では、最上位のスコープはワークスペースです。 削除操作を実行する前に、az role assignment とフィルター条件を使用して、削除される割り当てを明確に認識します。

--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 synapse role assignment list

編集

ロールの割り当てを一覧表示します。

az synapse role assignment list --workspace-name
                                [--assignee]
                                [--assignee-object-id]
                                [--item]
                                [--item-type {bigDataPools, credentials, integrationRuntimes, linkedServices}]
                                [--role]
                                [--scope]

例

ロールの割り当てを一覧表示します。

az synapse role assignment list --workspace-name testsynapseworkspace

ロール ID/名前でロールの割り当てを一覧表示します。

az synapse role assignment list --workspace-name testsynapseworkspace \
--role "Synapse Apache Spark Administrator"

担当者別にロールの割り当てを一覧表示します。

az synapse role assignment list --workspace-name testsynapseworkspace \
--assignee sp_name

ユーザー、グループ、またはサービス プリンシパルの objectId でロールの割り当てを一覧表示します。

az synapse role assignment list --workspace-name testsynapseworkspace \
--assignee-object-id 00000000-0000-0000-0000-000000000000

スコープ別にロールの割り当てを一覧表示します。

az synapse role assignment list --workspace-name testsynapseworkspace \
--scope "workspaces/{workspaceName}"

アイテムの種類とアイテム名ごとにロールの割り当てを一覧表示します。

az synapse role assignment list --workspace-name testsynapseworkspace \
--item-type "bigDataPools" --item "bigDataPoolName"

必須のパラメーター

--workspace-name

ワークスペース名。

省略可能のパラメーター

--assignee

ユーザーまたはサービス プリンシパルを表します。 サポートされている形式: オブジェクト ID、ユーザー サインイン名、またはサービス プリンシパル名。

--assignee-object-id

特権が不十分な場合に Graph API 呼び出しをバイパスするには、'--assignee' の代わりにこのパラメーターを使用します。 このパラメーターは、ユーザー、グループ、サービス プリンシパル、およびマネージド ID のオブジェクト ID でのみ機能します。 マネージド ID の場合は、プリンシパル ID を使用します。サービス プリンシパルの場合は、アプリ ID ではなくオブジェクト ID を使用します。

--item

ワークスペースでアクセス権が付与されたアイテム。 --item-type と共に使用して割り当てのスコープを組み合わせる。

--item-type

ワークスペースでアクセス権が付与されたアイテムの種類。 --item と共に使用して割り当てのスコープを組み合わせる。

承認された値: bigDataPools, credentials, integrationRuntimes, linkedServices
--role

プリンシパルに割り当てられているロール名/ID。

--scope

"スコープ" は、アクセスが適用されるリソースまたは成果物を定義します。 Synapse では、階層型スコープがサポートされています。 上位のスコープで付与されたアクセス許可は、下位のオブジェクトによって継承されます。 Synapse RBAC では、最上位のスコープはワークスペースです。 ワークスペース スコープでロールを割り当てると、ワークスペース内の該当するすべてのオブジェクトにアクセス許可が付与されます。

グローバル パラメーター
--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 synapse role assignment show

編集

ID でロールの割り当てを取得します。

az synapse role assignment show --id
                                --workspace-name

例

ID でロールの割り当てを取得します。

az synapse role assignment show --workspace-name testsynapseworkspace \
--id 00000000-0000-0000-0000-000000000000

必須のパラメーター

--id

プリンシパルに割り当てられているロールの ID。

--workspace-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 を使います。