Workspaces - Get Workspace

Palvelu:: Core

Ohjelmointirajapinnan versio:: v1

Palauttaa määritetyt työtilan tiedot.

Käyttöoikeudet

Kutsujalla on oltava katselijan tai suurempi työtilarooli.

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.

Identiteetti	Tuki
Käyttäjä	Kyllä
palvelun päänimen ja Hallittujen käyttäjätietojen	Kyllä

Rajapinta

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

Valinnaisilla parametreilla:

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

URI-parametrit

Nimi	Kohteessa	Pakollinen	Tyyppi	Kuvaus
workspaceId	path	True	string (uuid)	Työtilan tunnus.
preferWorkspaceSpecificEndpoints	query		boolean	Asetus, joka määrittää, sisällytetäänkö työtilakohtaiset vai yleiset julkiset päätepisteet ohjelmointirajapinnalle ja OneLake-käyttöoikeudelle. True – Sisällytä työtilakohtaiset päätepisteet ohjelmointirajapinnalle ja OneLake-käyttöoikeudelle, epätosi – sisällytä yleiset julkiset päätepisteet OneLake-käyttöoikeutta varten.

Vastaukset

Nimi Tyyppi Kuvaus

200 OK

Nimi	Tyyppi	Kuvaus
200 OK	WorkspaceInfo	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.

WorkspaceInfo

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

Get a workspace example

Get a workspace with preferWorkspaceSpecificEndpoints example

Get a workspace example

Mallipyyntö

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff227

Mallivastaus

Tilakoodi:: 200

{
  "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff227",
  "displayName": "New workspace",
  "description": "New workspace description",
  "type": "Workspace",
  "domainId": "9ce364e0-8e9d-4605-887a-b599b3e8b123",
  "capacityId": "56bac802-080d-4f73-8a42-1b406eb1fcac",
  "capacityAssignmentProgress": "Completed",
  "workspaceIdentity": {
    "applicationId": "00a4a8f9-78d3-41b3-b87a-6ae5271c8d0d",
    "servicePrincipalId": "5ba4ae58-d402-45c6-a848-0253e834fd78"
  },
  "capacityRegion": "East US",
  "oneLakeEndpoints": {
    "blobEndpoint": "https://eastus-onelake.blob.fabric.microsoft.com",
    "dfsEndpoint": "https://eastus-onelake.dfs.fabric.microsoft.com"
  },
  "tags": [
    {
      "id": "b3f2c8e9-4d8e-4a7c-9a32-f8c1b2e4d6af",
      "displayName": "Finance"
    }
  ]
}

Get a workspace with preferWorkspaceSpecificEndpoints example

Mallipyyntö

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff227?preferWorkspaceSpecificEndpoints=True

Mallivastaus

Tilakoodi:: 200

{
  "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff227",
  "displayName": "New workspace",
  "description": "New workspace description",
  "type": "Workspace",
  "capacityId": "56bac802-080d-4f73-8a42-1b406eb1fcac",
  "capacityAssignmentProgress": "Completed",
  "workspaceIdentity": {
    "applicationId": "00a4a8f9-78d3-41b3-b87a-6ae5271c8d0d",
    "servicePrincipalId": "5ba4ae58-d402-45c6-a848-0253e834fd78"
  },
  "capacityRegion": "East US",
  "oneLakeEndpoints": {
    "blobEndpoint": "https://cfafbeb180374d0c896ea46fb27ff227.zcf.blob.fabric.microsoft.com",
    "dfsEndpoint": "https://cfafbeb180374d0c896ea46fb27ff227.zcf.dfs.fabric.microsoft.com"
  },
  "apiEndpoint": "https://cfafbeb180374d0c896ea46fb27ff227.zcf.w.api.fabric.microsoft.com"
}

Määritelmät

Nimi	Kuvaus
CapacityAssignmentProgress	Työtilan määritys kapasiteetin edistymisen tilaan. Kapasiteetin määrityksen edistymisen lisäarvoja voidaan lisätä ajan kuluessa.
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.
OneLakeEndpoints	Tähän työtilaan liittyvät OneLake-ohjelmointirajapinnan päätepisteet.
WorkspaceAppliedTag	Edustaa käytössä olevaa tunnistetta.
WorkspaceIdentity	Työtilan käyttäjätieto-objekti.
WorkspaceInfo	Työtilan objekti.
WorkspaceType	Työtilatyyppi. Lisää työtilatyyppejä voidaan lisätä ajan kuluessa.

CapacityAssignmentProgress

Luettelointi

Työtilan määritys kapasiteetin edistymisen tilaan. Kapasiteetin määrityksen edistymisen lisäarvoja voidaan lisätä ajan kuluessa.

Arvo	Kuvaus
Completed	Viimeisin kapasiteetin määritystoiminto suoritettiin onnistuneesti.
Failed	Kapasiteetin määritystoiminnossa on ilmennyt virhe tai virhe, eikä sitä voitu suorittaa.
InProgress	Kapasiteetin määrityksen toiminto on parhaillaan käynnissä, eikä sitä ole vielä suoritettu.

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.

OneLakeEndpoints

Kohde

Tähän työtilaan liittyvät OneLake-ohjelmointirajapinnan päätepisteet.

Nimi	Tyyppi	Kuvaus
blobEndpoint	string	Blob-ohjelmointirajapinnan toiminnoille käytettävissä oleva OneLake-ohjelmointirajapinnan päätepiste. Tämä on oletusarvoisesti aluekohtainen päätepiste. Jos käyttäjä ottaa käyttöön mieluumminWorkspaceSpecificEndpoints-kohteen tai jos työtilan julkinen käyttöoikeus on poistettu käytöstä, työtilakohtainen päätepiste on annettu, jotta se voi käyttää yksityisiä linkkejä.
dfsEndpoint	string	OneLake-ohjelmointirajapinnan päätepiste, joka on käytettävissä Distributed File System (DFS) - tai ADLSgen2-tiedostojärjestelmän API-toiminnoille. Tämä on oletusarvoisesti aluekohtainen päätepiste. Jos käyttäjä ottaa käyttöön mieluumminWorkspaceSpecificEndpoints-kohteen tai jos työtilan julkinen käyttöoikeus on poistettu käytöstä, työtilakohtainen päätepiste on annettu, jotta se voi käyttää yksityisiä linkkejä.

WorkspaceAppliedTag

Kohde

Edustaa käytössä olevaa tunnistetta.

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

WorkspaceIdentity

Kohde

Työtilan käyttäjätieto-objekti.

Nimi	Tyyppi	Kuvaus
applicationId	string (uuid)	Sovellustunnus.
servicePrincipalId	string (uuid)	Palvelun päänimen tunnus.

WorkspaceInfo

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.
capacityAssignmentProgress	CapacityAssignmentProgress	Työtilan kapasiteetin määrittämisen edistymisen tila.
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.
oneLakeEndpoints	OneLakeEndpoints	Tähän työtilaan liittyvät OneLake-ohjelmointirajapinnan päätepisteet.
tags	WorkspaceAppliedTag[]	Luettelo käytössä olevista tunnisteista.
type	WorkspaceType	Työtilan tyyppi.
workspaceIdentity	WorkspaceIdentity	Työtilan käyttäjätiedot.

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.