Workspaces - Assign Workspace Encryption

Serviço:

Core

Versão da API:

v1

Atribui uma Customer-Managed Chave (CMK) a um espaço de trabalho.
Permite a encriptação CMK para o espaço de trabalho ou roda a chave de encriptação para o espaço de trabalho.

Permissões

O chamador deve ter uma função de espaço de trabalho de administrador .

Escopos delegados necessários

Workspace.ReadWrite.All

Identidades suportadas pelo Entra da Microsoft

Esta API suporta as identidades do Microsoft listadas nesta secção.

Identidade	Support
User	Sim
Entidade de serviço e identidades geridas	Sim

Interface

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

Parâmetros do URI

Nome	Em	Obrigatório	Tipo	Descrição
workspaceId	path	True	string (uuid)	O ID do espaço de trabalho.

Corpo do Pedido

Nome	Obrigatório	Tipo	Descrição
keyIdentifier	True	string	O identificador de chave do Azure Key Vault. Isto deve ser um URI de chave sem versão.

Respostas

Nome	Tipo	Descrição
200 OK		Pedido concluído com sucesso.
429 Too Many Requests	ErrorResponse	O limite de tarifa de serviço foi ultrapassado. O servidor devolve um Retry-After cabeçalho que indica, em segundos, quanto tempo o cliente deve esperar antes de enviar pedidos adicionais. Cabeçalhos Retry-After: integer
Other Status Codes	ErrorResponse	Códigos de erro comuns: UnknownError - Ocorreu um erro.

Exemplos

Assign workspace CMK encryption example

Pedido de amostra

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

Resposta da amostra

Código de estado:

200

Definições

Nome	Descrição
AssignWorkspaceEncryptionRequest	A carga útil de pedido de encriptação CMK Assign Workspace.
ErrorParameter	Um parâmetro estruturado que fornece contexto adicional legível por máquina sobre um erro.
ErrorRelatedResource	Os detalhes do objeto de recurso relacionado ao erro.
ErrorResponse	A resposta de erro.
ErrorResponseDetails	Os detalhes do erro na resposta.

AssignWorkspaceEncryptionRequest

Object

A carga útil de pedido de encriptação CMK Assign Workspace.

Nome	Tipo	Descrição
keyIdentifier	string	O identificador de chave do Azure Key Vault. Isto deve ser um URI de chave sem versão.

ErrorParameter

Object

Um parâmetro estruturado que fornece contexto adicional legível por máquina sobre um erro.

Nome	Tipo	Descrição
message	string	Uma descrição legível para humanos do significado do parâmetro.
name	string	O identificador de parâmetro.
value	string	O valor do parâmetro.

ErrorRelatedResource

Object

Os detalhes do objeto de recurso relacionado ao erro.

Nome	Tipo	Descrição
resourceId	string	O ID do recurso envolvido no erro.
resourceType	string	O tipo de recurso envolvido no erro.

ErrorResponse

Object

A resposta de erro.

Nome	Tipo	Descrição
errorCode	string	Um identificador específico que fornece informações sobre uma condição de erro, permitindo uma comunicação padronizada entre nosso serviço e seus usuários.
isRetriable	boolean	Quando confirmado, o pedido pode ser retentado. Use o Retry-After cabeçalho de resposta para determinar o atraso, se disponível.
message	string	Uma representação legível por humanos do erro.
moreDetails	ErrorResponseDetails[]	Lista de detalhes de erro adicionais.
parameters	ErrorParameter[]	Parâmetros estruturados que fornecem contexto adicional legível pela máquina sobre o erro.
relatedResource	ErrorRelatedResource	Detalhes do recurso relacionado ao erro.
requestId	string (uuid)	ID da solicitação associada ao erro.

ErrorResponseDetails

Object

Os detalhes do erro na resposta.

Nome	Tipo	Descrição
errorCode	string	Um identificador específico que fornece informações sobre uma condição de erro, permitindo uma comunicação padronizada entre nosso serviço e seus usuários.
message	string	Uma representação legível por humanos do erro.
parameters	ErrorParameter[]	Parâmetros estruturados que fornecem contexto adicional legível pela máquina sobre o erro.
relatedResource	ErrorRelatedResource	Detalhes do recurso relacionado ao erro.