Workspaces - Get Workspace

Servizio:

Admin

Versione API:

v1

Restituisce l'area di lavoro specificata.

Note

Questa API fa parte di una versione di anteprima e viene fornita solo a scopo di valutazione e sviluppo. Può cambiare in base al feedback e non è consigliato per l'uso in produzione.

Permissions

Il chiamante deve essere un amministratore di Fabric o eseguire l'autenticazione usando un'entità servizio.

Ambiti delegati obbligatori

Tenant.Read.All o Tenant.ReadWrite.All

Limitations

Massimo 200 richieste all'ora.

Identità supportate da Microsoft Entra

Questa API supporta le identità di Microsoft elencate in questa sezione.

Identity	Support
User	Yes
Principale del servizio e Identità gestite	Yes

Interface

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
workspaceId	path	True	string (uuid)	L’ID dell’area di lavoro.

Risposte

Nome	Tipo	Descrizione
200 OK	Workspace	OK
429 Too Many Requests	ErrorResponse	È stato superato il limite di velocità del servizio. Il server restituisce un'intestazione Retry-After che indica, in secondi, per quanto tempo il client deve attendere prima di inviare richieste aggiuntive. Intestazioni Retry-After: integer
Other Status Codes	ErrorResponse	Codici di errore comuni: EntityNotFound: l'ID dell'area di lavoro non esiste. InsufficientPrivileges: il chiamante non dispone delle autorizzazioni per chiamare l'API.

Esempio

Get workspace details by ID example

Esempio di richiesta

HTTP

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

Risposta di esempio

Codice di stato:

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

Definizioni

Nome	Descrizione
ErrorRelatedResource	Oggetto dettagli risorsa correlato all'errore.
ErrorResponse	Risposta di errore.
ErrorResponseDetails	Dettagli della risposta di errore.
Workspace	Workspace.
WorkspaceAppliedTag	Rappresenta un tag applicato.
WorkspaceState	Stato dell'area di lavoro. È possibile aggiungere altri stati dell'area di lavoro nel tempo.
WorkspaceType	Tipo di area di lavoro. È possibile aggiungere altri tipi di area di lavoro nel tempo.

ErrorRelatedResource

Oggetto

Oggetto dettagli risorsa correlato all'errore.

Nome	Tipo	Descrizione
resourceId	string	ID risorsa coinvolto nell'errore.
resourceType	string	Tipo della risorsa coinvolta nell'errore.

ErrorResponse

Oggetto

Risposta di errore.

Nome	Tipo	Descrizione
errorCode	string	Identificatore specifico che fornisce informazioni su una condizione di errore, consentendo la comunicazione standardizzata tra il servizio e i relativi utenti.
isRetriable	boolean	Se true, la richiesta può essere ritentata. Usare l'intestazione della Retry-After risposta per determinare il ritardo, se disponibile.
message	string	Rappresentazione leggibile dell'errore.
moreDetails	ErrorResponseDetails[]	Elenco di dettagli aggiuntivi sull'errore.
relatedResource	ErrorRelatedResource	Dettagli della risorsa correlati all'errore.
requestId	string (uuid)	ID della richiesta associata all'errore.

ErrorResponseDetails

Oggetto

Dettagli della risposta di errore.

Nome	Tipo	Descrizione
errorCode	string	Identificatore specifico che fornisce informazioni su una condizione di errore, consentendo la comunicazione standardizzata tra il servizio e i relativi utenti.
message	string	Rappresentazione leggibile dell'errore.
relatedResource	ErrorRelatedResource	Dettagli della risorsa correlati all'errore.

Workspace

Oggetto

Workspace.

Nome	Tipo	Descrizione
capacityId	string (uuid)	ID di capacità dell'area di lavoro.
domainId	string (uuid)	ID di dominio dell'area di lavoro.
id	string (uuid)	L’ID dell’area di lavoro.
name	string	Nome dell'area di lavoro.
state	WorkspaceState	Stato dell'area di lavoro.
tags	WorkspaceAppliedTag[]	Elenco di tag applicati.
type	WorkspaceType	Tipo di area di lavoro.

WorkspaceAppliedTag

Oggetto

Rappresenta un tag applicato.

Nome	Tipo	Descrizione
displayName	string	Nome del tag.
id	string (uuid)	ID tag.

WorkspaceState

Enumerazione

Stato dell'area di lavoro. È possibile aggiungere altri stati dell'area di lavoro nel tempo.

Valore	Descrizione
Active	L'area di lavoro è attiva. Le aree di lavoro orfane vengono visualizzate come attive.
Deleted	L'area di lavoro viene eliminata.

WorkspaceType

Enumerazione

Tipo di area di lavoro. È possibile aggiungere altri tipi di area di lavoro nel tempo.

Valore	Descrizione
Personal	La cartella o l'area di lavoro personale usata per gestire gli elementi utente.
Workspace	Area di lavoro usata per gestire gli elementi dell'infrastruttura.
AdminWorkspace	Area di lavoro monitoraggio amministratore. Contiene report di amministratore, ad esempio il report di controllo e il report sull'utilizzo e l'adozione.