Workspaces - Assign Workspace Encryption

Serviço:
Core
Versão da API:
v1

Atribui um CMK (Customer-Managed Key) a um workspace.
Habilita a criptografia cmk para o workspace ou gira a chave de criptografia para o workspace.

Permissões

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

Escopos delegados necessários

Workspace.ReadWrite.All

Identidades com suporte do Microsoft Entra

Esta API dá suporte às identidades do Microsoft listadas nesta seção.

Identity Support
User Sim
Entidade de serviço e identidades gerenciadas Sim

Interface

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
workspaceId
 path True

string (uuid)

O identificador do espaço de trabalho.

Corpo da solicitação

Nome Obrigatório Tipo Description
keyIdentifier True

string

O identificador de chave Azure Key Vault. Deve ser um URI de chave sem versão.

Respostas

Nome Tipo Description
200 OK

Solicitação concluída com êxito.
429 Too Many Requests

ErrorResponse

O limite de taxa de serviço foi excedido. O servidor retorna um Retry-After cabeçalho indicando, em segundos, quanto tempo o cliente deve aguardar antes de enviar solicitações 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

Solicitação de exemplo

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 de exemplo

Código de status:
200

Definições

Nome Description
AssignWorkspaceEncryptionRequest

O conteúdo da solicitação Atribuir Criptografia CMK do Workspace.
ErrorRelatedResource

O objeto relacionado ao erro nos detalhes do recurso.
ErrorResponse

A resposta de erro.
ErrorResponseDetails

Os detalhes da resposta de erro.

AssignWorkspaceEncryptionRequest

Objeto

O conteúdo da solicitação Atribuir Criptografia CMK do Workspace.

Nome Tipo Description
keyIdentifier

string

O identificador de chave Azure Key Vault. Deve ser um URI de chave sem versão.

ErrorRelatedResource

Objeto

O objeto relacionado ao erro nos detalhes do recurso.

Nome Tipo Description
resourceId

string

O identificador do recurso envolvido no erro.
resourceType

string

O tipo do recurso envolvido no erro.

ErrorResponse

Objeto

A resposta de erro.

Nome Tipo Description
errorCode

string

Um identificador específico que fornece informações sobre uma condição de erro, permitindo a comunicação padronizada entre nosso serviço e seus usuários.
isRetriable

boolean

Quando true, a solicitação pode ser repetida. Use o Retry-After cabeçalho de resposta para determinar o atraso, se disponível.
message

string

Uma representação legível humana do erro.
moreDetails

ErrorResponseDetails[]

Lista de detalhes de erro adicionais.
relatedResource

ErrorRelatedResource

Os detalhes do recurso relacionado ao erro.
requestId

string (uuid)

ID da solicitação associada ao erro.

ErrorResponseDetails

Objeto

Os detalhes da resposta de erro.

Nome Tipo Description
errorCode

string

Um identificador específico que fornece informações sobre uma condição de erro, permitindo a comunicação padronizada entre nosso serviço e seus usuários.
message

string

Uma representação legível humana do erro.
relatedResource

ErrorRelatedResource

Os detalhes do recurso relacionado ao erro.