Workspaces - List Workspaces

Tjänst:: Core

API-version:: v1

Returnerar en lista över arbetsytor som huvudnamnet kan komma åt. Använd frågeparametern roles för att filtrera resultat efter huvudrollen för arbetsytan.
Det här API:et stöder sidnumrering.

Obligatoriska delegerade omfång

Workspace.Read.All eller Workspace.ReadWrite.All

Identiteter som stöds av Microsoft Entra

Det här API:et stöder Microsoft identiteter som anges i det här avsnittet.

Identitet	Stöd
Användare	Ja
Tjänsthuvudnamn och hanterade identiteter	Ja

Gränssnitt

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

Med valfria parametrar:

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

URI-parametrar

Name	I	Typ	Description
continuationToken	query	string	En token för att hämta nästa sida med resultat.
preferWorkspaceSpecificEndpoints	query	boolean	En inställning som styr om den arbetsytespecifika API-slutpunkten ska inkluderas per arbetsyta. Sant – Inkludera den arbetsytespecifika API-slutpunkten, False – Inkludera inte den arbetsytespecifika API-slutpunkten.
roles	query	string	En lista över roller. Avgränsa värden med ett kommatecken. Om det inte anges returneras alla arbetsytor.

Svar

Name Typ Description

200 OK

Name	Typ	Description
200 OK	Workspaces	Begäran har slutförts.
429 Too Many Requests	ErrorResponse	Gränsen för tjänstfrekvens överskreds. Servern returnerar ett `Retry-After` huvud som anger i sekunder hur länge klienten måste vänta innan ytterligare begäranden skickas. Sidhuvuden Retry-After: integer
Other Status Codes	ErrorResponse	Vanliga felkoder: InvalidParameter – Ogiltig arbetsyteroll. UnknownError – Ett fel uppstod.

Workspaces

Begäran har slutförts.

429 Too Many Requests

ErrorResponse

Gränsen för tjänstfrekvens överskreds. Servern returnerar ett Retry-After huvud som anger i sekunder hur länge klienten måste vänta innan ytterligare begäranden skickas.

Sidhuvuden

Retry-After: integer

Other Status Codes

ErrorResponse

Vanliga felkoder:

InvalidParameter – Ogiltig arbetsyteroll.
UnknownError – Ett fel uppstod.

Exempel

List workspaces example

List workspaces with continuation example

List workspaces with preferWorkspaceSpecificEndpoints example

List workspaces with roles filter example

List workspaces example

Exempelbegäran

HTTP

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

Exempelsvar

Statuskod:: 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",
      "tags": [
        {
          "id": "9b8c7d6e-5f4a-3b2c-1d0e-9f8a7b6c5d4e",
          "displayName": "Finance"
        },
        {
          "id": "b3f2c8e9-4d8e-4a7c-9a32-f8c1b2e4d6af",
          "displayName": "Marketing"
        }
      ]
    }
  ]
}

List workspaces with continuation example

Exempelbegäran

HTTP

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

Exempelsvar

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

Exempelbegäran

HTTP

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

Exempelsvar

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

Exempelbegäran

HTTP

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

Exempelsvar

Statuskod:: 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	Description
ErrorRelatedResource	Det felrelaterade resursinformationsobjektet.
ErrorResponse	Felsvaret.
ErrorResponseDetails	Information om felsvar.
Workspace	Ett arbetsyteobjekt.
WorkspaceAppliedTag	Representerar en tillämpad tagg.
Workspaces
WorkspaceType	En arbetsytetyp. Ytterligare arbetsytetyper kan läggas till över tid.

ErrorRelatedResource

Objekt

Det felrelaterade resursinformationsobjektet.

Name	Typ	Description
resourceId	string	Det resurs-ID som ingår i felet.
resourceType	string	Typen av resurs som är inblandad i felet.

ErrorResponse

Objekt

Felsvaret.

Name	Typ	Description
errorCode	string	En specifik identifierare som ger information om ett feltillstånd, vilket möjliggör standardiserad kommunikation mellan vår tjänst och dess användare.
isRetriable	boolean	När det är sant kan begäran göras på nytt. Använd svarshuvudet `Retry-After` för att fastställa fördröjningen, om den är tillgänglig.
message	string	En mänsklig läsbar representation av felet.
moreDetails	ErrorResponseDetails[]	Lista över ytterligare felinformation.
relatedResource	ErrorRelatedResource	Felrelaterad resursinformation.
requestId	string (uuid)	ID för den begäran som är associerad med felet.

ErrorResponseDetails

Objekt

Information om felsvar.

Name	Typ	Description
errorCode	string	En specifik identifierare som ger information om ett feltillstånd, vilket möjliggör standardiserad kommunikation mellan vår tjänst och dess användare.
message	string	En mänsklig läsbar representation av felet.
relatedResource	ErrorRelatedResource	Felrelaterad resursinformation.

Workspace

Objekt

Ett arbetsyteobjekt.

Name	Typ	Description
apiEndpoint	string (uri)	HTTP-URL som representerar DEN API-slutpunkt som är specifik för arbetsytan. Det här slutpunktsvärdet returneras när användaren aktiverar preferWorkspaceSpecificEndpoints. Det ger API-åtkomst via privata länkar.
capacityId	string (uuid)	ID:t för den kapacitet som arbetsytan tilldelas till.
description	string	Beskrivningen av arbetsytan.
displayName	string	Arbetsytans visningsnamn.
domainId	string (uuid)	ID:t för domänen som arbetsytan är tilldelad till.
id	string (uuid)	Arbetsyte-ID.
tags	WorkspaceAppliedTag[]	Lista över tillämpade taggar.
type	WorkspaceType	Typ av arbetsyta.

WorkspaceAppliedTag

Objekt

Representerar en tillämpad tagg.

Name	Typ	Description
displayName	string	Namnet på taggen.
id	string (uuid)	Tagg-ID:t.

Workspaces

Objekt

Name	Typ	Description
continuationToken	string	Token för nästa resultatuppsättningsbatch. Om det inte finns några fler poster tas den bort från svaret.
continuationUri	string	URI:n för nästa resultatuppsättningsbatch. Om det inte finns några fler poster tas den bort från svaret.
value	Workspace[]	En lista över arbetsytor.

WorkspaceType

Uppräkning

En arbetsytetyp. Ytterligare arbetsytetyper kan läggas till över tid.

Värde	Description
Personal	Min mapp eller Min arbetsyta används för att hantera användarobjekt.
Workspace	Arbetsyta som används för att hantera infrastrukturobjekten.
AdminWorkspace	Arbetsyta för administratörsövervakning. Innehåller administratörsrapporter som granskningsrapporten och användnings- och implementeringsrapporten.