Workspaces - Get Workspace Encryption

Tjeneste:

Core

API-versjon:

v1

Henter krypteringsinnstillingene for arbeidsområdet Customer-Managed Key (CMK).
Returnerer CMK-krypteringsinnstillingene og statusen for det angitte arbeidsområdet.

Tillatelser

Innringeren må ha visningsprogram eller høyere arbeidsområderolle.

Nødvendige delegerte omfang

Workspace.Read.All eller Workspace.ReadWrite.All

Microsoft Entra støttede identiteter

Denne API-en støtter Microsoft identiteter oppført i denne delen.

Identity	Kundestøtte
Bruker	Ja
tjenestekontohaver og administrerte identiteter	Ja

Grensesnitt

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

URI-parametere

Navn	I	Obligatorisk	Type	Beskrivelse
workspaceId	path	True	string (uuid)	Arbeidsområde-ID-en.

Svar

Navn	Type	Beskrivelse
200 OK	WorkspaceEncryptionDetail	Forespørselen er fullført. Hvis kryptering pågår, inneholder svaret et Retry-After hode. Overskrifter: Prøv på nytt etterinteger – Angir hvor mange sekunder klienten kan prøve på nytt for å få krypteringsstatusen.
429 Too Many Requests	ErrorResponse	Grensen for tjenestesats ble overskredet. Serveren returnerer en Retry-After topptekst som angir, i sekunder, hvor lenge klienten må vente før du sender flere forespørsler. Overskrifter Retry-After: integer
Other Status Codes	ErrorResponse	Vanlige feilkoder: UnknownError - Det oppstod en feil.

Eksempler

Get workspace CMK encryption active example

Get workspace CMK encryption in progress example

Get workspace CMK encryption active example

Eksempelforespørsel

HTTP

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

Eksempelsvar

Statuskode:

200

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

Get workspace CMK encryption in progress example

Eksempelforespørsel

HTTP

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

Eksempelsvar

Statuskode:

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"
    }
  ]
}

Definisjoner

Navn	Beskrivelse
EncryptionDetail	Krypteringsdetaljer for arbeidsområdet.
ErrorRelatedResource	Objektet for feilrelaterte ressursdetaljer.
ErrorResponse	Feilsvaret.
ErrorResponseDetails	Feilsvardetaljene.
WorkspaceEncryptionDetail	Innstillinger for kryptering av arbeidsområder og statusdetaljer.
WorkspaceEncryptionItem	Detaljer for arbeidsområdeelement.
WorkspaceEncryptionItemsDetail	Krypteringsstatusdetaljer for elementer i arbeidsområdet.
WorkspaceEncryptionStatus	Krypteringsstatusen for arbeidsområdet.

EncryptionDetail

Objekt

Krypteringsdetaljer for arbeidsområdet.

Navn	Type	Beskrivelse
encryptionStatus	WorkspaceEncryptionStatus	Krypteringsstatusen for arbeidsområdet.
keyIdentifier	string	Nøkkelidentifikatoren.

ErrorRelatedResource

Objekt

Objektet for feilrelaterte ressursdetaljer.

Navn	Type	Beskrivelse
resourceId	string	Ressurs-ID-en som er involvert i feilen.
resourceType	string	Typen ressurs som er involvert i feilen.

ErrorResponse

Objekt

Feilsvaret.

Navn	Type	Beskrivelse
errorCode	string	En bestemt identifikator som gir informasjon om en feilbetingelse, noe som gir standardisert kommunikasjon mellom tjenesten og brukerne.
isRetriable	boolean	Når sann, kan forespørselen prøves på nytt. Retry-After Bruk svarhodet til å fastslå forsinkelsen, hvis tilgjengelig.
message	string	En menneskelig lesbar representasjon av feilen.
moreDetails	ErrorResponseDetails[]	Liste over flere feildetaljer.
relatedResource	ErrorRelatedResource	Feilrelaterte ressursdetaljer.
requestId	string (uuid)	ID for forespørselen som er knyttet til feilen.

ErrorResponseDetails

Objekt

Feilsvardetaljene.

Navn	Type	Beskrivelse
errorCode	string	En bestemt identifikator som gir informasjon om en feilbetingelse, noe som gir standardisert kommunikasjon mellom tjenesten og brukerne.
message	string	En menneskelig lesbar representasjon av feilen.
relatedResource	ErrorRelatedResource	Feilrelaterte ressursdetaljer.

WorkspaceEncryptionDetail

Objekt

Innstillinger for kryptering av arbeidsområder og statusdetaljer.

Navn	Type	Beskrivelse
encryptionDetail	EncryptionDetail	Krypteringsdetaljene for arbeidsområdet.
previousEncryptionDetail	EncryptionDetail	Den forrige krypteringsdetaljene for arbeidsområdet.
workspaceEncryptionItemsDetails	WorkspaceEncryptionItemsDetail[]	Krypteringsstatusen for elementer i arbeidsområdet.

WorkspaceEncryptionItem

Objekt

Detaljer for arbeidsområdeelement.

Navn	Type	Beskrivelse
displayName	string	Visningsnavnet for elementet.
id	string (uuid)	Element-IDen.
type	string	Elementtypen.

WorkspaceEncryptionItemsDetail

Objekt

Krypteringsstatusdetaljer for elementer i arbeidsområdet.

Navn	Type	Beskrivelse
encryptionStatus	WorkspaceEncryptionStatus	Krypteringsstatusen for elementene.
items	WorkspaceEncryptionItem[]	Matrisen med detaljer om arbeidsområdeelementer.

WorkspaceEncryptionStatus

Opplisting

Krypteringsstatusen for arbeidsområdet.

Verdi	Beskrivelse
Disabled	Arbeidsområdekryptering er ikke aktivt.
Active	Arbeidsområdekryptering er aktivt og arbeidsområdet krypteres.
EnableInProgress	Arbeidsområdekryptering aktiveres.
DisableInProgress	Kryptering av arbeidsområdet deaktiveres.
Failed	Arbeidsområdekrypteringsprogrammet mislyktes.