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	Workspaces	Anmodningen blev fuldført.
Other Status Codes	ErrorResponse	Almindelige fejlkoder: InvalidParameter – Ugyldig rolle i arbejdsområdet. UnknownError – Der opstod en fejl.

Name

Type

Beskrivelse

200 OK

Workspaces

Anmodningen blev fuldført.

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

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"
    }
  ],
  "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
ErrorRelatedResource	Objektet med fejlrelaterede ressourceoplysninger.
ErrorResponse	Fejlsvaret.
ErrorResponseDetails	Oplysninger om fejlsvar.
Workspace	Et arbejdsområdeobjekt.
Workspaces
WorkspaceType	En arbejdsområdetype. Der kan tilføjes flere typer arbejdsområder over tid.

ErrorRelatedResource

Object

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

Object

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.
message	string	En menneskelig læsbar gengivelse af fejlen.
moreDetails	ErrorResponseDetails[]	Liste over yderligere oplysninger om fejl.
relatedResource	ErrorRelatedResource	De fejlrelaterede ressourceoplysninger.
requestId	string	Id'et for den anmodning, der er knyttet til fejlen.

ErrorResponseDetails

Object

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

Object

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.
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.
type	WorkspaceType	Arbejdsområdetypen.

Workspaces

Object

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.

Del via

Workspaces - List Workspaces

Påkrævede delegerede områder

Microsoft Entra-understøttede identiteter

Grænseflade

URI-parametre

Svar

Eksempler

List workspaces example

Eksempelanmodning

Eksempelsvar

List workspaces with continuation example

Eksempelanmodning

Eksempelsvar

List workspaces with preferWorkspaceSpecificEndpoints example

Eksempelanmodning

Eksempelsvar

List workspaces with roles filter example

Eksempelanmodning

Eksempelsvar

Definitioner

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

Workspace

Workspaces

WorkspaceType