Workspaces - Assign Workspace Encryption

Tjeneste:

Core

API-version:

v1

Tildeler en Customer-Managed-nøgle (CMK) til et arbejdsområde.
Aktiverer CMK-kryptering for arbejdsområdet eller roterer krypteringsnøglen for arbejdsområdet.

Rettigheder

Den, der ringer op, skal have en administratorarbejdsområderolle.

Påkrævede delegerede områder

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

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

URI-parametre

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

Brødtekst for anmodning

Name	Påkrævet	Type	Beskrivelse
keyIdentifier	True	string	Nøgle-id'et for Azure Key Vault. Dette skal være en versionløs nøgle-URI.

Svar

Name	Type	Beskrivelse
200 OK		Anmodningen blev fuldført.
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

Assign workspace CMK encryption example

Eksempelanmodning

HTTP

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

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

Eksempelsvar

Statuskode:

200

Definitioner

Name	Beskrivelse
AssignWorkspaceEncryptionRequest	Nyttedata for cmkryptering for tildel arbejdsområde.
ErrorRelatedResource	Objektet med fejlrelaterede ressourceoplysninger.
ErrorResponse	Fejlsvaret.
ErrorResponseDetails	Oplysninger om fejlsvar.

AssignWorkspaceEncryptionRequest

Objekt

Nyttedata for cmkryptering for tildel arbejdsområde.

Name	Type	Beskrivelse
keyIdentifier	string	Nøgle-id'et for Azure Key Vault. Dette skal være en versionløs nøgle-URI.

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.