Workspaces - List Workspaces

Service:

Admin

API-versie:

v1

Retourneert een lijst met werkruimten.

Note

Deze API maakt deel uit van een preview-versie en is alleen beschikbaar voor evaluatie- en ontwikkelingsdoeleinden. Het kan veranderen op basis van feedback en wordt niet aanbevolen voor productiegebruik.

Deze API ondersteunt paginering. Er kunnen maximaal 10.000 records per aanvraag worden geretourneerd. Met het continue token in het antwoord kunt u de volgende 10.000 records ophalen.

Permissions

De aanroeper moet een Fabric-beheerder zijn of verifiëren met behulp van een service-principal.

Vereiste gedelegeerde bereiken

Tenant.Read.All of Tenant.ReadWrite.All

Limitations

Maximaal 200 aanvragen per uur.

Door Microsoft Entra ondersteunde identiteiten

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

Identity	Support
User	Yes
serviceprincipal en beheerde identiteiten	Yes

Interface

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

Met optionele parameters:

GET https://api.fabric.microsoft.com/v1/admin/workspaces?type={type}&capacityId={capacityId}&name={name}&state={state}&continuationToken={continuationToken}

URI-parameters

Name	In	Vereist	Type	Description
capacityId	query		string (uuid)	De capaciteits-id van de werkruimte.
continuationToken	query		string	Vervolgtoken. Wordt gebruikt om de volgende items in de lijst op te halen.
name	query		string	De naam van de werkruimte.
state	query		string	De werkruimtestatus. Ondersteunde statussen zijn actief en verwijderd.
type	query		string	Het type werkruimte. Ondersteunde typen zijn persoonlijk, werkruimte, adminworkspace.

Antwoorden

Name	Type	Description
200 OK	Workspaces	De bewerking is geslaagd.
Other Status Codes	ErrorResponse	Veelvoorkomende foutcodes: BadRequest: queryparameters zoals workspaceType of workspaceState zijn niet geldig. InsufficientPrivileges : de aanroeper heeft geen machtigingen om de API aan te roepen.

Voorbeelden

Get a list of workspaces example

Get a list of workspaces using state query parameter example

Get a list of workspaces example

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

Statuscode:

200

{
  "workspaces": [
    {
      "id": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
      "name": "test report",
      "type": "Workspace",
      "state": "Active",
      "capacityId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e84",
      "domainId": "039bd896-b39c-4540-93e3-e9926de135f9"
    }
  ],
  "continuationUri": "https://api.fabric.microsoft.com/v1/admin/workspaces?continuationToken='LDEsMTAwMDAwLDA%3D'",
  "continuationToken": "LDEsMTAwMDAwLDA%3D"
}

Get a list of workspaces using state query parameter example

Voorbeeldaanvraag

HTTP

GET https://api.fabric.microsoft.com/v1/admin/workspaces?state=Active

Voorbeeldrespons

Statuscode:

200

{
  "workspaces": [
    {
      "id": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
      "name": "test report",
      "type": "Workspace",
      "state": "Active",
      "capacityId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e84"
    }
  ],
  "continuationUri": null,
  "continuationToken": null
}

Definities

Name	Description
ErrorRelatedResource	Het foutgerelateerde resourcedetailsobject.
ErrorResponse	Het foutbericht.
ErrorResponseDetails	De details van het foutbericht.
Workspace	Workspace.
Workspaces	Een lijst met werkruimten.
WorkspaceState	De werkruimtestatus. Er kunnen na verloop van tijd extra werkruimtestatussen worden toegevoegd.
WorkspaceType	Een werkruimtetype. Er kunnen in de loop van de tijd extra werkruimtetypen worden toegevoegd.

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.
message	string	Een leesbare weergave van de fout.
moreDetails	ErrorResponseDetails[]	Lijst met aanvullende foutdetails.
relatedResource	ErrorRelatedResource	De foutgerelateerde resourcedetails.
requestId	string	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

Workspace.

Name	Type	Description
capacityId	string (uuid)	De capaciteits-id van de werkruimte.
domainId	string (uuid)	De domein-id van de werkruimte.
id	string (uuid)	De werkruimte-ID.
name	string	De naam van de werkruimte.
state	WorkspaceState	De werkruimtestatus.
type	WorkspaceType	Het type werkruimte.

Workspaces

Object

Een lijst met werkruimten.

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.
workspaces	Workspace[]	De lijst met infrastructuurwerkruimten.

WorkspaceState

Inventarisatie

De werkruimtestatus. Er kunnen na verloop van tijd extra werkruimtestatussen worden toegevoegd.

Waarde	Description
Active	De werkruimte is actief. Zwevende werkruimten worden weergegeven als actief.
Deleted	De werkruimte wordt verwijderd.

WorkspaceType

Inventarisatie

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.