Workspaces - Assign Workspace Encryption

Service:: Core

Version d’API:: v1

Affecte une clé Customer-Managed (CMK) à un espace de travail.
Active le chiffrement CMK pour l’espace de travail ou fait pivoter la clé de chiffrement de l’espace de travail.

Permissions

L’appelant doit avoir un rôle d’espace de travail administrateur.

Étendues déléguées requises

Workspace.ReadWrite.All

Identités prises en charge par Microsoft Entra

Cette API prend en charge les identités Microsoft répertoriées dans cette section.

Identité	Support
Utilisateur	Oui
Service principal et identités gérées	Oui

Interface

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
workspaceId	path	True	string (uuid)	Identifiant de l’espace de travail.

Corps de la demande

Nom	Obligatoire	Type	Description
keyIdentifier	True	string	Identificateur de clé Azure Key Vault. Il doit s’agir d’un URI de clé sans version.

Réponses

Nom Type Description

200 OK

Nom	Type	Description
200 OK		La demande s’est terminée avec succès.
429 Too Many Requests	ErrorResponse	La limite de débit de service a été dépassée. Le serveur retourne un `Retry-After` en-tête indiquant, en secondes, combien de temps le client doit attendre avant d’envoyer des demandes supplémentaires. En-têtes Retry-After: integer
Other Status Codes	ErrorResponse	Codes d’erreur courants : UnknownError : une erreur s’est produite.

La demande s’est terminée avec succès.

429 Too Many Requests

ErrorResponse

La limite de débit de service a été dépassée. Le serveur retourne un Retry-After en-tête indiquant, en secondes, combien de temps le client doit attendre avant d’envoyer des demandes supplémentaires.

En-têtes

Retry-After: integer

Other Status Codes

ErrorResponse

Codes d’erreur courants :

UnknownError : une erreur s’est produite.

Exemples

Assign workspace CMK encryption example

Exemple de requête

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

Exemple de réponse

Code d’état:: 200

Définitions

Nom	Description
AssignWorkspaceEncryptionRequest	Charge utile de la demande de chiffrement CMK de l’espace de travail.
ErrorRelatedResource	Objet de détails de ressource associé à l’erreur.
ErrorResponse	Réponse d’erreur.
ErrorResponseDetails	Détails de la réponse d’erreur.

AssignWorkspaceEncryptionRequest

Objet

Charge utile de la demande de chiffrement CMK de l’espace de travail.

Nom	Type	Description
keyIdentifier	string	Identificateur de clé Azure Key Vault. Il doit s’agir d’un URI de clé sans version.

ErrorRelatedResource

Objet

Objet de détails de ressource associé à l’erreur.

Nom	Type	Description
resourceId	string	ID de ressource impliqué dans l’erreur.
resourceType	string	Type de la ressource impliquée dans l’erreur.

ErrorResponse

Objet

Réponse d’erreur.

Nom	Type	Description
errorCode	string	Identificateur spécifique qui fournit des informations sur une condition d’erreur, ce qui permet une communication standardisée entre notre service et ses utilisateurs.
isRetriable	boolean	Lorsque la valeur est true, la requête peut être retentée. Utilisez l’en-tête `Retry-After` de réponse pour déterminer le délai, le cas échéant.
message	string	Représentation lisible humaine de l’erreur.
moreDetails	ErrorResponseDetails[]	Liste des détails d’erreur supplémentaires.
relatedResource	ErrorRelatedResource	Détails de la ressource associée à l’erreur.
requestId	string (uuid)	ID de la demande associée à l’erreur.

ErrorResponseDetails

Objet

Détails de la réponse d’erreur.

Nom	Type	Description
errorCode	string	Identificateur spécifique qui fournit des informations sur une condition d’erreur, ce qui permet une communication standardisée entre notre service et ses utilisateurs.
message	string	Représentation lisible humaine de l’erreur.
relatedResource	ErrorRelatedResource	Détails de la ressource associée à l’erreur.