Workspaces - Get Workspace Encryption

Serviço:: Core

Versão da API:: v1

Obtém as definições de encriptação do workspace Customer-Managed Key (CMK).
Devolve as definições e o estado da encriptação CMK para o espaço de trabalho especificado.

Permissões

O chamador deve ter visualizador ou superior função de espaço de trabalho.

Escopos delegados necessários

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

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

Parâmetros do URI

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

Respostas

Name Tipo Descrição

200 OK

Name	Tipo	Descrição
200 OK	WorkspaceEncryptionDetail	Pedido concluído com sucesso. Se a encriptação estiver em curso, a resposta inclui um `Retry-After` cabeçalho. Cabeçalhos: Re-Try After`integer` - Indica o número de segundos após os quais o cliente pode tentar novamente para obter o estado da encriptação.
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.

WorkspaceEncryptionDetail

Pedido concluído com sucesso. Se a encriptação estiver em curso, a resposta inclui um Retry-After cabeçalho.

Cabeçalhos:

Re-Try Afterinteger - Indica o número de segundos após os quais o cliente pode tentar novamente para obter o estado da encriptação.

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

Get workspace CMK encryption active example

Get workspace CMK encryption in progress example

Get workspace CMK encryption active example

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:: 200

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

Get workspace CMK encryption in progress example

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:: 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

Name	Descrição
EncryptionDetail	Detalhes da encriptação do espaço de trabalho.
ErrorRelatedResource	Os detalhes do objeto de recurso relacionado ao erro.
ErrorResponse	A resposta de erro.
ErrorResponseDetails	Os detalhes do erro na resposta.
WorkspaceEncryptionDetail	Definições de encriptação do espaço de trabalho e detalhes de estado.
WorkspaceEncryptionItem	Detalhes dos itens do espaço de trabalho.
WorkspaceEncryptionItemsDetail	Detalhes do estado da encriptação dos itens no espaço de trabalho.
WorkspaceEncryptionStatus	O estado da encriptação do espaço de trabalho.

EncryptionDetail

Object

Detalhes da encriptação do espaço de trabalho.

Name	Tipo	Descrição
encryptionStatus	WorkspaceEncryptionStatus	O estado da encriptação do espaço de trabalho.
keyIdentifier	string	O identificador de chave.

ErrorRelatedResource

Object

Os detalhes do objeto de recurso relacionado ao erro.

Name	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.

Name	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.
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.

Name	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.
relatedResource	ErrorRelatedResource	Detalhes do recurso relacionado ao erro.

WorkspaceEncryptionDetail

Object

Definições de encriptação do espaço de trabalho e detalhes de estado.

Name	Tipo	Descrição
encryptionDetail	EncryptionDetail	O detalhe da encriptação do espaço de trabalho.
previousEncryptionDetail	EncryptionDetail	O detalhe anterior da encriptação do espaço de trabalho.
workspaceEncryptionItemsDetails	WorkspaceEncryptionItemsDetail[]	O estado de encriptação dos itens no espaço de trabalho.

WorkspaceEncryptionItem

Object

Detalhes dos itens do espaço de trabalho.

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

WorkspaceEncryptionItemsDetail

Object

Detalhes do estado da encriptação dos itens no espaço de trabalho.

Name	Tipo	Descrição
encryptionStatus	WorkspaceEncryptionStatus	O estado de encriptação dos itens.
items	WorkspaceEncryptionItem[]	A variedade de detalhes dos itens do espaço de trabalho.

WorkspaceEncryptionStatus

Enumeração

O estado da encriptação do espaço de trabalho.

Valor	Descrição
Disabled	A encriptação do espaço de trabalho não está ativa.
Active	A encriptação do espaço de trabalho está ativa e o espaço de trabalho está encriptado.
EnableInProgress	A encriptação do espaço de trabalho é uma possibilitação.
DisableInProgress	A encriptação do espaço de trabalho está a desabilitar.
Failed	A aplicação de encriptação do espaço de trabalho falhou.