Workspaces - Assign Workspace Encryption

Tjänst:
Core
API-version:
v1

Tilldelar en Customer-Managed nyckel (CMK) till en arbetsyta.
Aktiverar CMK-kryptering för arbetsytan eller roterar krypteringsnyckeln för arbetsytan.

Behörigheter

Anroparen måste ha en administratörsroll för arbetsytan.

Obligatoriska delegerade omfång

Arbetsutrymme.LäsSkriv.Allt

Identiteter som stöds av Microsoft Entra

Det här API:et stöder Microsoft identiteter som anges i det här avsnittet.

Identitet Support
User Ja
Tjänsthuvudnamn och hanterade identiteter Ja

Interface

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

URI-parametrar

Name I Obligatorisk Typ Description
workspaceId
 path True

string (uuid)

Arbetsyte-ID.

Begärandetext

Name Obligatorisk Typ Description
keyIdentifier True

string

Azure Key Vault nyckelidentifierare. Detta måste vara en versionslös nyckel-URI.

Svar

Name Typ Description
200 OK

Begäran har slutförts.
429 Too Many Requests

ErrorResponse

Gränsen för tjänstfrekvens överskreds. Servern returnerar ett Retry-After huvud som anger i sekunder hur länge klienten måste vänta innan ytterligare begäranden skickas.

Sidhuvuden

Retry-After: integer
Other Status Codes

ErrorResponse

Vanliga felkoder:

  • UnknownError – Ett fel uppstod.

Exempel

Assign workspace CMK encryption example

Exempelbegäran

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

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

Exempelsvar

Statuskod:
200

Definitioner

Name Description
AssignWorkspaceEncryptionRequest

Nyttolasten Tilldela CMK-krypteringsbegäran för arbetsyta.
ErrorRelatedResource

Det felrelaterade resursinformationsobjektet.
ErrorResponse

Felsvaret.
ErrorResponseDetails

Detaljer om felsvaret.

AssignWorkspaceEncryptionRequest

Objekt

Nyttolasten Tilldela CMK-krypteringsbegäran för arbetsyta.

Name Typ Description
keyIdentifier

string

Azure Key Vault nyckelidentifierare. Detta måste vara en versionslös nyckel-URI.

ErrorRelatedResource

Objekt

Det felrelaterade resursinformationsobjektet.

Name Typ Description
resourceId

string

Resurs-ID:t som är inblandat i felet.
resourceType

string

Typen av resurs som är inblandad i felet.

ErrorResponse

Objekt

Felsvaret.

Name Typ Description
errorCode

string

En specifik identifierare som ger information om ett feltillstånd, vilket möjliggör standardiserad kommunikation mellan vår tjänst och dess användare.
isRetriable

boolean

När det är sant kan begäran göras på nytt. Använd svarshuvudet Retry-After för att fastställa fördröjningen, om den är tillgänglig.
message

string

En mänsklig läsbar representation av felet.
moreDetails

ErrorResponseDetails[]

Lista över ytterligare felinformation.
relatedResource

ErrorRelatedResource

Detaljer om resursen relaterad till felet.
requestId

string (uuid)

ID för den begäran som är associerad med felet.

ErrorResponseDetails

Objekt

Detaljer om felsvaret.

Name Typ Description
errorCode

string

En specifik identifierare som ger information om ett feltillstånd, vilket möjliggör standardiserad kommunikation mellan vår tjänst och dess användare.
message

string

En mänsklig läsbar representation av felet.
relatedResource

ErrorRelatedResource

Detaljer om resursen relaterad till felet.