Workspaces - List Workspaces

Tjeneste:: Core

API-versjon:: v1

Returnerer en liste over arbeidsområder som hovedstolen har tilgang til. Bruk rollespørringsparameteren til å filtrere resultater etter rollen som hovedarbeidsområde.
Denne API-en støtter paginering.

Nødvendige delegerte omfang

Workspace.Read.All eller Workspace.ReadWrite.All

Begrensningsgrenser

Grensetype	Verdi
Enhetlig kvote for plattform-API-er	200 samtaler/min
API-grense	200 samtaler/min

Microsoft Entra-støttede identiteter

Denne API-en støtter Microsoft -identiteter oppført i denne delen.

Identitet	Støtte
Bruker	Ja
tjenestekontohaver og administrerte identiteter	Ja

Grensesnitt

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

Med valgfrie parametere:

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

URI-parametere

Navn	I	Type	Beskrivelse
continuationToken	query	string	Et token for å hente neste side med resultater.
preferWorkspaceSpecificEndpoints	query	boolean	En innstilling som styrer om det arbeidsområdespesifikke API-endepunktet skal inkluderes per arbeidsområde. Sann – Inkluder det arbeidsområdespesifikke API-endepunktet False – Ikke inkluder det arbeidsområdespesifikke API-endepunktet.
roles	query	string	En liste over roller. Skill verdier ved hjelp av et komma. Hvis ikke angitt, returneres alle arbeidsområder.

Svar

Navn Type Beskrivelse

200 OK

Navn	Type	Beskrivelse
200 OK	Workspaces	Forespørselen er fullført.
429 Too Many Requests	ErrorResponse	Grensen for tjenestesats ble overskredet. Serveren returnerer en `Retry-After` topptekst som angir, i sekunder, hvor lenge klienten må vente før du sender flere forespørsler. Overskrifter Retry-After: integer
Other Status Codes	ErrorResponse	Vanlige feilkoder: InvalidParameter – ugyldig arbeidsområderolle. UnknownError - Det oppstod en feil.

Workspaces

Forespørselen er fullført.

429 Too Many Requests

ErrorResponse

Grensen for tjenestesats ble overskredet. Serveren returnerer en Retry-After topptekst som angir, i sekunder, hvor lenge klienten må vente før du sender flere forespørsler.

Overskrifter

Retry-After: integer

Other Status Codes

ErrorResponse

Vanlige feilkoder:

InvalidParameter – ugyldig arbeidsområderolle.
UnknownError - Det oppstod en feil.

Eksempler

List workspaces example

List workspaces with continuation example

List workspaces with preferWorkspaceSpecificEndpoints example

List workspaces with roles filter example

List workspaces example

Eksempelforespørsel

HTTP

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

Eksempelsvar

Statuskode:: 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

Eksempelforespørsel

HTTP

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

Eksempelsvar

Statuskode:: 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

Eksempelforespørsel

HTTP

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

Eksempelsvar

Statuskode:: 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

Eksempelforespørsel

HTTP

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

Eksempelsvar

Statuskode:: 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"
    }
  ]
}

Definisjoner

Navn	Beskrivelse
CapacityRegion	Området for kapasiteten som er knyttet til dette arbeidsområdet. Flere kapasitetsområdeverdier kan legges til over tid.
ErrorRelatedResource	Objektet for feilrelaterte ressursdetaljer.
ErrorResponse	Feilsvaret.
ErrorResponseDetails	Feilsvardetaljene.
Workspace	Et arbeidsområdeobjekt.
WorkspaceAppliedTag	Representerer en brukt kode.
Workspaces
WorkspaceType	En arbeidsområdetype. Flere arbeidsområdetyper kan legges til over tid.

CapacityRegion

Opplisting

Området for kapasiteten som er knyttet til dette arbeidsområdet. Flere kapasitetsområdeverdier kan legges til over tid.

