Workspaces - List Workspaces

Tjeneste:: Core

API-version:: v1

Returnerer en liste over arbejdsområder, som hovedprincipalen kan få adgang til. Brug forespørgselsparameteren roller til at filtrere resultater efter rollen som hovedarbejdsområde.
Denne API understøtter sideinddeling.

Påkrævede delegerede områder

Workspace.Read.All eller Workspace.ReadWrite.All

Microsoft Entra-understøttede identiteter

Denne API understøtter de Microsoft -identiteter, der angivet i dette afsnit.

Identitet	Støtte
Bruger	Ja
tjenesteprincipal og administrerede identiteter	Ja

Grænseflade

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

Med valgfrie parametre:

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

URI-parametre

Name	I	Type	Beskrivelse
continuationToken	query	string	Et token til hentning af den næste side med resultater.
preferWorkspaceSpecificEndpoints	query	boolean	En indstilling, der styrer, om det arbejdsområdespecifikke API-slutpunkt skal medtages pr. arbejdsområde. True – Medtag det arbejdsområdespecifikke API-slutpunkt, False – Medtag ikke det arbejdsområdespecifikke API-slutpunkt.
roles	query	string	En liste over roller. Adskil værdier ved hjælp af et komma. Hvis ikke angivet, returneres alle arbejdsområder.

Svar

Name Type Beskrivelse

200 OK

Name	Type	Beskrivelse
200 OK	Workspaces	Anmodningen blev fuldført.
429 Too Many Requests	ErrorResponse	Grænsen for tjenestetakst blev overskredet. Serveren returnerer en `Retry-After` header, der angiver, i sekunder, hvor længe klienten skal vente, før der sendes yderligere anmodninger. Headere Retry-After: integer
Other Status Codes	ErrorResponse	Almindelige fejlkoder: InvalidParameter – Ugyldig rolle i arbejdsområdet. UnknownError – Der opstod en fejl.

Workspaces

Anmodningen blev fuldført.

429 Too Many Requests

ErrorResponse

Grænsen for tjenestetakst blev overskredet. Serveren returnerer en Retry-After header, der angiver, i sekunder, hvor længe klienten skal vente, før der sendes yderligere anmodninger.

Headere

Retry-After: integer

Other Status Codes

ErrorResponse

Almindelige fejlkoder:

InvalidParameter – Ugyldig rolle i arbejdsområdet.
UnknownError – Der opstod en fejl.

Eksempler

List workspaces example

List workspaces with continuation example

List workspaces with preferWorkspaceSpecificEndpoints example

List workspaces with roles filter example

List workspaces example

Eksempelanmodning

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

Eksempelanmodning

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

Eksempelanmodning

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

Eksempelanmodning

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

Definitioner

Name	Beskrivelse
CapacityRegion	Området for den kapacitet, der er knyttet til dette arbejdsområde. Der kan tilføjes yderligere værdier for kapacitetsområde over tid.
ErrorRelatedResource	Objektet med fejlrelaterede ressourceoplysninger.
ErrorResponse	Fejlsvaret.
ErrorResponseDetails	Oplysninger om fejlsvar.
Workspace	Et arbejdsområdeobjekt.
WorkspaceAppliedTag	Repræsenterer en anvendt kode.
Workspaces
WorkspaceType	En arbejdsområdetype. Der kan tilføjes flere typer arbejdsområder over tid.

CapacityRegion

Optælling

Området for den kapacitet, der er knyttet til dette arbejdsområde. Der kan tilføjes yderligere værdier for kapacitetsområde over tid.

