Workspaces - List Workspaces

Service:
Core
API-versie:
v1

Retourneert een lijst met werkruimten die de principal kan openen. Gebruik de queryparameter rollen om resultaten te filteren op de rol van de principal-werkruimte.
Deze API ondersteunt paginering.

Vereiste gedelegeerde bereiken

Workspace.Read.All of Workspace.ReadWrite.All

Snelheidsbeperkingen

Limiettype Value
Uniform quotum voor platform-API's 200 oproepen/min.
API-limiet 200 oproepen/min.

Door Microsoft Entra ondersteunde identiteiten

Deze API ondersteunt de Microsoft-identiteiten die in deze sectie worden vermeld.

Identiteit Ondersteuning
Gebruiker Ja
serviceprincipal en beheerde identiteiten Ja

gebruikersinterface

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

URI-parameters

Name In Vereist Type Description
continuationToken
 query

string

Een token voor het ophalen van de volgende pagina met resultaten.
preferWorkspaceSpecificEndpoints
 query

boolean

Een instelling waarmee wordt bepaald of het werkruimtespecifieke API-eindpunt per werkruimte moet worden opgenomen. Waar- Neem het werkruimtespecifieke API-eindpunt op, Onwaar: neem het werkruimtespecifieke API-eindpunt niet op.
roles
 query

string

Een lijst met rollen. Scheid waarden met behulp van een komma. Indien niet opgegeven, worden alle werkruimten geretourneerd.

Antwoorden

Name Type Description
200 OK

Workspaces

De aanvraag is voltooid.
429 Too Many Requests

ErrorResponse

De servicesnelheidslimiet is overschreden. De server retourneert een Retry-After header die in seconden aangeeft hoe lang de client moet wachten voordat extra aanvragen worden verzonden.

Kopteksten

Retry-After: integer
Other Status Codes

ErrorResponse

Veelvoorkomende foutcodes:

  • InvalidParameter : ongeldige werkruimterol.

  • UnknownError: er is een fout opgetreden.

Voorbeelden

List workspaces example
List workspaces with continuation example
List workspaces with preferWorkspaceSpecificEndpoints example
List workspaces with roles filter example

List workspaces example

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Definities

Name Description
CapacityRegion

De regio van de capaciteit die aan deze werkruimte is gekoppeld. Er kunnen in de loop van de tijd extra capaciteitsregiowaarden worden toegevoegd.
ErrorRelatedResource

Het foutgerelateerde resourcedetailsobject.
ErrorResponse

Het foutbericht.
ErrorResponseDetails

De details van het foutbericht.
Workspace

Een werkruimteobject.
WorkspaceAppliedTag

Vertegenwoordigt een toegepaste tag.
Workspaces
WorkspaceType

Een werkruimtetype. Er kunnen in de loop van de tijd extra werkruimtetypen worden toegevoegd.

CapacityRegion

Opsomming

De regio van de capaciteit die aan deze werkruimte is gekoppeld. Er kunnen in de loop van de tijd extra capaciteitsregiowaarden worden toegevoegd.

Waarde Description
Australia East

Regio Australië - oost
Australia Southeast

Regio Australië - zuidoost
Brazil South

Regio Brazilië - zuid
Brazil Southeast

Regio Brazilië - zuidoost
Canada Central

Regio Canada - centraal
Canada East

Regio Canada - oost
Central India

Regio India - centraal
Central US

Regio VS - centraal
Central US EUAP

REGIO VS - centraal EUAP
East Asia

Regio Azië - oost
East US

Regio VS - oost
East US 2

Regio VS - oost 2
France Central

Regio Frankrijk - centraal
France South

Regio Frankrijk - zuid
Germany Central

Regio Duitsland - centraal
Germany Northeast

Duitse noordoostelijke regio
Israel Central

Regio Israël - centraal
Italy North

Regio Italië - noord
Japan East

Regio Japan - oost
Japan West

Regio Japan - west
Korea Central

Regio Korea - centraal
Korea South

Zuid-Korea
Mexico Central

Regio Mexico -centraal
North Central US

Regio VS - noord-centraal
North Europe

Regio Europa - noord
Norway East

Noorwegen - oost
Norway West

Regio Noorwegen - west
Poland Central

Regio Polen - centraal
South Africa North

