Workspaces - Get Workspace Encryption

Servizio:: Core

Versione API:: v1

Ottiene le impostazioni di crittografia della chiave (CMK) dell'area di lavoro Customer-Managed.
Restituisce le impostazioni di crittografia della chiave gestita dal cliente e lo stato per l'area di lavoro specificata.

Autorizzazioni

Il chiamante deve avere ruolo visualizzatore o superiore.

Ambiti delegati obbligatori

Workspace.Read.All o Workspace.ReadWrite.All

Identità supportate da Microsoft Entra

Questa API supporta le identità di Microsoft elencate in questa sezione.

Identità	Support
User	Yes
Principale del servizio e Identità gestite	Yes

Interfaccia

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
workspaceId	path	True	string (uuid)	L’ID dell’area di lavoro.

Risposte

Nome Tipo Descrizione

200 OK

Nome	Tipo	Descrizione
200 OK	WorkspaceEncryptionDetail	Richiesta completata correttamente. Se la crittografia è in corso, la risposta include un'intestazione `Retry-After` . Intestazioni: Riprovare dopo`integer` - Indica il numero di secondi dopo i quali il client può riprovare a ottenere lo stato di crittografia.
429 Too Many Requests	ErrorResponse	È stato superato il limite di velocità del servizio. Il server restituisce un'intestazione `Retry-After` che indica, in secondi, per quanto tempo il client deve attendere prima di inviare richieste aggiuntive. Intestazioni Retry-After: integer
Other Status Codes	ErrorResponse	Codici di errore comuni: UnknownError: si è verificato un errore.

WorkspaceEncryptionDetail

Richiesta completata correttamente. Se la crittografia è in corso, la risposta include un'intestazione Retry-After .

Intestazioni:

Riprovare dopointeger - Indica il numero di secondi dopo i quali il client può riprovare a ottenere lo stato di crittografia.

429 Too Many Requests

ErrorResponse

È stato superato il limite di velocità del servizio. Il server restituisce un'intestazione Retry-After che indica, in secondi, per quanto tempo il client deve attendere prima di inviare richieste aggiuntive.

Intestazioni

Retry-After: integer

Other Status Codes

ErrorResponse

Codici di errore comuni:

UnknownError: si è verificato un errore.

Esempio

Get workspace CMK encryption active example

Get workspace CMK encryption in progress example

Get workspace CMK encryption active example

Esempio di richiesta

HTTP

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

Risposta di esempio

Codice di stato:: 200

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

Get workspace CMK encryption in progress example

Esempio di richiesta

HTTP

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

Risposta di esempio

Codice di stato:: 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"
    }
  ]
}

Definizioni

Nome	Descrizione
EncryptionDetail	Dettagli della crittografia dell'area di lavoro.
ErrorRelatedResource	Oggetto dei dettagli della risorsa relativo all'errore.
ErrorResponse	Risposta di errore.
ErrorResponseDetails	Dettagli della risposta di errore.
WorkspaceEncryptionDetail	Impostazioni di crittografia dell'area di lavoro e dettagli sullo stato.
WorkspaceEncryptionItem	Dettagli dell'elemento dell'area di lavoro.
WorkspaceEncryptionItemsDetail	Dettagli dello stato della crittografia per gli elementi nell'area di lavoro.
WorkspaceEncryptionStatus	Stato della crittografia dell'area di lavoro.

EncryptionDetail

Oggetto

Dettagli della crittografia dell'area di lavoro.

Nome	Tipo	Descrizione
encryptionStatus	WorkspaceEncryptionStatus	Stato della crittografia dell'area di lavoro.
keyIdentifier	string	Identificatore di chiave.

ErrorRelatedResource

Oggetto

Oggetto dei dettagli della risorsa relativo all'errore.

Nome	Tipo	Descrizione
resourceId	string	ID risorsa coinvolto nell'errore.
resourceType	string	Tipo della risorsa coinvolta nell'errore.

ErrorResponse

Oggetto

Risposta di errore.

Nome	Tipo	Descrizione
errorCode	string	Identificatore specifico che fornisce informazioni su una condizione di errore, consentendo la comunicazione standardizzata tra il servizio e i relativi utenti.
isRetriable	boolean	Se true, la richiesta può essere ritentata. Usare l'intestazione della `Retry-After` risposta per determinare il ritardo, se disponibile.
message	string	Rappresentazione leggibile dell'errore.
moreDetails	ErrorResponseDetails[]	Elenco di dettagli aggiuntivi sull'errore.
relatedResource	ErrorRelatedResource	Dettagli della risorsa correlati all'errore.
requestId	string (uuid)	ID della richiesta associata all'errore.

ErrorResponseDetails

Oggetto

Dettagli della risposta di errore.

Nome	Tipo	Descrizione
errorCode	string	Identificatore specifico che fornisce informazioni su una condizione di errore, consentendo la comunicazione standardizzata tra il servizio e i relativi utenti.
message	string	Rappresentazione leggibile dell'errore.
relatedResource	ErrorRelatedResource	Dettagli della risorsa correlati all'errore.

WorkspaceEncryptionDetail

Oggetto

Impostazioni di crittografia dell'area di lavoro e dettagli sullo stato.

Nome	Tipo	Descrizione
encryptionDetail	EncryptionDetail	Dettagli della crittografia dell'area di lavoro.
previousEncryptionDetail	EncryptionDetail	Dettagli della crittografia dell'area di lavoro precedente.
workspaceEncryptionItemsDetails	WorkspaceEncryptionItemsDetail[]	Stato di crittografia degli elementi nell'area di lavoro.

WorkspaceEncryptionItem

Oggetto

Dettagli dell'elemento dell'area di lavoro.

Nome	Tipo	Descrizione
displayName	string	Nome visualizzato dell'elemento.
id	string (uuid)	ID dell'elemento.
type	string	Tipo di elemento.

WorkspaceEncryptionItemsDetail

Oggetto

Dettagli dello stato della crittografia per gli elementi nell'area di lavoro.

Nome	Tipo	Descrizione
encryptionStatus	WorkspaceEncryptionStatus	Stato di crittografia per gli elementi.
items	WorkspaceEncryptionItem[]	Matrice di dettagli dell'elemento dell'area di lavoro.

WorkspaceEncryptionStatus

Enumerazione

Stato della crittografia dell'area di lavoro.

Valore	Descrizione
Disabled	La crittografia dell'area di lavoro non è attiva.
Active	La crittografia dell'area di lavoro è attiva e l'area di lavoro è crittografata.
EnableInProgress	La crittografia dell'area di lavoro è abilitata.
DisableInProgress	La crittografia dell'area di lavoro viene disabilitata.
Failed	Applicazione di crittografia dell'area di lavoro non riuscita.