Workspaces - Get Workspace Encryption

Service:: Core

API-versie:: v1

Hiermee haalt u de versleutelingsinstellingen van de werkruimte op Customer-Managed Sleutel (CMK).
Retourneert de CMK-versleutelingsinstellingen en -status voor de opgegeven werkruimte.

Machtigingen

De beller moet viewer hebben of een hogere werkruimterol.

Vereiste gedelegeerde bevoegdheden

Workspace.Read.All of Workspace.ReadWrite.All

Door Microsoft Entra ondersteunde identiteiten

Deze API ondersteunt de Microsoft-identiteiten die in deze sectie worden vermeld.

Identiteit	Support
User	Yes
serviceprincipal en beheerde identiteiten	Yes

Interface

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

URI-parameters

Name	In	Vereist	Type	Description
workspaceId	path	True	string (uuid)	De werkruimte-ID.

Antwoorden

Name Type Description

200 OK

Name	Type	Description
200 OK	WorkspaceEncryptionDetail	De aanvraag is voltooid. Als versleuteling wordt uitgevoerd, bevat het antwoord een `Retry-After` header. Kopteksten: Opnieuw proberen na`integer` - Geeft het aantal seconden aan waarna de client de versleutelingsstatus opnieuw kan proberen op te halen.
429 Too Many Requests	ErrorResponse	De servicesnelheidslimiet is overschreden. De server retourneert een `Retry-After` header die in seconden aangeeft hoe lang de client moet wachten voordat extra aanvragen worden verzonden. Kopteksten Retry-After: integer
Other Status Codes	ErrorResponse	Veelvoorkomende foutcodes: UnknownError: er is een fout opgetreden.

WorkspaceEncryptionDetail

De aanvraag is voltooid. Als versleuteling wordt uitgevoerd, bevat het antwoord een Retry-After header.

Kopteksten:

Opnieuw proberen nainteger - Geeft het aantal seconden aan waarna de client de versleutelingsstatus opnieuw kan proberen op te halen.

429 Too Many Requests

ErrorResponse

De servicesnelheidslimiet is overschreden. De server retourneert een Retry-After header die in seconden aangeeft hoe lang de client moet wachten voordat extra aanvragen worden verzonden.

Kopteksten

Retry-After: integer

Other Status Codes

ErrorResponse

Veelvoorkomende foutcodes:

UnknownError: er is een fout opgetreden.

Voorbeelden

Get workspace CMK encryption active example

Get workspace CMK encryption in progress example

Get workspace CMK encryption active example

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

Statuscode:: 200

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

Get workspace CMK encryption in progress example

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

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

Definities

Name	Description
EncryptionDetail	Details van werkruimteversleuteling.
ErrorRelatedResource	Het foutgerelateerde resourcedetailsobject.
ErrorResponse	De foutreactie.
ErrorResponseDetails	De details van het foutbericht.
WorkspaceEncryptionDetail	Instellingen en statusgegevens voor werkruimteversleuteling.
WorkspaceEncryptionItem	Details van werkruimte-item.
WorkspaceEncryptionItemsDetail	Details van versleutelingsstatus voor items in de werkruimte.
WorkspaceEncryptionStatus	De versleutelingsstatus van de werkruimte.

EncryptionDetail

Object

Details van werkruimteversleuteling.

Name	Type	Description
encryptionStatus	WorkspaceEncryptionStatus	De versleutelingsstatus van de werkruimte.
keyIdentifier	string	De sleutel-id.

ErrorRelatedResource

Object

Het foutgerelateerde resourcedetailsobject.

Name	Type	Description
resourceId	string	De resource-ID die betrokken is bij het probleem.
resourceType	string	Het type resource dat betrokken is bij de fout.

ErrorResponse

Object

De foutreactie.

Name	Type	Description
errorCode	string	Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.
isRetriable	boolean	Wanneer waar, kan de aanvraag opnieuw worden geprobeerd. Gebruik de `Retry-After` antwoordheader om de vertraging te bepalen, indien beschikbaar.
message	string	Een leesbare weergave van de fout.
moreDetails	ErrorResponseDetails[]	Lijst met aanvullende foutdetails.
relatedResource	ErrorRelatedResource	Details van de foutgerelateerde resource.
requestId	string (uuid)	Id van de aanvraag die is gekoppeld aan de fout.

ErrorResponseDetails

Object

De details van het foutbericht.

Name	Type	Description
errorCode	string	Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.
message	string	Een leesbare weergave van de fout.
relatedResource	ErrorRelatedResource	Details van de foutgerelateerde resource.

WorkspaceEncryptionDetail

Object

Instellingen en statusgegevens voor werkruimteversleuteling.

Name	Type	Description
encryptionDetail	EncryptionDetail	De details van de werkruimteversleuteling.
previousEncryptionDetail	EncryptionDetail	De gegevens van de vorige werkruimteversleuteling.
workspaceEncryptionItemsDetails	WorkspaceEncryptionItemsDetail[]	De versleutelingsstatus van items in de werkruimte.

WorkspaceEncryptionItem

Object

Details van werkruimte-item.

Name	Type	Description
displayName	string	De weergavenaam van het item.
id	string (uuid)	De item-id.
type	string	Het itemtype.

WorkspaceEncryptionItemsDetail

Object

Details van versleutelingsstatus voor items in de werkruimte.

Name	Type	Description
encryptionStatus	WorkspaceEncryptionStatus	De versleutelingsstatus voor de items.
items	WorkspaceEncryptionItem[]	De matrix met details van werkruimte-items.

WorkspaceEncryptionStatus

Opsomming

De versleutelingsstatus van de werkruimte.

Waarde	Description
Disabled	Werkruimteversleuteling is niet actief.
Active	Werkruimteversleuteling is actief en de werkruimte is versleuteld.
EnableInProgress	Werkruimteversleuteling wordt ingeschakeld.
DisableInProgress	Werkruimteversleuteling wordt uitgeschakeld.
Failed	Werkruimteversleutelingstoepassing is mislukt.