Workspaces - List Workspaces

Palvelu:: Core

Ohjelmointirajapinnan versio:: v1

Palauttaa luettelon työtiloista, joita päänimi voi käyttää. Roolikyselyparametrin avulla voit suodattaa tulokset työtilan pääroolin mukaan.
Tämä ohjelmointirajapinta tukee sivutuksen.

Vaaditut delegoidut vaikutusalueet

Workspace.Read.All tai Workspace.ReadWrite.All

Rajoitinrajoitukset

Rajoitustyyppi	Arvo
Käyttöympäristön ohjelmointirajapintojen yhdistetty kiintiö	200 puhelua/min
Ohjelmointirajapinnan raja	200 puhelua/min

Microsoft Entran tukemat käyttäjätiedot

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

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

Interface

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

Valinnaisilla parametreilla:

GET https://api.fabric.microsoft.com/v1/workspaces?roles={roles}&continuationToken={continuationToken}&preferWorkspaceSpecificEndpoints={preferWorkspaceSpecificEndpoints}

URI-parametrit

Nimi	Kohteessa	Tyyppi	Kuvaus
continuationToken	query	string	Tunnus seuraavan tulossivun noutamiseen.
preferWorkspaceSpecificEndpoints	query	boolean	Asetus, joka määrittää, sisällytetäänkö työtilakohtainen ohjelmointirajapinnan päätepiste kullekin työtilalle. True – Sisällytä työtilakohtainen ohjelmointirajapinnan päätepiste, False – Älä sisällytä työtilaan kohtaista ohjelmointirajapinnan päätepistettä.
roles	query	string	Roolien luettelo. Erota arvot käyttämällä pilkkua. Jos tätä ei anneta, kaikki työtilat palautetaan.

Vastaukset

Nimi Tyyppi Kuvaus

200 OK

Nimi	Tyyppi	Kuvaus
200 OK	Workspaces	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: InvalidParameter – Työtilan rooli on virheellinen. UnknownError – Ilmeni virhe.

Workspaces

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:

InvalidParameter – Työtilan rooli on virheellinen.
UnknownError – Ilmeni virhe.

Esimerkit

List workspaces example

List workspaces with continuation example

List workspaces with preferWorkspaceSpecificEndpoints example

List workspaces with roles filter example

List workspaces example

Mallipyyntö

HTTP

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

Mallivastaus

Tilakoodi:: 200

{
  "value": [
    {
      "id": "fa9ad228-3e6b-44d4-b5f4-e275f337afa9",
      "displayName": "My workspace",
      "description": "",
      "type": "Personal"
    },
    {
      "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff227",
      "displayName": "Marketing",
      "description": "A  workspace used by the marketing team",
      "type": "Workspace",
      "tags": [
        {
          "id": "b3f2c8e9-4d8e-4a7c-9a32-f8c1b2e4d6af",
          "displayName": "Marketing"
        }
      ]
    },
    {
      "id": "f2d70dc6-8f3e-4f2c-b00e-e2d336d7d711",
      "displayName": "Finance",
      "description": "A workspace used by the finance team",
      "type": "Workspace",
      "capacityId": "171018af-1531-4e61-942a-74f024b7f9fd",
      "domainId": "7c889f28-999b-4945-840d-54da3e3b5a29",
      "capacityRegion": "East US",
      "tags": [
        {
          "id": "9b8c7d6e-5f4a-3b2c-1d0e-9f8a7b6c5d4e",
          "displayName": "Finance"
        },
        {
          "id": "b3f2c8e9-4d8e-4a7c-9a32-f8c1b2e4d6af",
          "displayName": "Marketing"
        }
      ]
    }
  ]
}

List workspaces with continuation example

Mallipyyntö

HTTP

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

Mallivastaus

Tilakoodi:: 200

{
  "value": [
    {
      "id": "fa9ad228-3e6b-44d4-b5f4-e275f337afa9",
      "displayName": "My workspace",
      "description": "",
      "type": "Personal"
    },
    {
      "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff227",
      "displayName": "Marketing",
      "description": "A  workspace used by the marketing team",
      "type": "Workspace"
    },
    {
      "id": "f2d70dc6-8f3e-4f2c-b00e-e2d336d7d711",
      "displayName": "Finance",
      "description": "A workspace used by the finance team",
      "type": "Workspace",
      "capacityId": "171018af-1531-4e61-942a-74f024b7f9fd",
      "capacityRegion": "East US"
    }
  ],
  "continuationToken": "LDEsMTAwMDAwLDA%3D",
  "continuationUri": "https://api.fabric.microsoft.com/v1/workspaces?continuationToken=LDEsMTAwMDAwLDA%3D"
}

List workspaces with preferWorkspaceSpecificEndpoints example

Mallipyyntö

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces?preferWorkspaceSpecificEndpoints=True

Mallivastaus

Tilakoodi:: 200

{
  "value": [
    {
      "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff227",
      "displayName": "Alice's Workspace",
      "description": "A workspace for Alice",
      "type": "Workspace",
      "apiEndpoint": "https://cfafbeb180374d0c896ea46fb27ff227.zcf.w.api.fabric.microsoft.com"
    },
    {
      "id": "0c02a0cd-71bc-410f-aa05-5a7bc98765f7",
      "displayName": "Bob's Workspace",
      "description": "A workspace for Bob",
      "type": "Workspace",
      "apiEndpoint": "https://0c02a0cd71bc410faa055a7bc98765f7.z0c.w.api.fabric.microsoft.com"
    }
  ]
}

List workspaces with roles filter example

