Workspaces - Get Workspace Encryption

Servicio:: Core

Versión de la API:: v1

Obtiene la configuración de cifrado de clave (CMK) del área de trabajo Customer-Managed.
Devuelve la configuración de cifrado de CMK y el estado del área de trabajo especificada.

Permissions

El autor de la llamada debe tener rol de área de trabajo o superior del visor.

Ámbitos delegados necesarios

Workspace.Read.All o Workspace.ReadWrite.All

Identidades admitidas de Microsoft Entra

Esta API admite las identidades de Microsoft enumeradas en esta sección.

Identidad	Support
Usuario	Sí
Entidad de servicio e Identidades administradas	Sí

Interface

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
workspaceId	path	True	string (uuid)	El identificador del área de trabajo.

Respuestas

Nombre Tipo Description

200 OK

Nombre	Tipo	Description
200 OK	WorkspaceEncryptionDetail	Solicitud completada correctamente. Si el cifrado está en curso, la respuesta incluye un `Retry-After` encabezado. Encabezados: Reintentar después`integer` : indica el número de segundos después del cual el cliente puede reintentar para obtener el estado de cifrado.
429 Too Many Requests	ErrorResponse	Se superó el límite de frecuencia de servicio. El servidor devuelve un `Retry-After` encabezado que indica, en segundos, cuánto tiempo debe esperar el cliente antes de enviar solicitudes adicionales. Encabezados Retry-After: integer
Other Status Codes	ErrorResponse	Códigos de error comunes: UnknownError: se produjo un error.

WorkspaceEncryptionDetail

Solicitud completada correctamente. Si el cifrado está en curso, la respuesta incluye un Retry-After encabezado.

Encabezados:

Reintentar despuésinteger : indica el número de segundos después del cual el cliente puede reintentar para obtener el estado de cifrado.

429 Too Many Requests

ErrorResponse

Se superó el límite de frecuencia de servicio. El servidor devuelve un Retry-After encabezado que indica, en segundos, cuánto tiempo debe esperar el cliente antes de enviar solicitudes adicionales.

Encabezados

Retry-After: integer

Other Status Codes

ErrorResponse

Códigos de error comunes:

UnknownError: se produjo un error.

Ejemplos

Get workspace CMK encryption active example

Get workspace CMK encryption in progress example

Get workspace CMK encryption active example

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

status code:: 200

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

Get workspace CMK encryption in progress example

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

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

Definiciones

Nombre	Description
EncryptionDetail	Detalles de cifrado del área de trabajo.
ErrorRelatedResource	Objeto de detalles del recurso relacionado con el error.
ErrorResponse	Respuesta de error.
ErrorResponseDetails	Detalles de la respuesta de error.
WorkspaceEncryptionDetail	Detalles de estado y configuración de cifrado del área de trabajo.
WorkspaceEncryptionItem	Detalles del elemento del área de trabajo.
WorkspaceEncryptionItemsDetail	Detalles del estado de cifrado de los elementos del área de trabajo.
WorkspaceEncryptionStatus	Estado de cifrado del área de trabajo.

EncryptionDetail

Objeto

Detalles de cifrado del área de trabajo.

Nombre	Tipo	Description
encryptionStatus	WorkspaceEncryptionStatus	Estado de cifrado del área de trabajo.
keyIdentifier	string	Identificador de clave.

ErrorRelatedResource

Objeto

Objeto de detalles del recurso relacionado con el error.

Nombre	Tipo	Description
resourceId	string	ID de recurso que está involucrado en el error.
resourceType	string	Tipo del recurso implicado en el error.

ErrorResponse

Objeto

Respuesta de error.

Nombre	Tipo	Description
errorCode	string	Identificador específico que proporciona información sobre una condición de error, lo que permite una comunicación estandarizada entre nuestro servicio y sus usuarios.
isRetriable	boolean	Cuando es true, se puede reintentar la solicitud. Use el `Retry-After` encabezado de respuesta para determinar el retraso, si está disponible.
message	string	Representación comprensible para humanos del error.
moreDetails	ErrorResponseDetails[]	Lista de detalles de error adicionales.
relatedResource	ErrorRelatedResource	Detalles del recurso relacionado con el error.
requestId	string (uuid)	Identificador de la solicitud asociada al error.

ErrorResponseDetails

Objeto

Detalles de la respuesta de error.

Nombre	Tipo	Description
errorCode	string	Identificador específico que proporciona información sobre una condición de error, lo que permite una comunicación estandarizada entre nuestro servicio y sus usuarios.
message	string	Representación comprensible para humanos del error.
relatedResource	ErrorRelatedResource	Detalles del recurso relacionado con el error.

WorkspaceEncryptionDetail

Objeto

Detalles de estado y configuración de cifrado del área de trabajo.

Nombre	Tipo	Description
encryptionDetail	EncryptionDetail	Detalle del cifrado del área de trabajo.
previousEncryptionDetail	EncryptionDetail	Detalle del cifrado del área de trabajo anterior.
workspaceEncryptionItemsDetails	WorkspaceEncryptionItemsDetail[]	Estado de cifrado de los elementos del área de trabajo.

WorkspaceEncryptionItem

Objeto

Detalles del elemento del área de trabajo.

Nombre	Tipo	Description
displayName	string	Nombre para mostrar del elemento.
id	string (uuid)	Identificador del elemento.
type	string	Tipo de elemento.

WorkspaceEncryptionItemsDetail

Objeto

Detalles del estado de cifrado de los elementos del área de trabajo.

Nombre	Tipo	Description
encryptionStatus	WorkspaceEncryptionStatus	Estado de cifrado de los elementos.
items	WorkspaceEncryptionItem[]	Matriz de detalles del elemento del área de trabajo.

WorkspaceEncryptionStatus

Enumeración

Estado de cifrado del área de trabajo.

Valor	Description
Disabled	El cifrado del área de trabajo no está activo.
Active	El cifrado del área de trabajo está activo y el área de trabajo está cifrada.
EnableInProgress	El cifrado del área de trabajo está habilitando.
DisableInProgress	El cifrado del área de trabajo está deshabilitando.
Failed	Error en la aplicación de cifrado del área de trabajo.