Workspaces - Get Workspace Encryption

Dienst:: Core

API-Version:: v1

Ruft die Arbeitsbereichs-Customer-Managed Schlüsselverschlüsselungseinstellungen (CMK) ab.
Gibt die CMK-Verschlüsselungseinstellungen und den Status für den angegebenen Arbeitsbereich zurück.

Berechtigungen

Der Anrufer muss Viewer-rolle oder höherer Arbeitsbereichsrolle haben.

Erforderliche delegierte Zugriffsbereiche

Workspace.Read.All oder Workspace.ReadWrite.All

Von Microsoft Entra unterstützte Identitäten

Diese API unterstützt die in diesem Abschnitt aufgeführten Microsoft Identitäten.

Identität	Support
Benutzer	Ja
Service Principal und Verwaltete Identitäten	Ja

Schnittstelle

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
workspaceId	path	True	string (uuid)	Die Arbeitsbereichs-ID.

Antworten

Name Typ Beschreibung

200 OK

Name	Typ	Beschreibung
200 OK	WorkspaceEncryptionDetail	Der Auftrag wurde erfolgreich abgeschlossen. Wenn die Verschlüsselung ausgeführt wird, enthält die Antwort einen `Retry-After` Header. Kopfzeilen: Wiederholen des Vorgangs nach`integer` – Gibt die Anzahl der Sekunden an, nach denen der Client versuchen kann, den Verschlüsselungsstatus abzurufen.
429 Too Many Requests	ErrorResponse	Der Dienstratenlimit wurde überschritten. Der Server gibt einen `Retry-After` Header zurück, der in Sekunden angibt, wie lange der Client warten muss, bevor zusätzliche Anforderungen gesendet werden. Header Retry-After: integer
Other Status Codes	ErrorResponse	Häufige Fehlercodes: UnknownError – Ein Fehler ist aufgetreten.

WorkspaceEncryptionDetail

Der Auftrag wurde erfolgreich abgeschlossen. Wenn die Verschlüsselung ausgeführt wird, enthält die Antwort einen Retry-After Header.

Kopfzeilen:

Wiederholen des Vorgangs nachinteger – Gibt die Anzahl der Sekunden an, nach denen der Client versuchen kann, den Verschlüsselungsstatus abzurufen.

429 Too Many Requests

ErrorResponse

Der Dienstratenlimit wurde überschritten. Der Server gibt einen Retry-After Header zurück, der in Sekunden angibt, wie lange der Client warten muss, bevor zusätzliche Anforderungen gesendet werden.

Header

Retry-After: integer

Other Status Codes

ErrorResponse

Häufige Fehlercodes:

UnknownError – Ein Fehler ist aufgetreten.

Beispiele

Get workspace CMK encryption active example

Get workspace CMK encryption in progress example

Get workspace CMK encryption active example

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:: 200

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

Get workspace CMK encryption in progress example

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:: 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"
    }
  ]
}

Definitionen

Name	Beschreibung
EncryptionDetail	Details zur Arbeitsbereichsverschlüsselung.
ErrorRelatedResource	Das Objekt der fehlerbezogenen Ressourcendetails.
ErrorResponse	Die Fehlerantwort.
ErrorResponseDetails	Die Fehlerantwortdetails.
WorkspaceEncryptionDetail	Arbeitsbereichsverschlüsselungseinstellungen und Statusdetails.
WorkspaceEncryptionItem	Details des Arbeitsbereichselements.
WorkspaceEncryptionItemsDetail	Verschlüsselungsstatusdetails für Elemente im Arbeitsbereich.
WorkspaceEncryptionStatus	Der Arbeitsbereichsverschlüsselungsstatus.

EncryptionDetail

Objekt

Details zur Arbeitsbereichsverschlüsselung.

Name	Typ	Beschreibung
encryptionStatus	WorkspaceEncryptionStatus	Der Arbeitsbereichsverschlüsselungsstatus.
keyIdentifier	string	Der Schlüsselbezeichner.

ErrorRelatedResource

Objekt

Das Objekt der fehlerbezogenen Ressourcendetails.

Name	Typ	Beschreibung
resourceId	string	Die Ressourcen-ID, die an dem Fehler beteiligt ist.
resourceType	string	Der Typ der Ressource, die an dem Fehler beteiligt ist.

ErrorResponse

Objekt

Die Fehlerantwort.

Name	Typ	Beschreibung
errorCode	string	Ein bestimmter Bezeichner, der Informationen über eine Fehlerbedingung bereitstellt und eine standardisierte Kommunikation zwischen unserem Dienst und seinen Benutzern ermöglicht.
isRetriable	boolean	Wenn true, kann die Anforderung wiederholt werden. Verwenden Sie den `Retry-After` Antwortheader, um die Verzögerung zu ermitteln, falls verfügbar.
message	string	Eine menschenlesbare Darstellung des Fehlers.
moreDetails	ErrorResponseDetails[]	Liste der zusätzlichen Fehlerdetails.
relatedResource	ErrorRelatedResource	Die fehlerbezogenen Ressourcendetails.
requestId	string (uuid)	ID der Anforderung, die dem Fehler zugeordnet ist.

ErrorResponseDetails

Objekt

Die Fehlerantwortdetails.

Name	Typ	Beschreibung
errorCode	string	Ein bestimmter Bezeichner, der Informationen über eine Fehlerbedingung bereitstellt und eine standardisierte Kommunikation zwischen unserem Dienst und seinen Benutzern ermöglicht.
message	string	Eine menschenlesbare Darstellung des Fehlers.
relatedResource	ErrorRelatedResource	Die fehlerbezogenen Ressourcendetails.

WorkspaceEncryptionDetail

Objekt

Arbeitsbereichsverschlüsselungseinstellungen und Statusdetails.

Name	Typ	Beschreibung
encryptionDetail	EncryptionDetail	Die Arbeitsbereichsverschlüsselungsdetails.
previousEncryptionDetail	EncryptionDetail	Das vorherige Arbeitsbereichsverschlüsselungsdetails.
workspaceEncryptionItemsDetails	WorkspaceEncryptionItemsDetail[]	Der Verschlüsselungsstatus von Elementen im Arbeitsbereich.

WorkspaceEncryptionItem

Objekt

Details des Arbeitsbereichselements.

Name	Typ	Beschreibung
displayName	string	Der Anzeigename des Elements.
id	string (uuid)	Die Element-ID.
type	string	Der Elementtyp.

WorkspaceEncryptionItemsDetail

Objekt

Verschlüsselungsstatusdetails für Elemente im Arbeitsbereich.

Name	Typ	Beschreibung
encryptionStatus	WorkspaceEncryptionStatus	Der Verschlüsselungsstatus für die Elemente.
items	WorkspaceEncryptionItem[]	Das Array der Arbeitsbereichselementdetails.

WorkspaceEncryptionStatus

Enumeration

Der Arbeitsbereichsverschlüsselungsstatus.

Wert	Beschreibung
Disabled	Die Arbeitsbereichsverschlüsselung ist nicht aktiv.
Active	Die Arbeitsbereichsverschlüsselung ist aktiv, und der Arbeitsbereich wird verschlüsselt.
EnableInProgress	Die Arbeitsbereichsverschlüsselung wird aktiviert.
DisableInProgress	Die Arbeitsbereichsverschlüsselung wird deaktiviert.
Failed	Fehler bei der Arbeitsbereichsverschlüsselungsanwendung.