Workspaces - List Workspaces

Palvelu:: Admin

Ohjelmointirajapinnan versio:: v1

Palauttaa työtilojen luettelon.
Tämä ohjelmointirajapinta tukee sivutuksen. Enintään 10 000 tietuetta voidaan palauttaa pyyntöä kohden. Vastauksessa olevan jatkumistunnuksen avulla voit noutaa seuraavat 10 000 tietuetta.

Permissions

Soittajan on oltava Fabric-järjestelmänvalvoja tai todennettava palvelun päänimen avulla.

Vaaditut delegoidut vaikutusalueet

Tenant.Read.All tai Tenant.ReadWrite.All

Limitations

Enintään 200 pyyntöä tuntia kohti.

encryptionStatus Suodatinta käytetään vain, include kun parametri sisältää kohteen encryption.

Microsoft Entran tukemat käyttäjätiedot

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

Identity	Support
User	Yes
palvelun päänimen ja Hallittujen käyttäjätietojen	Yes

Interface

GET https://api.fabric.microsoft.com/v1/admin/workspaces

Valinnaisilla parametreilla:

GET https://api.fabric.microsoft.com/v1/admin/workspaces?type={type}&capacityId={capacityId}&name={name}&state={state}&continuationToken={continuationToken}&encryptionStatus={encryptionStatus}&include={include}

URI-parametrit

Nimi	Kohteessa	Tyyppi	Kuvaus
capacityId	query	string (uuid)	Tämä on työtilan kapasiteetin tunnus.
continuationToken	query	string	Jatkumistunnus. Käytetään luettelon seuraavien kohteiden noutamiseen.
encryptionStatus	query	string	Ilmaisee työtilan CMK-salauksen tilan, ja sen avulla suodatetaan määritettyä tilaa vastaavat työtilat.
include	query	string	Määrittää lisätiedot, jotka sisällytetään vastaukseen kuhunkin työtilaan. Tuetut arvot: `encryption`.
name	query	string	Työtilan nimi.
state	query	string	Tämä on työtilan tila. Tuetut tilat ovat aktiivisia ja poistetaan.
type	query	string	Työtilan tyyppi. Tuettuja tyyppejä ovat henkilökohtainen, työtila, järjestelmänvalvojatyötila.

Vastaukset

Nimi Tyyppi Kuvaus

200 OK

Nimi	Tyyppi	Kuvaus
200 OK	Workspaces	Toiminto onnistui.
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: BadRequest – Kyselyparametrit, kuten `workspaceType` tai `workspaceState` , eivät ole kelvollisia. InsufficientPrivileges – Soittajalla ei ole oikeutta kutsua ohjelmointirajapintaa.

Workspaces

Toiminto onnistui.

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:

BadRequest – Kyselyparametrit, kuten workspaceType tai workspaceState , eivät ole kelvollisia.
InsufficientPrivileges – Soittajalla ei ole oikeutta kutsua ohjelmointirajapintaa.

Esimerkit

Get a list of workspaces example

Get a list of workspaces using state query parameter example

List workspaces for a given capacity, ignoring the encryptionStatus filter.

List workspaces with active encryption status in a given capacity

List workspaces with encryption details

Get a list of workspaces example

Mallipyyntö

HTTP

GET https://api.fabric.microsoft.com/v1/admin/workspaces

Mallivastaus

Tilakoodi:: 200

{
  "workspaces": [
    {
      "id": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
      "name": "test report",
      "type": "Workspace",
      "state": "Active",
      "capacityId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e84",
      "domainId": "039bd896-b39c-4540-93e3-e9926de135f9",
      "tags": [
        {
          "id": "b3f2c8e9-4d8e-4a7c-9a32-f8c1b2e4d6af",
          "displayName": "Finance"
        },
        {
          "id": "6f1a8d3b-92c4-4f67-8c2d-1e5a9b7f4a23",
          "displayName": "Production"
        }
      ]
    }
  ],
  "continuationUri": "https://api.fabric.microsoft.com/v1/admin/workspaces?continuationToken='LDEsMTAwMDAwLDA%3D'",
  "continuationToken": "LDEsMTAwMDAwLDA%3D"
}

Get a list of workspaces using state query parameter example

Mallipyyntö

HTTP

GET https://api.fabric.microsoft.com/v1/admin/workspaces?state=Active

Mallivastaus

