Workspaces - Assign Workspace Encryption

Dienst:

Core

API-Version:

v1

Weist einem Arbeitsbereich einen Customer-Managed Schlüssel (CMK) zu.
Aktiviert die CMK-Verschlüsselung für den Arbeitsbereich oder dreht den Verschlüsselungsschlüssel für den Arbeitsbereich.

Berechtigungen

Der Anrufer muss über eine Administratorarbeitsbereichsrolle verfügen.

Erforderliche delegierte Zugriffsbereiche

Arbeitsbereich.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

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

URI-Parameter

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

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
keyIdentifier	True	string	Der Azure Key Vault Schlüsselbezeichner. Dies muss ein versionsloser Schlüssel-URI sein.

Antworten

Name	Typ	Beschreibung
200 OK		Der Auftrag wurde erfolgreich abgeschlossen.
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

Assign workspace CMK encryption example

Beispielanforderung

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/"
}

Beispiel für eine Antwort

Statuscode:

200

Definitionen

Name	Beschreibung
AssignWorkspaceEncryptionRequest	Die Nutzlast der CmK-Verschlüsselungsanforderung "Arbeitsbereich zuweisen".
ErrorRelatedResource	Das Objekt der fehlerbezogenen Ressourcendetails.
ErrorResponse	Die Fehlerantwort.
ErrorResponseDetails	Die Fehlerantwortdetails.

AssignWorkspaceEncryptionRequest

Objekt

Die Nutzlast der CmK-Verschlüsselungsanforderung "Arbeitsbereich zuweisen".

Name	Typ	Beschreibung
keyIdentifier	string	Der Azure Key Vault Schlüsselbezeichner. Dies muss ein versionsloser Schlüssel-URI sein.

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.