Workspaces - Get Workspace

Service:

Admin

API-versie:

v1

Retourneert de opgegeven werkruimte.

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.

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/{workspaceId}

URI-parameters

Name	In	Vereist	Type	Description
workspaceId	path	True	string (uuid)	De werkruimte-ID.

Antwoorden

Name	Type	Description
200 OK	Workspace	OK
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: EntityNotFound: de werkruimte-id bestaat niet. InsufficientPrivileges : de aanroeper heeft geen machtigingen om de API aan te roepen.

Voorbeelden

Get workspace details by ID example

Voorbeeldaanvraag

HTTP

GET https://api.fabric.microsoft.com/v1/admin/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48

Voorbeeldrespons

Statuscode:

200

{
  "id": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
  "name": "test report",
  "type": "Workspace",
  "state": "Active",
  "capacityId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e84",
  "domainId": "8badadb6-9945-4e07-8134-00e0defec00b",
  "tags": [
    {
      "id": "b3f2c8e9-4d8e-4a7c-9a32-f8c1b2e4d6af",
      "displayName": "Finance"
    }
  ]
}

Definities

Name	Description
ErrorRelatedResource	Het foutgerelateerde resourcedetailsobject.
ErrorResponse	Het foutbericht.
ErrorResponseDetails	De details van het foutbericht.
Workspace	Workspace.
WorkspaceAppliedTag	Vertegenwoordigt een toegepaste tag.
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.
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

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.
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.

WorkspaceState

Opsomming

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

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.