Workspaces - Get Workspace Encryption

Palvelu:: Core

Ohjelmointirajapinnan versio:: v1

Hakee työtilan Customer-Managed Avain (CMK) -salausasetukset.
Palauttaa määritetyn työtilan CMK-salausasetukset ja tilan.

Käyttöoikeudet

Kutsujalla on oltava katselijan tai suurempi työtilarooli.

Vaaditut delegoidut vaikutusalueet

Workspace.Read.All tai 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ä

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

URI-parametrit

Nimi	Kohteessa	Pakollinen	Tyyppi	Kuvaus
workspaceId	path	True	string (uuid)	Työtilan tunnus.

Vastaukset

Nimi Tyyppi Kuvaus

200 OK

Nimi	Tyyppi	Kuvaus
200 OK	WorkspaceEncryptionDetail	Pyynnön valmistuttua. Jos salaus on käynnissä, vastaus sisältää `Retry-After` otsikon. Otsikot: Yritä uudelleen jälkeen`integer` - Ilmaisee, kuinka monen sekunnin kuluttua asiakas voi yrittää saada salauksen tilan uudelleen.
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.

WorkspaceEncryptionDetail

Pyynnön valmistuttua. Jos salaus on käynnissä, vastaus sisältää Retry-After otsikon.

Otsikot:

Yritä uudelleen jälkeeninteger - Ilmaisee, kuinka monen sekunnin kuluttua asiakas voi yrittää saada salauksen tilan uudelleen.

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

Get workspace CMK encryption active example

Get workspace CMK encryption in progress example

Get workspace CMK encryption active example

Mallipyyntö

HTTP

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

Mallivastaus

Tilakoodi:: 200

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

Get workspace CMK encryption in progress example

Mallipyyntö

HTTP

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

Mallivastaus

Tilakoodi:: 200

Retry-After: 900

{
  "encryptionDetail": {
    "keyIdentifier": "https://westus07112025-cmktest1.vault.azure.net/keys/test2k/",
    "encryptionStatus": "EnableInProgress"
  },
  "previousEncryptionDetail": {
    "keyIdentifier": "https://westus07112025-cmktest1.vault.azure.net/keys/key1/",
    "encryptionStatus": "Active"
  },
  "workspaceEncryptionItemsDetails": [
    {
      "items": [
        {
          "displayName": "copyjob1",
          "type": "CopyJob",
          "id": "9d922047-55a9-4737-8ec0-f34a320100bc"
        },
        {
          "displayName": "copyjob2",
          "type": "CopyJob",
          "id": "8d022047-55a9-4737-8ec0-f34a320100b7"
        }
      ],
      "encryptionStatus": "EnableInProgress"
    }
  ]
}

Määritelmät

Nimi	Kuvaus
EncryptionDetail	Työtilan salaustiedot.
ErrorRelatedResource	Virheeseen liittyvä resurssitieto-objekti.
ErrorResponse	Virhevastaus.
ErrorResponseDetails	Virheen vastauksen tiedot.
WorkspaceEncryptionDetail	Työtilan salausasetukset ja tilan tiedot.
WorkspaceEncryptionItem	Työtilan kohteen tiedot.
WorkspaceEncryptionItemsDetail	Salauksen tilan tiedot työtilan kohteille.
WorkspaceEncryptionStatus	Työtilan salauksen tila.

EncryptionDetail

Kohde

Työtilan salaustiedot.

Nimi	Tyyppi	Kuvaus
encryptionStatus	WorkspaceEncryptionStatus	Työtilan salauksen tila.
keyIdentifier	string	Avaintunniste.

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.

WorkspaceEncryptionDetail

Kohde

Työtilan salausasetukset ja tilan tiedot.

Nimi	Tyyppi	Kuvaus
encryptionDetail	EncryptionDetail	Tämä on työtilan salaustiedot.
previousEncryptionDetail	EncryptionDetail	Työtilan edelliset salaustiedot.
workspaceEncryptionItemsDetails	WorkspaceEncryptionItemsDetail[]	Työtilan kohteiden salauksen tila.

WorkspaceEncryptionItem

Kohde

Työtilan kohteen tiedot.

Nimi	Tyyppi	Kuvaus
displayName	string	Kohteen näyttönimi.
id	string (uuid)	Kohteen tunnus.
type	string	Kohdetyyppi.

WorkspaceEncryptionItemsDetail

Kohde

Salauksen tilan tiedot työtilan kohteille.

Nimi	Tyyppi	Kuvaus
encryptionStatus	WorkspaceEncryptionStatus	Kohteiden salauksen tila.
items	WorkspaceEncryptionItem[]	Työtilanimikkeen tietojen matriisi.

WorkspaceEncryptionStatus

Luettelointi

Työtilan salauksen tila.

Arvo	Kuvaus
Disabled	Työtilan salaus ei ole aktiivinen.
Active	Työtilan salaus on aktiivinen ja työtila salataan.
EnableInProgress	Työtilan salaus on käytössä.
DisableInProgress	Työtilan salaus poistetaan käytöstä.
Failed	Työtilan salaussovellus epäonnistui.