Tilakoodi:: 200

{
  "workspaces": [
    {
      "id": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
      "name": "test report",
      "type": "Workspace",
      "state": "Active",
      "capacityId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e84"
    }
  ],
  "continuationUri": null,
  "continuationToken": null
}

List workspaces for a given capacity, ignoring the encryptionStatus filter.

Mallipyyntö

HTTP

GET https://api.fabric.microsoft.com/v1/admin/workspaces?capacityId=61d6811f-7544-4e75-a1e6-1c59c0383312&encryptionStatus=Active

Mallivastaus

Tilakoodi:: 200

{
  "workspaces": [
    {
      "id": "abf49964-6f70-4aea-a66c-4b78a22e3ddc",
      "name": "Contoso Workspace 1",
      "type": "Workspace",
      "state": "Active",
      "capacityId": "61d6811f-7544-4e75-a1e6-1c59c0383312",
      "domainId": "039bd896-b39c-4540-93e3-e9926de135f9"
    },
    {
      "id": "90119767-07b4-4657-82ee-53e90fece225",
      "name": "Contoso Workspace 3",
      "type": "Workspace",
      "state": "Active",
      "capacityId": "61d6811f-7544-4e75-a1e6-1c59c0383312",
      "domainId": "039bd896-b39c-4540-93e3-e9926de135f9"
    }
  ],
  "continuationUri": "https://api.fabric.microsoft.com/v1/admin/workspaces?continuationToken='LDEsMTAwMDAwLDA%3D'",
  "continuationToken": "LDEsMTAwMDAwLDA%3D"
}

List workspaces with active encryption status in a given capacity

Mallipyyntö

HTTP

GET https://api.fabric.microsoft.com/v1/admin/workspaces?capacityId=61d6811f-7544-4e75-a1e6-1c59c0383312&encryptionStatus=Active&include=encryption

Mallivastaus

Tilakoodi:: 200

{
  "workspaces": [
    {
      "id": "90119767-07b4-4657-82ee-53e90fece225",
      "name": "Contoso Workspace 3",
      "type": "Workspace",
      "state": "Active",
      "capacityId": "61d6811f-7544-4e75-a1e6-1c59c0383312",
      "domainId": "039bd896-b39c-4540-93e3-e9926de135f9",
      "encryption": {
        "status": "Active",
        "keyIdentifier": "https://westus07112025-cmktest1.vault.azure.net/keys/test2k/"
      }
    }
  ],
  "continuationUri": "https://api.fabric.microsoft.com/v1/admin/workspaces?continuationToken='LDEsMTAwMDAwLDA%3D'",
  "continuationToken": "LDEsMTAwMDAwLDA%3D"
}

List workspaces with encryption details

Mallipyyntö

HTTP

GET https://api.fabric.microsoft.com/v1/admin/workspaces?encryptionStatus={encryptionStatus}&include=encryption

Mallivastaus

Tilakoodi:: 200

{
  "workspaces": [
    {
      "id": "abf49964-6f70-4aea-a66c-4b78a22e3ddc",
      "name": "Contoso Workspace 1",
      "type": "Workspace",
      "state": "Active",
      "capacityId": "61d6811f-7544-4e75-a1e6-1c59c0383312",
      "domainId": "039bd896-b39c-4540-93e3-e9926de135f9",
      "encryption": {
        "status": "Disabled"
      }
    },
    {
      "id": "9c7f06cc-e850-4961-b2bd-181a70b1a784",
      "name": "Contoso Workspace 2",
      "type": "Workspace",
      "state": "Active",
      "capacityId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e84",
      "domainId": "039bd896-b39c-4540-93e3-e9926de135f9",
      "encryption": {
        "status": "Disabled"
      }
    },
    {
      "id": "90119767-07b4-4657-82ee-53e90fece225",
      "name": "Contoso Workspace 3",
      "type": "Workspace",
      "state": "Active",
      "capacityId": "61d6811f-7544-4e75-a1e6-1c59c0383312",
      "domainId": "039bd896-b39c-4540-93e3-e9926de135f9",
      "encryption": {
        "status": "Active",
        "keyIdentifier": "https://westus07112025-cmktest1.vault.azure.net/keys/test2k/"
      }
    },
    {
      "id": "adaa3051-b1de-41ed-b1b4-d5e08887c1e9",
      "name": "Contoso Workspace 4",
      "type": "Workspace",
      "state": "Active",
      "capacityId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e84",
      "domainId": "039bd896-b39c-4540-93e3-e9926de135f9",
      "encryption": {
        "status": "EnableInProgress",
        "keyIdentifier": "https://westus07112025-cmktest1.vault.azure.net/keys/test2k/",
        "previousStatus": "Active",
        "previousKeyIdentifier": "https://westus07112025-cmktest1.vault.azure.net/keys/test4k/"
      }
    }
  ],
  "continuationUri": "https://api.fabric.microsoft.com/v1/admin/workspaces?continuationToken='LDEsMTAwMDAwLDA%3D'",
  "continuationToken": "LDEsMTAwMDAwLDA%3D"
}