Værdi	Beskrivelse
Australia East	Det østlige Australien
Australia Southeast	Det sydøstlige Australien
Brazil South	Det sydlige Brasilien
Brazil Southeast	Det sydøstlige Brasilien
Canada Central	Det centrale Canada-område
Canada East	Det østlige Canada-område
Central India	Området Centralindien
Central US	Det centrale USA-område
Central US EUAP	Det centrale US EUAP-område
East Asia	Området Østasien
East US	Område i det østlige USA
East US 2	Det østlige USA 2-område
France Central	Det centrale Frankrig
France South	Det sydlige Frankrig
Germany Central	Det centrale Tyskland
Germany Northeast	Det nordøstlige Tyskland
Israel Central	Det centrale Israel-område
Italy North	Norditalien
Japan East	Det østlige Japan-område
Japan West	Det vestlige Japan-område
Korea Central	Det centrale Korea
Korea South	Sydkoreas område
Mexico Central	Det centrale Mexico-område
North Central US	Det nordcentrale USA-område
North Europe	North Europe-området
Norway East	Det østlige Norge
Norway West	Det vestlige Norge-område
Poland Central	Det centrale Polen
South Africa North	Nordafrika
South Africa West	Det vestlige Afrika
South Central US	Det sydcentrale USA-område
South India	Det sydindiske område
Southeast Asia	Det sydøstlige Asien
Spain Central	Det centrale Spanien
Sweden Central	Det centrale Sverige
Switzerland North	Det nordlige Schweiz
Switzerland West	Det vestlige Schweiz
West Europe	Område i Det vestlige Europa
West India	Området Vestindien
West US	Det vestlige USA-område
West US 2	Det vestlige USA 2-område
West US 3	Det vestlige USA 3-område
West Central US	Det vestlige centrale USA-område
UAE Central	Det centrale UAE-område
UAE North	Nordområde for De Forenede Arabiske Emirater
Qatar Central	Det centrale Qatar-område
Germany West Central	Det vestlige centrale Tyskland
Germany North	Det nordlige Tyskland
UK South	Det sydlige Storbritannien
UK West	Det vestlige Storbritannien
China North	Det nordlige Kina
China East	Det østlige Kina
China East 2	Det østlige Kina 2-område
China East 3	Det østlige Kina 3-område
China North 2	Det nordlige Kina 2-område
China North 3	Det nordlige Kina 3-område

ErrorRelatedResource

Objekt

Objektet med fejlrelaterede ressourceoplysninger.

Name	Type	Beskrivelse
resourceId	string	Det ressource-id, der er involveret i fejlen.
resourceType	string	Typen af ressource, der er involveret i fejlen.

ErrorResponse

Objekt

Fejlsvaret.

Name	Type	Beskrivelse
errorCode	string	Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.
isRetriable	boolean	Når sand, kan anmodningen prøves igen. Brug svarheaderen `Retry-After` til at bestemme forsinkelsen, hvis den er tilgængelig.
message	string	En menneskelig læsbar gengivelse af fejlen.
moreDetails	ErrorResponseDetails[]	Liste over yderligere oplysninger om fejl.
relatedResource	ErrorRelatedResource	De fejlrelaterede ressourceoplysninger.
requestId	string (uuid)	Id'et for den anmodning, der er knyttet til fejlen.

ErrorResponseDetails

Objekt

Oplysninger om fejlsvar.

Name	Type	Beskrivelse
errorCode	string	Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.
message	string	En menneskelig læsbar gengivelse af fejlen.
relatedResource	ErrorRelatedResource	De fejlrelaterede ressourceoplysninger.

Workspace

Objekt

Et arbejdsområdeobjekt.

Name	Type	Beskrivelse
apiEndpoint	string (uri)	HTTP URL-adresse, der repræsenterer det API-slutpunkt, der er specifikt for arbejdsområdet. Denne slutpunktsværdi returneres, når brugeren aktiverer preferWorkspaceSpecificEndpoints. Det giver API-adgang via private links.
capacityId	string (uuid)	Id'et for den kapacitet, arbejdsområdet er tildelt til.
capacityRegion	CapacityRegion	Området for den kapacitet, der er knyttet til dette arbejdsområde.
description	string	Beskrivelsen af arbejdsområdet.
displayName	string	Det viste navn på arbejdsområdet.
domainId	string (uuid)	Id'et for det domæne, arbejdsområdet er tildelt til.
id	string (uuid)	Arbejdsområde-id'et.
tags	WorkspaceAppliedTag[]	Liste over anvendte mærker.
type	WorkspaceType	Arbejdsområdetypen.

WorkspaceAppliedTag

Objekt

Repræsenterer en anvendt kode.

Name	Type	Beskrivelse
displayName	string	Navnet på mærket.
id	string (uuid)	Tag-id'et.

Workspaces

Objekt

Name	Type	Beskrivelse
continuationToken	string	Tokenet for det næste resultatsætbatch. Hvis der ikke er flere poster, fjernes de fra svaret.
continuationUri	string	URI'en for det næste resultatsætbatch. Hvis der ikke er flere poster, fjernes de fra svaret.
value	Workspace[]	En liste over arbejdsområder.

WorkspaceType

Optælling

En arbejdsområdetype. Der kan tilføjes flere typer arbejdsområder over tid.

Værdi	Beskrivelse
Personal	Min mappe eller Mit arbejdsområde, der bruges til at administrere brugerelementer.
Workspace	Arbejdsområde, der bruges til at administrere Fabric-elementerne.
AdminWorkspace	Administrationsovervågningsarbejdsområde. Indeholder administratorrapporter, f.eks. overvågningsrapporten og forbrugs- og indføringsrapporten.