Mallipyyntö

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces?roles=Admin,Member,Contributor,Viewer

Mallivastaus

Tilakoodi:: 200

{
  "value": [
    {
      "id": "fa9ad228-3e6b-44d4-b5f4-e275f337afa9",
      "displayName": "Admins workspace",
      "description": "A workspace for admins",
      "type": "Personal"
    },
    {
      "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff227",
      "displayName": "Members workspace",
      "description": "A workspace for members",
      "type": "Workspace"
    },
    {
      "id": "0c02a0cd-71bc-410f-aa05-5a7bc98765f7",
      "displayName": "Contributors workspace",
      "description": "A workspace for contributors",
      "type": "Workspace"
    },
    {
      "id": "99d58687-8903-4dbd-8a78-40f95dca7177",
      "displayName": "Viewers workspace",
      "description": "A workspace for viewers",
      "type": "Workspace"
    }
  ]
}

Määritelmät

Nimi	Kuvaus
CapacityRegion	Tähän työtilaan liittyvän kapasiteetin alue. Lisää kapasiteettialueen arvoja voidaan lisätä ajan mittaan.
ErrorRelatedResource	Virheeseen liittyvä resurssitieto-objekti.
ErrorResponse	Virhevastaus.
ErrorResponseDetails	Virheen vastauksen tiedot.
Workspace	Työtilan objekti.
WorkspaceAppliedTag	Edustaa käytössä olevaa tunnistetta.
Workspaces
WorkspaceType	Työtilatyyppi. Lisää työtilatyyppejä voidaan lisätä ajan kuluessa.

CapacityRegion

Luettelointi

Tähän työtilaan liittyvän kapasiteetin alue. Lisää kapasiteettialueen arvoja voidaan lisätä ajan mittaan.

Arvo	Kuvaus
Australia East	Australia, itäinen alue
Australia Southeast	Kaakkois-Australia
Brazil South	Brasilian eteläinen alue
Brazil Southeast	Kaakkois-Brasilia
Canada Central	Kanada, keskinen alue
Canada East	Kanada, itäinen alue
Central India	Keski-Intian alue
Central US	Keski-Yhdysvaltain alue
Central US EUAP	Yhdysvaltojen keskinen EUAP-alue
East Asia	Itä-Aasian alue
East US	Itä-Yhdysvaltain alue
East US 2	Itä-Yhdysvallat 2 -alue
France Central	Ranska, keskinen alue
France South	Ranska, eteläinen alue
Germany Central	Saksa, keskinen alue
Germany Northeast	Saksa, koillisalue
Israel Central	Israelin keskiosa
Italy North	Italia, pohjoinen alue
Japan East	Japani, itäinen alue
Japan West	Japani, läntinen alue
Korea Central	Korea, keskinen alue
Korea South	Korea, eteläinen alue
Mexico Central	Meksikon keskiosa
North Central US	Yhdysvaltojen pohjoinen keskiosa
North Europe	Pohjois-Euroopan alue
Norway East	Norja, itäinen alue
Norway West	Norja, läntinen alue
Poland Central	Puolan keskinen alue
South Africa North	Etelä-Afrikka Pohjoinen alue
South Africa West	Etelä-Afrikka Läntinen alue
South Central US	Yhdysvaltojen eteläinen keskiosa
South India	Etelä-Intian alue
Southeast Asia	Kaakkois-Aasian alue
Spain Central	Espanja, keskinen alue
Sweden Central	Ruotsi, keskinen alue
Switzerland North	Sveitsi, pohjoinen alue
Switzerland West	Sveitsi, läntinen alue
West Europe	Länsi-Euroopan alue
West India	Länsi-Intian alue
West US	Länsi-Yhdysvaltain alue
West US 2	Länsi-Yhdysvallat 2 -alue
West US 3	Länsi-Yhdysvallat 3 -alue
West Central US	Läntinen keskiosa, Yhdysvallat, alue
UAE Central	UAE Central region
UAE North	Pohjoinen UAE-alue
Qatar Central	Qatarin keskiosa
Germany West Central	Saksa, läntinen keskinen alue
Germany North	Saksa, pohjoinen alue
UK South	Yhdistynyt kuningaskunta, eteläinen alue
UK West	Yhdistynyt kuningaskunta, läntinen alue
China North	Kiina, pohjoinen alue
China East	Kiina, itäinen alue
China East 2	Kiina, itäinen 2 alue
China East 3	Kiina, itäinen 3-alue
China North 2	Kiina, Pohjoinen 2 -alue
China North 3	Kiina, Pohjoinen 3 -alue

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

Työtilan objekti.

Nimi	Tyyppi	Kuvaus
apiEndpoint	string (uri)	HTTP-URL-osoite, joka edustaa työtilalle määritettyä ohjelmointirajapinnan päätepistettä. Tämä päätepistearvo palautetaan, kun käyttäjä ottaa käyttöön preferWorkspaceSpecificEndpoints-asetuksen. Se mahdollistaa ohjelmointirajapinnan käytön yksityisten linkkien kautta.
capacityId	string (uuid)	Sen kapasiteetin tunnus, jolle työtila on määritetty.
capacityRegion	CapacityRegion	Tähän työtilaan liittyvän kapasiteetin alue.
description	string	Työtilan kuvaus.
displayName	string	Työtilan näyttönimi.
domainId	string (uuid)	Sen toimialueen tunnus, jolle työtila on määritetty.
id	string (uuid)	Työtilan tunnus.
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.

Workspaces

Kohde

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.
value	Workspace[]	Luettelo työtiloista.

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.