Workspaces - Get Workspace Encryption

Service:: Core

Version d’API:: v1

Obtient les paramètres de chiffrement Customer-Managed clé (CMK) de l’espace de travail.
Retourne les paramètres de chiffrement cmK et l’état de l’espace de travail spécifié.

Permissions

L’appelant doit avoir visionneuse ou un rôle d’espace de travail supérieur.

Étendues déléguées requises

Workspace.Read.All ou 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

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

Paramètres URI

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

Réponses

Nom Type Description

200 OK

Nom	Type	Description
200 OK	WorkspaceEncryptionDetail	La demande s’est terminée avec succès. Si le chiffrement est en cours, la réponse inclut un `Retry-After` en-tête. En-têtes : Réessayer après`integer` : indique le nombre de secondes après lesquelles le client peut réessayer pour obtenir l’état du chiffrement.
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.

WorkspaceEncryptionDetail

La demande s’est terminée avec succès. Si le chiffrement est en cours, la réponse inclut un Retry-After en-tête.

En-têtes :

Réessayer aprèsinteger : indique le nombre de secondes après lesquelles le client peut réessayer pour obtenir l’état du chiffrement.

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

Get workspace CMK encryption active example

Get workspace CMK encryption in progress example

Get workspace CMK encryption active example

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:: 200

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

Get workspace CMK encryption in progress example

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:: 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"
    }
  ]
}

Définitions

Nom	Description
EncryptionDetail	Détails du chiffrement 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.
WorkspaceEncryptionDetail	Paramètres de chiffrement de l’espace de travail et détails de l’état.
WorkspaceEncryptionItem	Détails de l’élément d’espace de travail.
WorkspaceEncryptionItemsDetail	Détails de l’état du chiffrement pour les éléments de l’espace de travail.
WorkspaceEncryptionStatus	État du chiffrement de l’espace de travail.

EncryptionDetail

Objet

Détails du chiffrement de l’espace de travail.

Nom	Type	Description
encryptionStatus	WorkspaceEncryptionStatus	État du chiffrement de l’espace de travail.
keyIdentifier	string	Identificateur de clé.

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.

WorkspaceEncryptionDetail

Objet

Paramètres de chiffrement de l’espace de travail et détails de l’état.

Nom	Type	Description
encryptionDetail	EncryptionDetail	Détail du chiffrement de l’espace de travail.
previousEncryptionDetail	EncryptionDetail	Détails du chiffrement de l’espace de travail précédent.
workspaceEncryptionItemsDetails	WorkspaceEncryptionItemsDetail[]	État du chiffrement des éléments dans l’espace de travail.

WorkspaceEncryptionItem

Objet

Détails de l’élément d’espace de travail.

Nom	Type	Description
displayName	string	Nom complet de l’élément.
id	string (uuid)	ID de l’élément.
type	string	Type d’élément.

WorkspaceEncryptionItemsDetail

Objet

Détails de l’état du chiffrement pour les éléments de l’espace de travail.

Nom	Type	Description
encryptionStatus	WorkspaceEncryptionStatus	État du chiffrement des éléments.
items	WorkspaceEncryptionItem[]	Tableau des détails de l’élément d’espace de travail.

WorkspaceEncryptionStatus

Énumération

État du chiffrement de l’espace de travail.

Valeur	Description
Disabled	Le chiffrement de l’espace de travail n’est pas actif.
Active	Le chiffrement de l’espace de travail est actif et l’espace de travail est chiffré.
EnableInProgress	Le chiffrement de l’espace de travail est activé.
DisableInProgress	Le chiffrement de l’espace de travail est désactivé.
Failed	Échec de l’application de chiffrement de l’espace de travail.