Workspaces - Get Workspace Encryption

บริการ:: Core

เวอร์ชัน API:: v1

รับการตั้งค่าการเข้ารหัสลับพื้นที่ทํางาน Customer-Managed Key (CMK)
แสดงการตั้งค่าการเข้ารหัสลับ CMK และสถานะสําหรับพื้นที่ทํางานที่ระบุ

สิทธิ์การได้รับอนุญาต

ผู้เรียกต้องมีบทบาท ของผู้ชม หรือสูงกว่าพื้นที่ทํางาน

จําเป็นต้องมีขอบเขตที่ได้รับมอบสิทธิ์

Workspace.Read.All หรือ Workspace.ReadWrite.All

Microsoft Entra ข้อมูลประจําตัวที่ได้รับการสนับสนุน

API นี้สนับสนุน Microsoft identitiesที่ระบุในส่วนนี้

Identity	การสนับสนุน
ผู้ใช้	ใช่
บริการหลักและข้อมูลประจําตัว ที่มีการจัดการ	ใช่

อินเตอร์เฟซ

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

พารามิเตอร์ URI

ชื่อ	ใน	จำเป็น	พิมพ์	คำอธิบาย
workspaceId	path	True	string (uuid)	ID พื้นที่ทํางาน

การตอบสนอง

ชื่อ พิมพ์ คำอธิบาย

200 OK

ชื่อ	พิมพ์	คำอธิบาย
200 OK	WorkspaceEncryptionDetail	คําขอเสร็จสมบูรณ์ ถ้ามีการเข้ารหัสลับอยู่ในระหว่างดําเนินการ การตอบกลับจะ `Retry-After` รวมส่วนหัวด้วย ส่วนหัว: ลองใหม่-หลังจาก`integer` - ระบุจํานวนวินาทีหลังจากนั้นไคลเอ็นต์สามารถลองใหม่เพื่อรับสถานะการเข้ารหัสลับ
429 Too Many Requests	ErrorResponse	เกินขีดจํากัดอัตราการบริการ เซิร์ฟเวอร์จะส่งกลับ `Retry-After` ส่วนหัวที่ระบุ ภายในไม่กี่วินาที ระยะเวลาที่ไคลเอ็นต์ต้องรอก่อนที่จะส่งคําขอเพิ่มเติม ส่วนหัว Retry-After: integer
Other Status Codes	ErrorResponse	รหัสข้อผิดพลาดทั่วไป: UnknownError - เกิดข้อผิดพลาด

WorkspaceEncryptionDetail

คําขอเสร็จสมบูรณ์ ถ้ามีการเข้ารหัสลับอยู่ในระหว่างดําเนินการ การตอบกลับจะ Retry-After รวมส่วนหัวด้วย

ส่วนหัว:

ลองใหม่-หลังจากinteger - ระบุจํานวนวินาทีหลังจากนั้นไคลเอ็นต์สามารถลองใหม่เพื่อรับสถานะการเข้ารหัสลับ

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

คำขอตัวอย่าง

HTTP

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

คำขอตัวอย่าง

HTTP

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

วัตถุ

รายละเอียดการเข้ารหัสลับพื้นที่ทํางาน

ชื่อ	พิมพ์	คำอธิบาย
encryptionStatus	WorkspaceEncryptionStatus	สถานะการเข้ารหัสลับพื้นที่ทํางาน
keyIdentifier	string	ตัวระบุหลัก

ErrorRelatedResource

วัตถุ

ออบเจ็กต์รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด

ชื่อ	พิมพ์	คำอธิบาย
resourceId	string	ID ทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด
resourceType	string	ชนิดของทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด

ErrorResponse

วัตถุ

การตอบสนองข้อผิดพลาด

ชื่อ	พิมพ์	คำอธิบาย
errorCode	string	ตัวระบุเฉพาะที่ให้ข้อมูลเกี่ยวกับเงื่อนไขข้อผิดพลาด ทําให้สามารถสื่อสารได้มาตรฐานระหว่างบริการของเรากับผู้ใช้
isRetriable	boolean	เมื่อเป็นจริง สามารถลองคําขอใหม่ได้ ใช้ส่วนหัวการตอบสนอง `Retry-After` เพื่อกําหนดความล่าช้า ถ้ามี
message	string	การแสดงข้อผิดพลาดที่มนุษย์สามารถอ่านได้
moreDetails	ErrorResponseDetails[]	รายการรายละเอียดข้อผิดพลาดเพิ่มเติม
relatedResource	ErrorRelatedResource	รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด
requestId	string (uuid)	รหัสของคําขอที่เกี่ยวข้องกับข้อผิดพลาด

ErrorResponseDetails

วัตถุ

รายละเอียดการตอบสนองข้อผิดพลาด

ชื่อ	พิมพ์	คำอธิบาย
errorCode	string	ตัวระบุเฉพาะที่ให้ข้อมูลเกี่ยวกับเงื่อนไขข้อผิดพลาด ทําให้สามารถสื่อสารได้มาตรฐานระหว่างบริการของเรากับผู้ใช้
message	string	การแสดงข้อผิดพลาดที่มนุษย์สามารถอ่านได้
relatedResource	ErrorRelatedResource	รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด

WorkspaceEncryptionDetail

วัตถุ

รายละเอียดสถานะและการตั้งค่าการเข้ารหัสของพื้นที่ทํางาน

ชื่อ	พิมพ์	คำอธิบาย
encryptionDetail	EncryptionDetail	รายละเอียดการเข้ารหัสลับของพื้นที่ทํางาน
previousEncryptionDetail	EncryptionDetail	รายละเอียดการเข้ารหัสลับของพื้นที่ทํางานก่อนหน้านี้
workspaceEncryptionItemsDetails	WorkspaceEncryptionItemsDetail[]	สถานะการเข้ารหัสลับของรายการในพื้นที่ทํางาน

WorkspaceEncryptionItem

วัตถุ

รายละเอียดรายการพื้นที่ทํางาน

ชื่อ	พิมพ์	คำอธิบาย
displayName	string	ชื่อที่แสดงของรายการ
id	string (uuid)	รหัสสินค้า
type	string	ชนิดหน่วยข้อมูล

WorkspaceEncryptionItemsDetail

วัตถุ

รายละเอียดสถานะการเข้ารหัสลับสําหรับรายการในพื้นที่ทํางาน

ชื่อ	พิมพ์	คำอธิบาย
encryptionStatus	WorkspaceEncryptionStatus	สถานะการเข้ารหัสลับสําหรับรายการต่างๆ
items	WorkspaceEncryptionItem[]	อาร์เรย์ของรายละเอียดรายการพื้นที่ทํางาน

WorkspaceEncryptionStatus

การแจงนับ

สถานะการเข้ารหัสลับพื้นที่ทํางาน

ค่า	คำอธิบาย
Disabled	การเข้ารหัสลับพื้นที่ทํางานไม่ได้ทํางาน
Active	มีการใช้งานการเข้ารหัสลับพื้นที่ทํางานและพื้นที่ทํางานถูกเข้ารหัสลับ
EnableInProgress	กําลังเปิดใช้งานการเข้ารหัสลับพื้นที่ทํางาน
DisableInProgress	การเข้ารหัสลับพื้นที่ทํางานกําลังปิดใช้งาน
Failed	แอปพลิเคชันการเข้ารหัสลับพื้นที่ทํางานล้มเหลว