Workspaces - Assign Workspace Encryption

Service:
Core
API-versie:
v1

Hiermee wijst u een Customer-Managed-sleutel (CMK) toe aan een werkruimte.
Hiermee schakelt u CMK-versleuteling in voor de werkruimte of roteert u de versleutelingssleutel voor de werkruimte.

Machtigingen

De aanroeper moet een beheerderswerkruimterol hebben.

Vereiste gedelegeerde bevoegdheden

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

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

URI-parameters

Name In Vereist Type Description
workspaceId
 path True

string (uuid)

De werkruimte-ID.

Aanvraagbody

Name Vereist Type Description
keyIdentifier True

string

De Azure Key Vault-sleutel-id. Dit moet een versieloze sleutel-URI zijn.

Antwoorden

Name Type Description
200 OK

De aanvraag is voltooid.
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

Assign workspace CMK encryption example

Voorbeeldaanvraag

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

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

Voorbeeldrespons

Statuscode:
200

Definities

Name Description
AssignWorkspaceEncryptionRequest

De nettolading van de CMK-versleutelingsaanvraag voor de werkruimte toewijzen.
ErrorRelatedResource

Het foutgerelateerde resourcedetailsobject.
ErrorResponse

De foutreactie.
ErrorResponseDetails

De details van het foutbericht.

AssignWorkspaceEncryptionRequest

Object

De nettolading van de CMK-versleutelingsaanvraag voor de werkruimte toewijzen.

Name Type Description
keyIdentifier

string

De Azure Key Vault-sleutel-id. Dit moet een versieloze sleutel-URI zijn.

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.