Workspaces - Get Workspace Encryption

Tjeneste:: Core

API-version:: v1

Henter indstillingerne for kryptering af arbejdsområdet Customer-Managed nøgle (CMK).
Returnerer CMK-krypteringsindstillingerne og -status for det angivne arbejdsområde.

Rettigheder

Den, der ringer op, skal have seer eller en højere rolle i arbejdsområdet.

Påkrævede delegerede områder

Workspace.Read.All eller Workspace.ReadWrite.All

Microsoft Entra understøttede identiteter

Denne API understøtter de Microsoft identities, der er angivet i dette afsnit.

Identity	Støtte
Bruger	Ja
tjenesteprincipal og administrerede identiteter	Ja

Grænseflade

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

URI-parametre

Name	I	Påkrævet	Type	Beskrivelse
workspaceId	path	True	string (uuid)	Arbejdsområde-id'et.

Svar

Name Type Beskrivelse

200 OK

Name	Type	Beskrivelse
200 OK	WorkspaceEncryptionDetail	Anmodningen blev fuldført. Hvis kryptering er i gang, indeholder svaret en `Retry-After` header. Overskrifter: Prøv igen efter`integer` – Angiver det antal sekunder, hvorefter klienten kan forsøge at hente krypteringsstatussen igen.
429 Too Many Requests	ErrorResponse	Grænsen for tjenestetakst blev overskredet. Serveren returnerer en `Retry-After` header, der angiver, i sekunder, hvor længe klienten skal vente, før der sendes yderligere anmodninger. Headere Retry-After: integer
Other Status Codes	ErrorResponse	Almindelige fejlkoder: UnknownError – Der opstod en fejl.

WorkspaceEncryptionDetail

Anmodningen blev fuldført. Hvis kryptering er i gang, indeholder svaret en Retry-After header.

Overskrifter:

Prøv igen efterinteger – Angiver det antal sekunder, hvorefter klienten kan forsøge at hente krypteringsstatussen igen.

429 Too Many Requests

ErrorResponse

Grænsen for tjenestetakst blev overskredet. Serveren returnerer en Retry-After header, der angiver, i sekunder, hvor længe klienten skal vente, før der sendes yderligere anmodninger.

Headere

Retry-After: integer

Other Status Codes

ErrorResponse

Almindelige fejlkoder:

UnknownError – Der opstod en fejl.

Eksempler

Get workspace CMK encryption active example

Get workspace CMK encryption in progress example

Get workspace CMK encryption active example

Eksempelanmodning

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

Eksempelanmodning

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

Definitioner

Name	Beskrivelse
EncryptionDetail	Oplysninger om kryptering af arbejdsområde.
ErrorRelatedResource	Objektet med fejlrelaterede ressourceoplysninger.
ErrorResponse	Fejlsvaret.
ErrorResponseDetails	Oplysninger om fejlsvar.
WorkspaceEncryptionDetail	Indstillinger for kryptering af arbejdsområde og statusoplysninger.
WorkspaceEncryptionItem	Oplysninger om arbejdsområdeelement.
WorkspaceEncryptionItemsDetail	Oplysninger om krypteringsstatus for elementer i arbejdsområdet.
WorkspaceEncryptionStatus	Krypteringsstatus for arbejdsområdet.

EncryptionDetail

Objekt

Oplysninger om kryptering af arbejdsområde.

Name	Type	Beskrivelse
encryptionStatus	WorkspaceEncryptionStatus	Krypteringsstatus for arbejdsområdet.
keyIdentifier	string	Nøgle-id'et.

ErrorRelatedResource

Objekt

Objektet med fejlrelaterede ressourceoplysninger.

Name	Type	Beskrivelse
resourceId	string	Det ressource-id, der er involveret i fejlen.
resourceType	string	Typen af ressource, der er involveret i fejlen.

ErrorResponse

Objekt

Fejlsvaret.

Name	Type	Beskrivelse
errorCode	string	Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.
isRetriable	boolean	Når sand, kan anmodningen prøves igen. Brug svarheaderen `Retry-After` til at bestemme forsinkelsen, hvis den er tilgængelig.
message	string	En menneskelig læsbar gengivelse af fejlen.
moreDetails	ErrorResponseDetails[]	Liste over yderligere oplysninger om fejl.
relatedResource	ErrorRelatedResource	De fejlrelaterede ressourceoplysninger.
requestId	string (uuid)	Id'et for den anmodning, der er knyttet til fejlen.

ErrorResponseDetails

Objekt

Oplysninger om fejlsvar.

Name	Type	Beskrivelse
errorCode	string	Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.
message	string	En menneskelig læsbar gengivelse af fejlen.
relatedResource	ErrorRelatedResource	De fejlrelaterede ressourceoplysninger.

WorkspaceEncryptionDetail

Objekt

Indstillinger for kryptering af arbejdsområde og statusoplysninger.

Name	Type	Beskrivelse
encryptionDetail	EncryptionDetail	Oplysninger om kryptering af arbejdsområdet.
previousEncryptionDetail	EncryptionDetail	De forrige krypteringsoplysninger for arbejdsområdet.
workspaceEncryptionItemsDetails	WorkspaceEncryptionItemsDetail[]	Krypteringsstatus for elementer i arbejdsområdet.

WorkspaceEncryptionItem

Objekt

Oplysninger om arbejdsområdeelement.

Name	Type	Beskrivelse
displayName	string	Det viste elementnavn.
id	string (uuid)	Element-id'et.
type	string	Elementtypen.

WorkspaceEncryptionItemsDetail

Objekt

Oplysninger om krypteringsstatus for elementer i arbejdsområdet.

Name	Type	Beskrivelse
encryptionStatus	WorkspaceEncryptionStatus	Krypteringsstatus for elementerne.
items	WorkspaceEncryptionItem[]	Matrixen af detaljer om arbejdsområdeelement.

WorkspaceEncryptionStatus

Optælling

Krypteringsstatus for arbejdsområdet.

Værdi	Beskrivelse
Disabled	Kryptering af arbejdsområdet er ikke aktiv.
Active	Kryptering af arbejdsområdet er aktiv, og arbejdsområdet er krypteret.
EnableInProgress	Kryptering af arbejdsområdet aktiveres.
DisableInProgress	Kryptering af arbejdsområdet deaktiveres.
Failed	Krypteringsprogrammet til arbejdsområdet mislykkedes.