Workspaces - Get Workspace Encryption

Usługa:: Core

Wersja interfejsu API:: v1

Pobiera ustawienia szyfrowania klucza Customer-Managed (CMK) obszaru roboczego.
Zwraca ustawienia i stan szyfrowania cmK dla określonego obszaru roboczego.

Uprawnienia

Obiekt wywołujący musi mieć lub większą rolę obszaru roboczego.

Wymagane zakresy delegowane

Workspace.Read.All lub Workspace.ReadWrite.All

Tożsamości obsługiwane przez Microsoft Entra

To API obsługuje tożsamości Microsoft wymienione w tej sekcji.

Identity	Support
User	Tak
Główne usługi i Tożsamości zarządzane	Tak

Interfejs

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

Parametry identyfikatora URI

Nazwisko	W	Wymagane	Typ	Opis
workspaceId	path	True	string (uuid)	Identyfikator przestrzeni roboczej.

Odpowiedzi

Nazwisko Typ Opis

200 OK

Nazwisko	Typ	Opis
200 OK	WorkspaceEncryptionDetail	Żądanie zostało ukończone pomyślnie. Jeśli szyfrowanie jest w toku, odpowiedź zawiera `Retry-After` nagłówek. Nagłówki: Ponów próbę po`integer` — wskazuje liczbę sekund, po których klient może ponowić próbę uzyskania stanu szyfrowania.
429 Too Many Requests	ErrorResponse	Przekroczono limit szybkości usługi. Serwer zwraca nagłówek wskazujący `Retry-After` w sekundach, jak długo klient musi czekać przed wysłaniem dodatkowych żądań. Nagłówki Retry-After: integer
Other Status Codes	ErrorResponse	Typowe kody błędów: UnknownError — wystąpił błąd.

WorkspaceEncryptionDetail

Żądanie zostało ukończone pomyślnie. Jeśli szyfrowanie jest w toku, odpowiedź zawiera Retry-After nagłówek.

Nagłówki:

Ponów próbę pointeger — wskazuje liczbę sekund, po których klient może ponowić próbę uzyskania stanu szyfrowania.

429 Too Many Requests

ErrorResponse

Przekroczono limit szybkości usługi. Serwer zwraca nagłówek wskazujący Retry-After w sekundach, jak długo klient musi czekać przed wysłaniem dodatkowych żądań.

Nagłówki

Retry-After: integer

Other Status Codes

ErrorResponse

Typowe kody błędów:

UnknownError — wystąpił błąd.

Przykłady

Get workspace CMK encryption active example

Get workspace CMK encryption in progress example

Get workspace CMK encryption active example

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:: 200

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

Get workspace CMK encryption in progress example

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:: 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"
    }
  ]
}

Definicje

Nazwisko	Opis
EncryptionDetail	Szczegóły szyfrowania obszaru roboczego.
ErrorParameter	Parametr ustrukturyzowany zapewniający dodatkowy kontekst czytelny dla maszyny o błędzie.
ErrorRelatedResource	Obiekt szczegółowych informacji o zasobie związanym z błędem.
ErrorResponse	Odpowiedź na błąd.
ErrorResponseDetails	Szczegóły odpowiedzi na błąd.
WorkspaceEncryptionDetail	Ustawienia szyfrowania obszaru roboczego i szczegóły stanu.
WorkspaceEncryptionItem	Szczegóły elementu obszaru roboczego.
WorkspaceEncryptionItemsDetail	Szczegóły stanu szyfrowania elementów w obszarze roboczym.
WorkspaceEncryptionStatus	Stan szyfrowania obszaru roboczego.

EncryptionDetail

Objekt

Szczegóły szyfrowania obszaru roboczego.

Nazwisko	Typ	Opis
encryptionStatus	WorkspaceEncryptionStatus	Stan szyfrowania obszaru roboczego.
keyIdentifier	string	Identyfikator klucza.

