Workspaces - Assign Workspace Encryption

Tjeneste:: Core

API-versjon:: v1

Tilordner en Customer-Managed nøkkel (CMK) til et arbeidsområde.
Aktiverer CMK-kryptering for arbeidsområdet eller roterer krypteringsnøkkelen for arbeidsområdet.

Tillatelser

Innringeren må ha en arbeidsområderolle for administratorer .

Nødvendige delegerte omfang

Workspace.ReadWrite.All

Microsoft Entra støttede identiteter

Denne API-en støtter Microsoft identiteter oppført i denne delen.

Identity	Kundestøtte
Bruker	Ja
tjenestekontohaver og administrerte identiteter	Ja

Grensesnitt

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

URI-parametere

Navn	I	Obligatorisk	Type	Beskrivelse
workspaceId	path	True	string (uuid)	Arbeidsområde-ID-en.

Brødtekst for forespørsel

Navn	Obligatorisk	Type	Beskrivelse
keyIdentifier	True	string	Nøkkelidentifikatoren Azure Key Vault. Dette må være en versjonsløs nøkkel-URI.

Svar

Navn Type Beskrivelse

200 OK

Navn	Type	Beskrivelse
200 OK		Forespørselen er fullført.
429 Too Many Requests	ErrorResponse	Grensen for tjenestesats ble overskredet. Serveren returnerer en `Retry-After` topptekst som angir, i sekunder, hvor lenge klienten må vente før du sender flere forespørsler. Overskrifter Retry-After: integer
Other Status Codes	ErrorResponse	Vanlige feilkoder: UnknownError - Det oppstod en feil.

Forespørselen er fullført.

429 Too Many Requests

ErrorResponse

Grensen for tjenestesats ble overskredet. Serveren returnerer en Retry-After topptekst som angir, i sekunder, hvor lenge klienten må vente før du sender flere forespørsler.

Overskrifter

Retry-After: integer

Other Status Codes

ErrorResponse

Vanlige feilkoder:

UnknownError - Det oppstod en feil.

Eksempler

Assign workspace CMK encryption example

Eksempelforespørsel

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

Definisjoner

Navn	Beskrivelse
AssignWorkspaceEncryptionRequest	Payload for CMK-krypteringsforespørsel for tilordnet arbeidsområde.
ErrorRelatedResource	Objektet for feilrelaterte ressursdetaljer.
ErrorResponse	Feilsvaret.
ErrorResponseDetails	Feilsvardetaljene.

AssignWorkspaceEncryptionRequest

Objekt

Payload for CMK-krypteringsforespørsel for tilordnet arbeidsområde.

Navn	Type	Beskrivelse
keyIdentifier	string	Nøkkelidentifikatoren Azure Key Vault. Dette må være en versjonsløs nøkkel-URI.

ErrorRelatedResource

Objekt

Objektet for feilrelaterte ressursdetaljer.

Navn	Type	Beskrivelse
resourceId	string	Ressurs-ID-en som er involvert i feilen.
resourceType	string	Typen ressurs som er involvert i feilen.

ErrorResponse

Objekt

Feilsvaret.

Navn	Type	Beskrivelse
errorCode	string	En bestemt identifikator som gir informasjon om en feilbetingelse, noe som gir standardisert kommunikasjon mellom tjenesten og brukerne.
isRetriable	boolean	Når sann, kan forespørselen prøves på nytt. `Retry-After` Bruk svarhodet til å fastslå forsinkelsen, hvis tilgjengelig.
message	string	En menneskelig lesbar representasjon av feilen.
moreDetails	ErrorResponseDetails[]	Liste over flere feildetaljer.
relatedResource	ErrorRelatedResource	Feilrelaterte ressursdetaljer.
requestId	string (uuid)	ID for forespørselen som er knyttet til feilen.

ErrorResponseDetails

Objekt

Feilsvardetaljene.

Navn	Type	Beskrivelse
errorCode	string	En bestemt identifikator som gir informasjon om en feilbetingelse, noe som gir standardisert kommunikasjon mellom tjenesten og brukerne.
message	string	En menneskelig lesbar representasjon av feilen.
relatedResource	ErrorRelatedResource	Feilrelaterte ressursdetaljer.