Määritelmät

Nimi	Kuvaus
Encryption	Työtilan salaustiedot käyttämällä asiakkaan hallitsemaa avainta (CMK).
ErrorRelatedResource	Virheeseen liittyvä resurssitieto-objekti.
ErrorResponse	Virhevastaus.
ErrorResponseDetails	Virheen vastauksen tiedot.
Workspace	Workspace.
WorkspaceAppliedTag	Edustaa käytössä olevaa tunnistetta.
WorkspaceEncryptionStatus	Työtilan CMK-salauksen tila.
Workspaces	Luettelo työtiloista.
WorkspaceState	Tämä on työtilan tila. Lisää työtilan tiloja voidaan lisätä ajan mittaan.
WorkspaceType	Työtilatyyppi. Lisää työtilatyyppejä voidaan lisätä ajan kuluessa.

Encryption

Kohde

Työtilan salaustiedot käyttämällä asiakkaan hallitsemaa avainta (CMK).

Nimi	Tyyppi	Kuvaus
keyIdentifier	string	Salausavaimen tunniste.
previousKeyIdentifier	string	Edellinen salausavaimen tunniste.
previousStatus	WorkspaceEncryptionStatus	Tämä on työtilan aiempi CMK-salauksen tila.
status	WorkspaceEncryptionStatus	Työtilan CMK-salauksen tila.

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.

Workspace

Kohde

Workspace.

Nimi	Tyyppi	Kuvaus
capacityId	string (uuid)	Tämä on työtilan kapasiteetin tunnus.
domainId	string (uuid)	Työtilan toimialuetunnus.
encryption	Encryption	Työtilan salaustiedot.
id	string (uuid)	Työtilan tunnus.
name	string	Työtilan nimi.
state	WorkspaceState	Tämä on työtilan tila.
tags	WorkspaceAppliedTag[]	Luettelo käytössä olevista tunnisteista.
type	WorkspaceType	Työtilan tyyppi.

WorkspaceAppliedTag

Kohde

Edustaa käytössä olevaa tunnistetta.

Nimi	Tyyppi	Kuvaus
displayName	string	Tunnisteen nimi.
id	string (uuid)	Tunnisteen tunnus.

WorkspaceEncryptionStatus

Luettelointi

Työtilan CMK-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.

Workspaces

Kohde

Luettelo työtiloista.

Nimi	Tyyppi	Kuvaus
continuationToken	string	Seuraavan tulosjoukkoerän tunnus. Jos tietueita ei ole enempää, ne poistetaan vastauksesta.
continuationUri	string	Seuraavan tulosjoukkoerän URI. Jos tietueita ei ole enempää, ne poistetaan vastauksesta.
workspaces	Workspace[]	Luettelo kangastyötiloista.

WorkspaceState

Luettelointi

Tämä on työtilan tila. Lisää työtilan tiloja voidaan lisätä ajan mittaan.

Arvo	Kuvaus
Active	Työtila on aktiivinen. Orpotyötilat näytetään aktiivisina.
Deleted	Työtila poistetaan.

WorkspaceType

Luettelointi

Työtilatyyppi. Lisää työtilatyyppejä voidaan lisätä ajan kuluessa.

Arvo	Kuvaus
Personal	Oma kansio tai Oma työtila, jota käytetään käyttäjäkohteiden hallintaan.
Workspace	Fabric-kohteiden hallintaan käytetty työtila.
AdminWorkspace	Järjestelmänvalvojan valvontatyötila. Sisältää järjestelmänvalvojan raportit, kuten valvontaraportin sekä käyttö- ja käyttöönottoraportin.