Workspaces - Assign Workspace Encryption

サービス:

Core

API バージョン:

v1

Customer-Managed キー (CMK) をワークスペースに割り当てます。
ワークスペースの CMK 暗号化を有効にするか、ワークスペースの暗号化キーをローテーションします。

Permissions

呼び出し元には 管理者 ワークスペース ロールが必要です。

必要な委任スコープ

Workspace.ReadWrite.All

Microsoft Entra でサポートされている ID

この API では、このセクションに記載されている Microsoft ID がサポートされています。

アイデンティティ	Support
User	はい
サービス プリンシパルとマネージド ID	はい

Interface

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

URI パラメーター

名前	/	必須	型	説明
workspaceId	path	True	string (uuid)	ワークスペース ID。

要求本文

名前	必須	型	説明
keyIdentifier	True	string	Azure Key Vault キー識別子。 これは、バージョンレス キー URI である必要があります。

応答

名前	型	説明
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

定義

名前	説明
AssignWorkspaceEncryptionRequest	ワークスペース CMK 暗号化の割り当て要求ペイロード。
ErrorRelatedResource	エラー関連のリソース詳細オブジェクト。
ErrorResponse	エラー応答。
ErrorResponseDetails	エラー応答の詳細。

AssignWorkspaceEncryptionRequest

Object

ワークスペース CMK 暗号化の割り当て要求ペイロード。

名前	型	説明
keyIdentifier	string	Azure Key Vault キー識別子。 これは、バージョンレス キー URI である必要があります。

ErrorRelatedResource

Object

エラー関連のリソース詳細オブジェクト。

名前	型	説明
resourceId	string	エラーに関係するリソース ID。
resourceType	string	エラーに関係するリソースの種類。

ErrorResponse

Object

エラー応答。

名前	型	説明
errorCode	string	エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。
isRetriable	boolean	true の場合、要求を再試行できます。 Retry-After応答ヘッダーを使用して、遅延 (使用可能な場合) を決定します。
message	string	エラーの人間が理解可能な表現。
moreDetails	ErrorResponseDetails[]	その他のエラーの詳細の一覧。
relatedResource	ErrorRelatedResource	エラー関連のリソースの詳細。
requestId	string (uuid)	エラーに関連付けられている要求の ID。

ErrorResponseDetails

Object

エラー応答の詳細。

名前	型	説明
errorCode	string	エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。
message	string	エラーの人間が理解可能な表現。
relatedResource	ErrorRelatedResource	エラー関連のリソースの詳細。