Workspaces - Assign Workspace Encryption

Palvelu:
Core
Ohjelmointirajapinnan versio:
v1

Määrittää työtilaan Customer-Managed Avaimen (CMK).
Ottaa käyttöön työtilan CMK-salauksen tai kiertää työtilan salausavaimen.

Käyttöoikeudet

Soittajalla on oltava järjestelmänvalvojan työtilan rooli.

Vaaditut delegoidut vaikutusalueet

Workspace.ReadWrite.All

Microsoft Entran tukemat käyttäjätiedot

Tämä ohjelmointirajapinta tukee tässä osiossa lueteltuja Microsoft -käyttäjätietoja.

Identity Tuki
Käyttäjä Yes
palvelun päänimen ja Hallittujen käyttäjätietojen Yes

Liittymä

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

URI-parametrit

Nimi Kohteessa Pakollinen Tyyppi Kuvaus
workspaceId
 path True

string (uuid)

Työtilan tunnus.

Pyynnön leipäteksti

Nimi Pakollinen Tyyppi Kuvaus
keyIdentifier True

string

Azure Key Vault avaimen tunniste. Tämän on oltava versioton avaimen URI.

Vastaukset

Nimi Tyyppi Kuvaus
200 OK

Pyynnön valmistuttua.
429 Too Many Requests

ErrorResponse

Palveluhinnan raja ylitettiin. Palvelin palauttaa otsikon, joka Retry-After ilmaisee sekunteina, kuinka kauan asiakkaan on odotettava, ennen kuin lisäpyynnöt lähetetään.

Otsikot

Retry-After: integer
Other Status Codes

ErrorResponse

Yleiset virhekoodit:

  • UnknownError – Ilmeni virhe.

Esimerkit

Assign workspace CMK encryption example

Mallipyyntö

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

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

Mallivastaus

Tilakoodi:
200

Määritelmät

Nimi Kuvaus
AssignWorkspaceEncryptionRequest

Määritä työtilan CMK-salauspyynnön tiedot.
ErrorRelatedResource

Virheeseen liittyvä resurssitieto-objekti.
ErrorResponse

Virhevastaus.
ErrorResponseDetails

Virheen vastauksen tiedot.

AssignWorkspaceEncryptionRequest

Kohde

Määritä työtilan CMK-salauspyynnön tiedot.

Nimi Tyyppi Kuvaus
keyIdentifier

string

Azure Key Vault avaimen tunniste. Tämän on oltava versioton avaimen URI.

ErrorRelatedResource

Kohde

Virheeseen liittyvä resurssitieto-objekti.

Nimi Tyyppi Kuvaus
resourceId

string

Virheestä liittyvä resurssitunnus.
resourceType

string

Virheestä liittyvän resurssin tyyppi.

ErrorResponse

Kohde

Virhevastaus.

Nimi Tyyppi Kuvaus
errorCode

string

Tietty tunniste, joka antaa tietoja virheehdosta ja mahdollistaa standardoidun tietoliikenteen palvelumme ja sen käyttäjien välillä.
isRetriable

boolean

Kun arvo on tosi, pyyntöä voidaan yrittää uudelleen. Määritä viive vastausotsikon Retry-After avulla, jos se on käytettävissä.
message

string

Ihmisen luettavissa oleva esitys virheestä.
moreDetails

ErrorResponseDetails[]

Luettelo virheiden lisätiedoista.
relatedResource

ErrorRelatedResource

Virheisiin liittyvät resurssitiedot.
requestId

string (uuid)

Virheeseen liittyvän pyynnön tunnus.

ErrorResponseDetails

Kohde

Virheen vastauksen tiedot.

Nimi Tyyppi Kuvaus
errorCode

string

Tietty tunniste, joka antaa tietoja virheehdosta ja mahdollistaa standardoidun tietoliikenteen palvelumme ja sen käyttäjien välillä.
message

string

Ihmisen luettavissa oleva esitys virheestä.
relatedResource

ErrorRelatedResource

Virheisiin liittyvät resurssitiedot.