Workspaces - Get Workspace Encryption

サービス:
Core
API バージョン:
v1

ワークスペース Customer-Managed キー (CMK) 暗号化設定を取得します。
指定したワークスペースの CMK 暗号化設定と状態を返します。

Permissions

呼び出し元には、ビューアー 以上のワークスペース ロールが必要です。

必要な委任スコープ

Workspace.Read.All または Workspace.ReadWrite.All

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

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

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

Interface

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

URI パラメーター

名前 / 必須 型 説明
workspaceId
 path True

string (uuid)

ワークスペース ID。

応答

名前 型 説明
200 OK

WorkspaceEncryptionDetail

要求は正常に完了しました。 暗号化が進行中の場合、応答には Retry-After ヘッダーが含まれます。

ヘッダー:

Retry-Afterinteger - クライアントが暗号化状態を取得するために再試行できる秒数を示します。
429 Too Many Requests

ErrorResponse

サービス レートの制限を超えました。 サーバーは、クライアントが追加の要求を送信するまでに待機する必要がある時間を秒単位で示す Retry-After ヘッダーを返します。

ヘッダー

Retry-After: integer
Other Status Codes

ErrorResponse

一般的なエラー コード:

  • UnknownError - エラーが発生しました。

例

Get workspace CMK encryption active example
Get workspace CMK encryption in progress example

Get workspace CMK encryption active example

要求のサンプル

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

応答のサンプル

状態コード:
200 
{
  "encryptionDetail": {
    "keyIdentifier": "https://westus07112025-cmktest1.vault.azure.net/keys/test2k/",
    "encryptionStatus": "Active"
  }
}

Get workspace CMK encryption in progress example

要求のサンプル

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

応答のサンプル

状態コード:
200 
Retry-After: 900
{
  "encryptionDetail": {
    "keyIdentifier": "https://westus07112025-cmktest1.vault.azure.net/keys/test2k/",
    "encryptionStatus": "EnableInProgress"
  },
  "previousEncryptionDetail": {
    "keyIdentifier": "https://westus07112025-cmktest1.vault.azure.net/keys/key1/",
    "encryptionStatus": "Active"
  },
  "workspaceEncryptionItemsDetails": [
    {
      "items": [
        {
          "displayName": "copyjob1",
          "type": "CopyJob",
          "id": "9d922047-55a9-4737-8ec0-f34a320100bc"
        },
        {
          "displayName": "copyjob2",
          "type": "CopyJob",
          "id": "8d022047-55a9-4737-8ec0-f34a320100b7"
        }
      ],
      "encryptionStatus": "EnableInProgress"
    }
  ]
}

定義

名前 説明
EncryptionDetail

ワークスペースの暗号化の詳細。
ErrorRelatedResource

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

エラー応答。
ErrorResponseDetails

エラー応答の詳細。
WorkspaceEncryptionDetail

ワークスペースの暗号化設定と状態の詳細。
WorkspaceEncryptionItem

ワークスペース項目の詳細。
WorkspaceEncryptionItemsDetail

ワークスペース内のアイテムの暗号化状態の詳細。
WorkspaceEncryptionStatus

ワークスペースの暗号化の状態。

EncryptionDetail

Object

ワークスペースの暗号化の詳細。

名前 型 説明
encryptionStatus

WorkspaceEncryptionStatus

ワークスペースの暗号化の状態。
keyIdentifier

string

キー識別子。

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

エラー関連のリソースの詳細。

WorkspaceEncryptionDetail

Object

ワークスペースの暗号化設定と状態の詳細。

名前 型 説明
encryptionDetail

EncryptionDetail

ワークスペースの暗号化の詳細。
previousEncryptionDetail

EncryptionDetail

前のワークスペース暗号化の詳細。
workspaceEncryptionItemsDetails

WorkspaceEncryptionItemsDetail[]

ワークスペース内のアイテムの暗号化の状態。

WorkspaceEncryptionItem

Object

ワークスペース項目の詳細。

名前 型 説明
displayName

string

アイテムの表示名。
id

string (uuid)

アイテム ID。
type

string

アイテムの種類。

WorkspaceEncryptionItemsDetail

Object

ワークスペース内のアイテムの暗号化状態の詳細。

名前 型 説明
encryptionStatus

WorkspaceEncryptionStatus

アイテムの暗号化の状態。
items

WorkspaceEncryptionItem[]

ワークスペース項目の詳細の配列。

WorkspaceEncryptionStatus

列挙

ワークスペースの暗号化の状態。

値 説明
Disabled

ワークスペースの暗号化がアクティブではありません。
Active

ワークスペースの暗号化はアクティブであり、ワークスペースは暗号化されます。
EnableInProgress

ワークスペースの暗号化が有効になっています。
DisableInProgress

ワークスペースの暗号化が無効になっています。
Failed

ワークスペース暗号化アプリケーションが失敗しました。