Connections - Update Connection Role Assignment
更新連線的主體角色指派。
Note
Fabric 租戶管理員連線管理目前處於預覽階段(了解更多)。
Permissions
呼叫端必須是網狀架構系統管理員,或使用服務主體進行驗證。
必要的委派範圍
Tenant.ReadWrite.All
Limitations
沒有其他限制。
Microsoft Entra 支援的身份識別
此 API 支援本節中列出的Microsoft 身分識別。
| Identity | Support |
|---|---|
| 使用者 | Yes |
| 服務主體 和 受控識別 | Yes |
Interface
PATCH https://api.fabric.microsoft.com/v1/admin/connections/{connectionId}/roleAssignments/{connectionRoleAssignmentId}
URI 參數
| 名稱 | 位於 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
connection
|
path | True |
string (uuid) |
連線ID。 |
|
connection
|
path | True |
string (uuid) |
連線角色分配的 ID。 |
要求本文
| 名稱 | 必要 | 類型 | Description |
|---|---|---|---|
| role | True |
主體的連接角色。 |
回覆
| 名稱 | 類型 | Description |
|---|---|---|
| 200 OK |
OK. 作業成功。 |
|
| 429 Too Many Requests |
服務費率上限被超標。 伺服器會回傳一個 標題 Retry-After: integer |
|
| Other Status Codes |
常見的錯誤碼:
|
範例
Update connection role assignment as admin example
範例要求
PATCH https://api.fabric.microsoft.com/v1/admin/connections/fe8e181d-dbb8-471a-99f0-fdbf0a2ad4fd/roleAssignments/43970761-afc9-4428-ae6e-3b08bef098ff
{
"role": "Owner"
}
範例回覆
{
"id": "43970761-afc9-4428-ae6e-3b08bef098ff",
"principal": {
"id": "43970761-afc9-4428-ae6e-3b08bef098ff",
"type": "User"
},
"role": "Owner"
}
定義
| 名稱 | Description |
|---|---|
|
Assignable |
一個連結角色。 可能會隨著時間新增其他連線角色。 |
|
Connection |
一個連結角色。 可能會隨著時間新增其他連線角色。 |
|
Connection |
主體的連接角色指派。 |
|
Entire |
代表租戶委託人 |
|
Error |
一個結構化參數,提供關於錯誤的額外機器可讀上下文。 |
|
Error |
錯誤相關的資源詳細資料物件。 |
|
Error |
錯誤回應。 |
|
Error |
錯誤回應的細節。 |
|
Group |
群組特定詳細數據。 當主體類型 |
|
Group |
代表一個安全小組。 |
|
Group |
群組的類型。 可能會隨著時間新增其他群組類型。 |
|
Principal |
主體的類型。 可能會隨著時間新增其他主體類型。 |
|
Service |
服務主體特定詳細數據。 當主體類型 |
|
Service |
代表 Microsoft Entra 服務主體。 |
|
Service |
服務主體配置檔詳細數據。 當主體類型 |
|
Service |
代表服務主體的設定檔。 |
|
Update |
更新連線角色指派要求承載。 |
|
User |
用戶主體特定詳細數據。 當主體類型 |
|
User |
代表 Microsoft Entra 使用者主體。 |
AssignableAdminConnectionRole
一個連結角色。 可能會隨著時間新增其他連線角色。
| 值 | Description |
|---|---|
| Owner |
使委託人能取得該連接權的所有權。 主體最初被指派為「待處理擁有者」角色,若要完成轉為「擁有者」,必須使用 更新連線 API 更新連線憑證。 |
ConnectionRole
一個連結角色。 可能會隨著時間新增其他連線角色。
| 值 | Description |
|---|---|
| User |
啟用連線的用戶存取權。 |
| UserWithReshare |
讓用戶能夠重新共享連線的存取權。 |
| Owner |
啟用連線的擁有權存取。 |
| PendingOwner |
該連接所有權尚未生效;主體必須透過更新連線憑證(使用 Update Connection API)來使其有效。 |
ConnectionRoleAssignment
主體的連接角色指派。
| 名稱 | 類型 | Description |
|---|---|---|
| id |
string (uuid) |
連接角色指派的物件識別碼。 |
| principal | Principal: |
主體。 |
| role |
主體的連接角色。 |
EntireTenantPrincipal
代表租戶委託人
| 名稱 | 類型 | Description |
|---|---|---|
| displayName |
string |
主體的顯示名稱。 |
| id |
string (uuid) |
主體的標識碼。 |
| type |
string:
Entire |
主體的類型。 可能會隨著時間新增其他主體類型。 |
ErrorParameter
一個結構化參數,提供關於錯誤的額外機器可讀上下文。
| 名稱 | 類型 | Description |
|---|---|---|
| message |
string |
一個人類可讀的參數意義描述。 |
| name |
string |
參數識別碼。 |
| value |
string |
這是參數值。 |
ErrorRelatedResource
錯誤相關的資源詳細資料物件。
| 名稱 | 類型 | Description |
|---|---|---|
| resourceId |
string |
發生錯誤的資源識別碼。 |
| resourceType |
string |
發生錯誤的資源類型。 |
ErrorResponse
錯誤回應。
| 名稱 | 類型 | Description |
|---|---|---|
| errorCode |
string |
提供錯誤狀況相關信息的特定標識碼,允許服務與其使用者之間的標準化通訊。 |
| isRetriable |
boolean |
若屬實,請求可重新嘗試。 如果有延遲,請使用 |
| message |
string |
以人類可讀格式呈現的錯誤訊息。 |
| moreDetails |
其他錯誤詳情的清單。 |
|
| parameters |
結構化參數提供更多機器可讀的錯誤上下文。 |
|
| relatedResource |
與錯誤相關的資源詳情。 |
|
| requestId |
string (uuid) |
與錯誤相關聯的要求識別碼。 |
ErrorResponseDetails
錯誤回應的細節。
| 名稱 | 類型 | Description |
|---|---|---|
| errorCode |
string |
提供錯誤狀況相關信息的特定標識碼,允許服務與其使用者之間的標準化通訊。 |
| message |
string |
以人類可讀格式呈現的錯誤訊息。 |
| parameters |
結構化參數提供更多機器可讀的錯誤上下文。 |
|
| relatedResource |
與錯誤相關的資源詳情。 |
GroupDetails
群組特定詳細數據。 當主體類型 Group時適用。
| 名稱 | 類型 | Description |
|---|---|---|
| groupType |
群組的類型。 可能會隨著時間新增其他群組類型。 |
GroupPrincipal
代表一個安全小組。
| 名稱 | 類型 | Description |
|---|---|---|
| displayName |
string |
主體的顯示名稱。 |
| groupDetails |
群組特定詳細數據。 當主體類型 |
|
| id |
string (uuid) |
主體的標識碼。 |
| type |
string:
Group |
主體的類型。 可能會隨著時間新增其他主體類型。 |
GroupType
群組的類型。 可能會隨著時間新增其他群組類型。
| 值 | Description |
|---|---|
| Unknown |
主體群組類型未知。 |
| SecurityGroup |
主體是安全組。 |
| DistributionList |
主體是通訊組清單。 |
PrincipalType
主體的類型。 可能會隨著時間新增其他主體類型。
| 值 | Description |
|---|---|
| User |
Principal 是 Microsoft Entra 的使用者 Principal。 |
| ServicePrincipal |
Principal 是 Microsoft Entra 服務主體。 |
| Group |
主體是安全組。 |
| ServicePrincipalProfile |
主體是服務主體配置檔。 |
| EntireTenant |
主體代表所有租用戶使用者。 |
ServicePrincipalDetails
服務主體特定詳細數據。 當主體類型 ServicePrincipal時適用。
| 名稱 | 類型 | Description |
|---|---|---|
| aadAppId |
string (uuid) |
服務主體的 Microsoft Entra AppId。 |
ServicePrincipalPrincipal
代表 Microsoft Entra 服務主體。
| 名稱 | 類型 | Description |
|---|---|---|
| displayName |
string |
主體的顯示名稱。 |
| id |
string (uuid) |
主體的標識碼。 |
| servicePrincipalDetails |
服務主體特定詳細數據。 當主體類型 |
|
| type |
string:
Service |
主體的類型。 可能會隨著時間新增其他主體類型。 |
ServicePrincipalProfileDetails
服務主體配置檔詳細數據。 當主體類型 ServicePrincipalProfile時適用。
| 名稱 | 類型 | Description |
|---|---|---|
| parentPrincipal | Principal: |
服務主體配置檔的父主體。 |
ServicePrincipalProfilePrincipal
代表服務主體的設定檔。
| 名稱 | 類型 | Description |
|---|---|---|
| displayName |
string |
主體的顯示名稱。 |
| id |
string (uuid) |
主體的標識碼。 |
| servicePrincipalProfileDetails |
服務主體配置檔詳細數據。 當主體類型 |
|
| type |
string:
Service |
主體的類型。 可能會隨著時間新增其他主體類型。 |
UpdateAdminConnectionRoleAssignmentRequest
更新連線角色指派要求承載。
| 名稱 | 類型 | Description |
|---|---|---|
| role |
主體的連接角色。 |
UserDetails
用戶主體特定詳細數據。 當主體類型 User時適用。
| 名稱 | 類型 | Description |
|---|---|---|
| userPrincipalName |
string |
用戶主體名稱。 |
UserPrincipal
代表 Microsoft Entra 使用者主體。
| 名稱 | 類型 | Description |
|---|---|---|
| displayName |
string |
主體的顯示名稱。 |
| id |
string (uuid) |
主體的標識碼。 |
| type |
string:
User |
主體的類型。 可能會隨著時間新增其他主體類型。 |
| userDetails |
用戶主體特定詳細數據。 當主體類型 |