Workspaces - Assign Workspace Encryption

服務:

Core

API 版本:

v1

為工作區指派一個 Customer-Managed 鍵（CMK）。
啟用工作區的 CMK 加密，或輪換工作區的加密金鑰。

權限

呼叫端必須具有 系統管理員 工作區角色。

必要的委派範圍

Workspace.ReadWrite.All

Microsoft Entra 支援的身份識別

此 API 支援本節中列出的Microsoft 身分識別。

身分識別	Support
User	Yes
服務主體 和 受控識別	Yes

Interface

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/encryption/assign

URI 參數

名稱	位於	必要	類型	Description
workspaceId	path	True	string (uuid)	工作區識別碼。

要求本文

名稱	必要	類型	Description
keyIdentifier	True	string	The Azure Key Vault key identifier. 這一定是無版本金鑰的 URI。

回覆

名稱	類型	Description
200 OK		要求成功完成。
429 Too Many Requests	ErrorResponse	服務費率上限被超標。 伺服器會回傳一個 Retry-After 標頭，以秒數表示客戶端在發送額外請求前必須等待多久。 標題 Retry-After: integer
Other Status Codes	ErrorResponse	常見的錯誤碼： UnknownError - 發生錯誤。

範例

Assign workspace CMK encryption example

範例要求

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/47482db6-4583-4672-86dd-999d0f8f4d7a/encryption/assign

{
  "keyIdentifier": "https://westus07112025-cmktest1.vault.azure.net/keys/test2k/"
}

範例回覆

狀態碼:

200

定義

名稱	Description
AssignWorkspaceEncryptionRequest	指派工作空間 CMK 加密請求有效載荷。
ErrorParameter	一個結構化參數，提供關於錯誤的額外機器可讀上下文。
ErrorRelatedResource	錯誤相關的資源詳細資料物件。
ErrorResponse	錯誤回應。
ErrorResponseDetails	錯誤回應的細節。

AssignWorkspaceEncryptionRequest

Object

指派工作空間 CMK 加密請求有效載荷。

名稱	類型	Description
keyIdentifier	string	The Azure Key Vault key identifier. 這一定是無版本金鑰的 URI。

ErrorParameter

Object

一個結構化參數，提供關於錯誤的額外機器可讀上下文。

名稱	類型	Description
message	string	一個人類可讀的參數意義描述。
name	string	參數識別碼。
value	string	這是參數值。

ErrorRelatedResource

Object

錯誤相關的資源詳細資料物件。

名稱	類型	Description
resourceId	string	發生錯誤的資源識別碼。
resourceType	string	發生錯誤的資源類型。

ErrorResponse

Object

錯誤回應。

名稱	類型	Description
errorCode	string	提供錯誤狀況相關信息的特定標識碼，允許服務與其使用者之間的標準化通訊。
isRetriable	boolean	若屬實，請求可重新嘗試。 如果有延遲，請使用 Retry-After 回應標頭來判斷延遲。
message	string	以人類可讀格式呈現的錯誤訊息。
moreDetails	ErrorResponseDetails[]	其他錯誤詳情的清單。
parameters	ErrorParameter[]	結構化參數提供更多機器可讀的錯誤上下文。
relatedResource	ErrorRelatedResource	與錯誤相關的資源詳情。
requestId	string (uuid)	與錯誤相關聯的要求識別碼。

ErrorResponseDetails

Object

錯誤回應的細節。

名稱	類型	Description
errorCode	string	提供錯誤狀況相關信息的特定標識碼，允許服務與其使用者之間的標準化通訊。
message	string	以人類可讀格式呈現的錯誤訊息。
parameters	ErrorParameter[]	結構化參數提供更多機器可讀的錯誤上下文。
relatedResource	ErrorRelatedResource	與錯誤相關的資源詳情。