Verdi	Beskrivelse
Australia East	Australia Øst-regionen
Australia Southeast	Australia sørøst-regionen
Brazil South	Brasil Sør-regionen
Brazil Southeast	Brasil, sørøst-området
Canada Central	Canada, sentralt område
Canada East	Canada, østområde
Central India	Sentral-India-regionen
Central US	Sentral-USA-område
Central US EUAP	EUAP-område sentralt i USA
East Asia	Øst-Asia-regionen
East US	Øst-USA-område
East US 2	Øst-USA 2-område
France Central	Frankrike, sentralt område
France South	Frankrike, sør
Germany Central	Tyskland, sentralområde
Germany Northeast	Nordøst-regionen i Tyskland
Israel Central	Israel, sentralregion
Italy North	Italia Nord-regionen
Japan East	Japan Øst-regionen
Japan West	Japan, vestområde
Korea Central	Korea, sentralt område
Korea South	Korea Sør-regionen
Mexico Central	Mexico, sentralt område
North Central US	Usa,nord-sentralt-område
North Europe	Nord-Europa-regionen
Norway East	Norges østområde
Norway West	Norge Vest-regionen
Poland Central	Polen, sentralt område
South Africa North	Sør-Afrika Nord-regionen
South Africa West	Sør-Afrika Vest-regionen
South Central US	Usa,sør-sentralt-område
South India	Sør-India-regionen
Southeast Asia	Sørøst-Asia-regionen
Spain Central	Spania, sentralt område
Sweden Central	Sveriges sentrale region
Switzerland North	Sveits, nordområde
Switzerland West	Sveits, vestområde
West Europe	Vest-Europa-regionen
West India	Vest-India-regionen
West US	Usa,vest
West US 2	Vest-USA 2-område
West US 3	Vest-USA 3-område
West Central US	USA-området vest-sentralt
UAE Central	UAE, sentralt område
UAE North	UAE Nord-regionen
Qatar Central	Qatar, sentralregion
Germany West Central	Tyskland, vest, sentralt område
Germany North	Tyskland Nord-regionen
UK South	Storbritannia sør-regionen
UK West	Uk West region
China North	Kina Nord-regionen
China East	Kina øst-regionen
China East 2	Kina Øst 2-regionen
China East 3	Kina Øst 3-regionen
China North 2	Kina Nord 2-regionen
China North 3	Kina Nord 3-regionen

ErrorRelatedResource

Objekt

Objektet for feilrelaterte ressursdetaljer.

Navn	Type	Beskrivelse
resourceId	string	Ressurs-ID-en som er involvert i feilen.
resourceType	string	Typen ressurs som er involvert i feilen.

ErrorResponse

Objekt

Feilsvaret.

Navn	Type	Beskrivelse
errorCode	string	En bestemt identifikator som gir informasjon om en feilbetingelse, noe som gir standardisert kommunikasjon mellom tjenesten og brukerne.
isRetriable	boolean	Når sann, kan forespørselen prøves på nytt. `Retry-After` Bruk svarhodet til å fastslå forsinkelsen, hvis tilgjengelig.
message	string	En menneskelig lesbar representasjon av feilen.
moreDetails	ErrorResponseDetails[]	Liste over flere feildetaljer.
relatedResource	ErrorRelatedResource	Feilrelaterte ressursdetaljer.
requestId	string (uuid)	ID for forespørselen som er knyttet til feilen.

ErrorResponseDetails

Objekt

Feilsvardetaljene.

Navn	Type	Beskrivelse
errorCode	string	En bestemt identifikator som gir informasjon om en feilbetingelse, noe som gir standardisert kommunikasjon mellom tjenesten og brukerne.
message	string	En menneskelig lesbar representasjon av feilen.
relatedResource	ErrorRelatedResource	Feilrelaterte ressursdetaljer.

Workspace

Objekt

Et arbeidsområdeobjekt.

Navn	Type	Beskrivelse
apiEndpoint	string (uri)	HTTP URL-adresse som representerer API-endepunktet som er spesifikt for arbeidsområdet. Denne endepunktverdien returneres når brukeren aktiverer preferWorkspaceSpecificEndpoints. Det gir tilgang til API over private koblinger.
capacityId	string (uuid)	ID-en for kapasiteten arbeidsområdet er tilordnet til.
capacityRegion	CapacityRegion	Området for kapasiteten som er knyttet til dette arbeidsområdet.
description	string	Beskrivelsen av arbeidsområdet.
displayName	string	Visningsnavnet for arbeidsområdet.
domainId	string (uuid)	ID-en for domenet arbeidsområdet er tilordnet til.
id	string (uuid)	Arbeidsområde-ID-en.
tags	WorkspaceAppliedTag[]	Liste over brukte merker.
type	WorkspaceType	Arbeidsområdetypen.

WorkspaceAppliedTag

Objekt

Representerer en brukt kode.

Navn	Type	Beskrivelse
displayName	string	Navnet på koden.
id	string (uuid)	Kode-ID-en.

Workspaces

Objekt

Navn	Type	Beskrivelse
continuationToken	string	Tokenet for den neste resultatsettgruppen. Hvis det ikke er flere poster, fjernes den fra svaret.
continuationUri	string	URI-en for neste satsvise resultatsett. Hvis det ikke er flere poster, fjernes den fra svaret.
value	Workspace[]	En liste over arbeidsområder.

WorkspaceType

Opplisting

En arbeidsområdetype. Flere arbeidsområdetyper kan legges til over tid.

Verdi	Beskrivelse
Personal	Min mappe eller Mitt arbeidsområde brukes til å administrere brukerelementer.
Workspace	Arbeidsområde som brukes til å administrere stoffelementene.
AdminWorkspace	Arbeidsområde for administratorovervåking. Inneholder administratorrapporter som revisjonsrapporten og bruks- og innføringsrapporten.