ErrorParameter

Objekt

Parametr ustrukturyzowany zapewniający dodatkowy kontekst czytelny dla maszyny o błędzie.

Nazwisko	Typ	Opis
message	string	Czytelny dla człowieka opis znaczenia parametru.
name	string	Identyfikator parametru.
value	string	Wartość parametru.

ErrorRelatedResource

Objekt

Obiekt szczegółowych informacji o zasobie związanym z błędem.

Nazwisko	Typ	Opis
resourceId	string	Identyfikator zasobu powiązany z błędem.
resourceType	string	Typ zasobu powiązanego z błędem.

ErrorResponse

Objekt

Odpowiedź na błąd.

Nazwisko	Typ	Opis
errorCode	string	Określony identyfikator, który zawiera informacje o stanie błędu, co pozwala na ustandaryzowaną komunikację między naszą usługą a jej użytkownikami.
isRetriable	boolean	Jeśli to prawda, żądanie można ponowić. Użyj nagłówka `Retry-After` odpowiedzi, aby określić opóźnienie, jeśli jest dostępne.
message	string	Czytelna reprezentacja błędu przez człowieka.
moreDetails	ErrorResponseDetails[]	Lista dodatkowych szczegółów błędu.
parameters	ErrorParameter[]	Parametry ustrukturyzowane zapewniające dodatkowy kontekst czytelny dla maszyny o błędzie.
relatedResource	ErrorRelatedResource	Szczegóły zasobu powiązanego z błędem.
requestId	string (uuid)	Identyfikator żądania skojarzonego z błędem.

ErrorResponseDetails

Objekt

Szczegóły odpowiedzi na błąd.

Nazwisko	Typ	Opis
errorCode	string	Określony identyfikator, który zawiera informacje o stanie błędu, co pozwala na ustandaryzowaną komunikację między naszą usługą a jej użytkownikami.
message	string	Czytelna reprezentacja błędu przez człowieka.
parameters	ErrorParameter[]	Parametry ustrukturyzowane zapewniające dodatkowy kontekst czytelny dla maszyny o błędzie.
relatedResource	ErrorRelatedResource	Szczegóły zasobu powiązanego z błędem.

WorkspaceEncryptionDetail

Objekt

Ustawienia szyfrowania obszaru roboczego i szczegóły stanu.

Nazwisko	Typ	Opis
encryptionDetail	EncryptionDetail	Szczegóły szyfrowania obszaru roboczego.
previousEncryptionDetail	EncryptionDetail	Szczegóły szyfrowania poprzedniego obszaru roboczego.
workspaceEncryptionItemsDetails	WorkspaceEncryptionItemsDetail[]	Stan szyfrowania elementów w obszarze roboczym.

WorkspaceEncryptionItem

Objekt

Szczegóły elementu obszaru roboczego.

Nazwisko	Typ	Opis
displayName	string	Nazwa wyświetlana elementu.
id	string (uuid)	Identyfikator elementu.
type	string	Typ elementu.

WorkspaceEncryptionItemsDetail

Objekt

Szczegóły stanu szyfrowania elementów w obszarze roboczym.

Nazwisko	Typ	Opis
encryptionStatus	WorkspaceEncryptionStatus	Stan szyfrowania elementów.
items	WorkspaceEncryptionItem[]	Tablica szczegółów elementu obszaru roboczego.

WorkspaceEncryptionStatus

Wyliczenie

Stan szyfrowania obszaru roboczego.

Wartość	Opis
Disabled	Szyfrowanie obszaru roboczego nie jest aktywne.
Active	Szyfrowanie obszaru roboczego jest aktywne i obszar roboczy jest szyfrowany.
EnableInProgress	Szyfrowanie obszaru roboczego jest włączone.
DisableInProgress	Szyfrowanie obszaru roboczego jest wyłączane.
Failed	Aplikacja szyfrowania obszaru roboczego nie powiodła się.