Workspaces - List Workspaces

Palvelu:

Admin

Ohjelmointirajapinnan versio:

v1

Palauttaa työtilojen luettelon.

Note

Tämä ohjelmointirajapinta on osa esikatseluversiota, ja se on saatavilla vain arviointi- ja kehitystarkoituksiin. Muutos saattaa perustua palautteeseen, eikä sitä suositella tuotantokäyttöön.

Tämä ohjelmointirajapinta tukee sivutuksen. Enintään 10 000 tietuetta voidaan palauttaa pyyntöä kohden. Vastauksessa olevan jatkuvan tunnuksen avulla voit saada 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.

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}

URI-parametrit

Nimi	Kohteessa	Pakollinen	Tyyppi	Description
capacityId	query		string (uuid)	Tämä on työtilan kapasiteetin tunnus.
continuationToken	query		string	Jatkumistunnus. Käytetään luettelon seuraavien kohteiden noutamiseen.
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	Description
200 OK	Workspaces	Toiminto onnistui.
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

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"
    }
  ],
  "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
}

Määritelmät

Nimi	Description
ErrorRelatedResource	Virheeseen liittyvä resurssitieto-objekti.
ErrorResponse	Virhevastaus.
ErrorResponseDetails	Virheen vastauksen tiedot.
Workspace	Workspace.
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.

ErrorRelatedResource

Object

Virheeseen liittyvä resurssitieto-objekti.

Nimi	Tyyppi	Description
resourceId	string	Virheestä liittyvä resurssitunnus.
resourceType	string	Virheestä liittyvän resurssin tyyppi.

ErrorResponse

Object

Virhevastaus.

Nimi	Tyyppi	Description
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ä.
moreDetails	ErrorResponseDetails[]	Luettelo virheiden lisätiedoista.
relatedResource	ErrorRelatedResource	Virheisiin liittyvät resurssitiedot.
requestId	string	Virheeseen liittyvän pyynnön tunnus.

ErrorResponseDetails

Object

Virheen vastauksen tiedot.

Nimi	Tyyppi	Description
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

Object

Workspace.

Nimi	Tyyppi	Description
capacityId	string (uuid)	Tämä on työtilan kapasiteetin tunnus.
domainId	string (uuid)	Työtilan toimialuetunnus.
id	string (uuid)	Työtilan tunnus.
name	string	Työtilan nimi.
state	WorkspaceState	Tämä on työtilan tila.
type	WorkspaceType	Työtilan tyyppi.

Workspaces

Object

Luettelo työtiloista.

Nimi	Tyyppi	Description
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	Description
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	Description
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.