Workspaces - Assign Workspace Encryption

Service:

Core

Versione API:

v1

Assegna una chiave Customer-Managed (CMK) a un'area di lavoro.
Abilita la crittografia cmk per l'area di lavoro o ruota la chiave di crittografia per l'area di lavoro.

Autorizzazioni

Il chiamante deve avere un ruolo di area di lavoro amministratore .

Ambiti delegati obbligatori

SpazioDiLavoro.LetturaScrittura.Tutti

Identità supportate da Microsoft Entra

Questa API supporta le identità di Microsoft elencate in questa sezione.

Identità	Support
User	Yes
Principale del servizio e Identità gestite	Yes

Interfaccia

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
workspaceId	path	True	string (uuid)	L’ID dell’area di lavoro.

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
keyIdentifier	True	string	Identificatore di chiave Azure Key Vault. Deve trattarsi di un URI della chiave senza versione.

Risposte

Nome	Tipo	Descrizione
200 OK		Richiesta completata correttamente.
429 Too Many Requests	ErrorResponse	È stato superato il limite di velocità del servizio. Il server restituisce un'intestazione Retry-After che indica, in secondi, per quanto tempo il client deve attendere prima di inviare richieste aggiuntive. Intestazioni Retry-After: integer
Other Status Codes	ErrorResponse	Codici di errore comuni: UnknownError: si è verificato un errore.

Esempio

Assign workspace CMK encryption example

Esempio di richiesta

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/"
}

Risposta di esempio

Codice di stato:

200

Definizioni

Nome	Descrizione
AssignWorkspaceEncryptionRequest	Payload della richiesta di crittografia CMK Assegna area di lavoro.
ErrorParameter	Parametro strutturato che fornisce un contesto aggiuntivo leggibile dal computer relativo a un errore.
ErrorRelatedResource	Oggetto dei dettagli della risorsa relativo all'errore.
ErrorResponse	Risposta di errore.
ErrorResponseDetails	Dettagli della risposta di errore.

AssignWorkspaceEncryptionRequest

Oggetto

Payload della richiesta di crittografia CMK Assegna area di lavoro.

Nome	Tipo	Descrizione
keyIdentifier	string	Identificatore di chiave Azure Key Vault. Deve trattarsi di un URI della chiave senza versione.

ErrorParameter

Oggetto

Parametro strutturato che fornisce un contesto aggiuntivo leggibile dal computer relativo a un errore.

Nome	Tipo	Descrizione
message	string	Descrizione leggibile del significato del parametro.
name	string	L'identificatore dei parametri.
value	string	Valore del parametro.

ErrorRelatedResource

Oggetto

Oggetto dei dettagli della risorsa relativo all'errore.

Nome	Tipo	Descrizione
resourceId	string	ID risorsa coinvolto nell'errore.
resourceType	string	Tipo della risorsa coinvolta nell'errore.

ErrorResponse

Oggetto

Risposta di errore.

Nome	Tipo	Descrizione
errorCode	string	Identificatore specifico che fornisce informazioni su una condizione di errore, consentendo la comunicazione standardizzata tra il servizio e i relativi utenti.
isRetriable	boolean	Se true, la richiesta può essere ritentata. Usare l'intestazione della Retry-After risposta per determinare il ritardo, se disponibile.
message	string	Rappresentazione leggibile dell'errore.
moreDetails	ErrorResponseDetails[]	Elenco di dettagli aggiuntivi sull'errore.
parameters	ErrorParameter[]	Parametri strutturati che forniscono un contesto aggiuntivo leggibile dal computer sull'errore.
relatedResource	ErrorRelatedResource	Dettagli della risorsa correlati all'errore.
requestId	string (uuid)	ID della richiesta associata all'errore.

ErrorResponseDetails

Oggetto

Dettagli della risposta di errore.

Nome	Tipo	Descrizione
errorCode	string	Identificatore specifico che fornisce informazioni su una condizione di errore, consentendo la comunicazione standardizzata tra il servizio e i relativi utenti.
message	string	Rappresentazione leggibile dell'errore.
parameters	ErrorParameter[]	Parametri strutturati che forniscono un contesto aggiuntivo leggibile dal computer sull'errore.
relatedResource	ErrorRelatedResource	Dettagli della risorsa correlati all'errore.