Workspaces - Assign Workspace Encryption

Servicio:

Core

Versión de la API:

v1

Asigna una clave de Customer-Managed (CMK) a un área de trabajo.
Habilita el cifrado cmK para el área de trabajo o rota la clave de cifrado del área de trabajo.

Permissions

El autor de la llamada debe tener un rol de área de trabajo de administrador .

Ámbitos delegados necesarios

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

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

Parámetros de identificador URI

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

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
keyIdentifier	True	string	Identificador de clave Azure Key Vault. Debe ser un URI de clave sin versión.

Respuestas

Nombre	Tipo	Description
200 OK		Solicitud completada correctamente.
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

Assign workspace CMK encryption example

Solicitud de ejemplo

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

Respuesta de muestra

status code:

200

Definiciones

Nombre	Description
AssignWorkspaceEncryptionRequest	Carga de la solicitud Asignar cifrado cmK 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.

AssignWorkspaceEncryptionRequest

Objeto

Carga de la solicitud Asignar cifrado cmK del área de trabajo.

Nombre	Tipo	Description
keyIdentifier	string	Identificador de clave Azure Key Vault. Debe ser un URI de clave sin versión.

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.