az synapse role assignment

參考

管理 Synapse 的角色指派。

命令

名稱	Description	類型	狀態
az synapse role assignment create	建立角色指派。	核心	GA
az synapse role assignment delete	刪除工作區的角色指派。	核心	GA
az synapse role assignment list	列出角色指派。	核心	GA
az synapse role assignment show	依識別碼取得角色指派。	核心	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

使用 User、Group 或服務主體的 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 的使用者時，請依 -roleid 建立角色分派。原因是，當您嘗試新增「Synapse 管理員istrator」角色時，Cmdlet 必須從需要工作區讀取權限的角色名稱取得角色識別碼，而該角色名稱需要工作區讀取權限，而目前使用者沒有該角色名稱。

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

必要參數

--role

指派給主體的角色名稱/識別碼。

--workspace-name

工作區名稱。

選擇性參數

--assignee

代表使用者或服務主體。支援的格式：物件識別碼、使用者登入名稱或服務主體名稱。

--assignee-object-id

如果許可權不足，請使用此參數而非 '--assignee' 來略過圖形 API 呼叫。此參數僅適用于使用者、群組、服務主體和受控識別的物件識別碼。針對受控識別，請使用主體識別碼。針對服務主體，請使用物件識別碼，而不是應用程式識別碼。

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

與 --assignee-object-id 搭配使用，以避免 AAD Graph 中傳播延遲所造成的錯誤。

接受的值: Group, ServicePrincipal, User

--assignment-id

若未指定，則會隨機產生以 guid 格式的自訂角色指派識別碼。

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

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

依角色識別碼/名稱刪除角色指派。

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

依 User、Group 或服務主體的 objectId 刪除角色指派。

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

依識別碼刪除角色指派。

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

代表使用者或服務主體。支援的格式：物件識別碼、使用者登入名稱或服務主體名稱。

--assignee-object-id

--ids

以空格分隔的角色指派識別碼。提供 --ids 時，您不應該提供 --role 或 --assignee。

--item

在工作區中授與存取權的專案。使用與 --item-type 結合指派的範圍。在執行刪除作業之前，請先搭配篩選準則使用 az role assignment，以便清楚知道要刪除哪些指派。

--item-type

工作區中授與存取權的專案類型。使用與 --item 結合指派的範圍。在執行刪除作業之前，請先搭配篩選準則使用 az role assignment，以便清楚知道要刪除哪些指派。

接受的值: bigDataPools, credentials, integrationRuntimes, linkedServices

--role

指派給主體的角色名稱/識別碼。

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

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

依角色識別碼/名稱列出角色指派。

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

依被指派者列出角色指派。

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

依 User、Group 或服務主體的 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

代表使用者或服務主體。支援的格式：物件識別碼、使用者登入名稱或服務主體名稱。

--assignee-object-id

--item

在工作區中授與存取權的專案。使用與 --item-type 結合指派的範圍。

--item-type

工作區中授與存取權的專案類型。使用與 --item 結合指派的範圍。

接受的值: bigDataPools, credentials, integrationRuntimes, linkedServices

--role

指派給主體的角色名稱/識別碼。

--scope

全域參數

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

編輯

依識別碼取得角色指派。

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

範例

依識別碼取得角色指派。

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

必要參數

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

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

--verbose

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

共用方式為

az synapse role assignment

命令

az synapse role assignment create

範例

必要參數

選擇性參數

az synapse role assignment delete

範例

必要參數

選擇性參數

az synapse role assignment list

範例

必要參數

選擇性參數

az synapse role assignment show

範例

必要參數

其他資源