Workspaces - Get Workspace Encryption

Serviço:: Core

Versão da API:: v1

Obtém as configurações de criptografia cmk (chave de Customer-Managed) do workspace.
Retorna as configurações de criptografia do CMK e o status do workspace especificado.

Permissões

O chamador deve ter função de workspace do visualizador ou superior.

Escopos delegados necessários

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

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

Parâmetros de URI

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

Respostas

Nome Tipo Description

200 OK

Nome	Tipo	Description
200 OK	WorkspaceEncryptionDetail	Solicitação concluída com êxito. Se a criptografia estiver em andamento, a resposta incluirá um `Retry-After` cabeçalho. Cabeçalhos: Repetição após`integer` - Indica o número de segundos após o qual o cliente pode tentar novamente obter o status de criptografia.
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.

WorkspaceEncryptionDetail

Solicitação concluída com êxito. Se a criptografia estiver em andamento, a resposta incluirá um Retry-After cabeçalho.

Cabeçalhos:

Repetição apósinteger - Indica o número de segundos após o qual o cliente pode tentar novamente obter o status de criptografia.

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

Get workspace CMK encryption active example

Get workspace CMK encryption in progress example

Get workspace CMK encryption active example

Solicitação de exemplo

HTTP

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

Resposta de exemplo

Código de status:: 200

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

Get workspace CMK encryption in progress example

Solicitação de exemplo

HTTP

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

Resposta de exemplo

Código de status:: 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"
    }
  ]
}

Definições

Nome	Description
EncryptionDetail	Detalhes de criptografia do workspace.
ErrorRelatedResource	O objeto relacionado ao erro nos detalhes do recurso.
ErrorResponse	A resposta de erro.
ErrorResponseDetails	Os detalhes da resposta de erro.
WorkspaceEncryptionDetail	Configurações de criptografia do workspace e detalhes de status.
WorkspaceEncryptionItem	Detalhes do item do workspace.
WorkspaceEncryptionItemsDetail	Detalhes de status de criptografia para itens no workspace.
WorkspaceEncryptionStatus	O status de criptografia do workspace.

EncryptionDetail

Objeto

Detalhes de criptografia do workspace.

Nome	Tipo	Description
encryptionStatus	WorkspaceEncryptionStatus	O status de criptografia do workspace.
keyIdentifier	string	O identificador de chave.

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.

WorkspaceEncryptionDetail

Objeto

Configurações de criptografia do workspace e detalhes de status.

Nome	Tipo	Description
encryptionDetail	EncryptionDetail	Os detalhes de criptografia do workspace.
previousEncryptionDetail	EncryptionDetail	O detalhe de criptografia do workspace anterior.
workspaceEncryptionItemsDetails	WorkspaceEncryptionItemsDetail[]	O status de criptografia dos itens no workspace.

WorkspaceEncryptionItem

Objeto

Detalhes do item do workspace.

Nome	Tipo	Description
displayName	string	O nome de exibição do item.
id	string (uuid)	A ID do item.
type	string	O tipo de item.

WorkspaceEncryptionItemsDetail

Objeto

Detalhes de status de criptografia para itens no workspace.

Nome	Tipo	Description
encryptionStatus	WorkspaceEncryptionStatus	O status de criptografia dos itens.
items	WorkspaceEncryptionItem[]	A matriz de detalhes do item do workspace.

WorkspaceEncryptionStatus

Enumeração

O status de criptografia do workspace.

Valor	Description
Disabled	A criptografia do workspace não está ativa.
Active	A criptografia do workspace está ativa e o workspace é criptografado.
EnableInProgress	A criptografia do workspace está habilitando.
DisableInProgress	A criptografia do workspace está desabilitando.
Failed	Falha no aplicativo de criptografia do workspace.