Regio Zuid-Afrika - noord
South Africa West

Regio Zuid-Afrika - west
South Central US

Regio VS - zuid-centraal
South India

Regio India - zuid
Southeast Asia

Regio Azië - zuidoost
Spain Central

Regio Spanje - centraal
Sweden Central

Regio Zweden - centraal
Switzerland North

Regio Zwitserland - noord
Switzerland West

Regio Zwitserland - west
West Europe

Regio Europa - west
West India

Regio India - west
West US

Regio VS - west
West US 2

Regio VS - west 2
West US 3

Regio VS - west 3
West Central US

Regio VS - west-centraal
UAE Central

Regio UAE - centraal
UAE North

Regio UAE - noord
Qatar Central

Regio Qatar - centraal
Germany West Central

Regio Duitsland - west-centraal
Germany North

Regio Duitsland - noord
UK South

Regio VK - zuid
UK West

Regio VK - west
China North

Regio China - noord
China East

Regio China - oost
China East 2

Regio China - oost 2
China East 3

Regio China - oost 3
China North 2

Regio China - noord 2
China North 3

Regio China - noord 3

ErrorRelatedResource

Object

Het foutgerelateerde resourcedetailsobject.

Name Type Description
resourceId

string

De resource-id die betrokken is bij de fout.
resourceType

string

Het type resource dat betrokken is bij de fout.

ErrorResponse

Object

Het foutbericht.

Name Type Description
errorCode

string

Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.
isRetriable

boolean

Wanneer waar, kan de aanvraag opnieuw worden geprobeerd. Gebruik de Retry-After antwoordheader om de vertraging te bepalen, indien beschikbaar.
message

string

Een leesbare weergave van de fout.
moreDetails

ErrorResponseDetails[]

Lijst met aanvullende foutdetails.
relatedResource

ErrorRelatedResource

De foutgerelateerde resourcedetails.
requestId

string (uuid)

Id van de aanvraag die is gekoppeld aan de fout.

ErrorResponseDetails

Object

De details van het foutbericht.

Name Type Description
errorCode

string

Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.
message

string

Een leesbare weergave van de fout.
relatedResource

ErrorRelatedResource

De foutgerelateerde resourcedetails.

Workspace

Object

Een werkruimteobject.

Name Type Description
apiEndpoint

string (uri)

HTTP-URL die het API-eindpunt vertegenwoordigt dat specifiek is voor de werkruimte. Deze eindpuntwaarde wordt geretourneerd wanneer de gebruiker preferWorkspaceSpecificEndpoints inschakelt. Het biedt API-toegang via privékoppelingen.
capacityId

string (uuid)

De id van de capaciteit waaraan de werkruimte is toegewezen.
capacityRegion

CapacityRegion

De regio van de capaciteit die aan deze werkruimte is gekoppeld.
description

string

De beschrijving van de werkruimte.
displayName

string

De weergavenaam van de werkruimte.
domainId

string (uuid)

De id van het domein waaraan de werkruimte is toegewezen.
id

string (uuid)

De werkruimte-ID.
tags

WorkspaceAppliedTag[]

Lijst met toegepaste tags.
type

WorkspaceType

Het type werkruimte.

WorkspaceAppliedTag

Object

Vertegenwoordigt een toegepaste tag.

Name Type Description
displayName

string

De naam van de tag.
id

string (uuid)

De tag-id.

Workspaces

Object
Name Type Description
continuationToken

string

Het token voor de volgende batch met resultatensets. Als er geen records meer zijn, wordt deze verwijderd uit het antwoord.
continuationUri

string

De URI van de volgende batch met resultatensets. Als er geen records meer zijn, wordt deze verwijderd uit het antwoord.
value

Workspace[]

Een lijst met werkruimten.

WorkspaceType

Opsomming

Een werkruimtetype. Er kunnen in de loop van de tijd extra werkruimtetypen worden toegevoegd.

Waarde Description
Personal

Mijn map of Mijn werkruimte die wordt gebruikt voor het beheren van gebruikersitems.
Workspace

Werkruimte die wordt gebruikt voor het beheren van de Fabric-items.
AdminWorkspace

Werkruimte voor beheerbewaking. Bevat beheerdersrapporten, zoals het auditrapport en het gebruiks- en acceptatierapport.