Workspaces - List Workspaces

Servizio:: Admin

Versione API:: v1

Restituisce un elenco di aree di lavoro.

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.

Questa API supporta paginazione. È possibile restituire un massimo di 10.000 record per ogni richiesta. Con il token di continuazione fornito nella risposta, è possibile ottenere i 10.000 record successivi.

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.

Il encryptionStatus filtro viene applicato solo quando il include parametro contiene encryption.

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

Con parametri facoltativi:

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

Parametri dell'URI

Nome	In	Tipo	Descrizione
capacityId	query	string (uuid)	ID di capacità dell'area di lavoro.
continuationToken	query	string	Token di continuazione. Consente di ottenere gli elementi successivi nell'elenco.
encryptionStatus	query	string	Indica lo stato di crittografia cmk dell'area di lavoro e viene usato per filtrare le aree di lavoro che corrispondono allo stato specificato.
include	query	string	Specifica dati aggiuntivi da includere per ogni area di lavoro nella risposta. Valori supportati: `encryption`.
name	query	string	Nome dell'area di lavoro.
state	query	string	Stato dell'area di lavoro. Gli stati supportati sono attivi ed eliminati.
type	query	string	Tipo di area di lavoro. I tipi supportati sono personale, area di lavoro, adminworkspace.

Risposte

Nome Tipo Descrizione

200 OK

Nome	Tipo	Descrizione
200 OK	Workspaces	L'operazione è stata completata.
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: BadRequest: parametri di query come `workspaceType` o `workspaceState` non validi. InsufficientPrivileges: il chiamante non dispone delle autorizzazioni per chiamare l'API.

Workspaces

L'operazione è stata completata.

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:

BadRequest: parametri di query come workspaceType o workspaceState non validi.
InsufficientPrivileges: il chiamante non dispone delle autorizzazioni per chiamare l'API.

Esempio

Get a list of workspaces example

Get a list of workspaces using state query parameter example

List workspaces for a given capacity, ignoring the encryptionStatus filter.

List workspaces with active encryption status in a given capacity

List workspaces with encryption details

Get a list of workspaces example

Esempio di richiesta

HTTP

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

Risposta di esempio

Codice di stato:: 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",
      "tags": [
        {
          "id": "b3f2c8e9-4d8e-4a7c-9a32-f8c1b2e4d6af",
          "displayName": "Finance"
        },
        {
          "id": "6f1a8d3b-92c4-4f67-8c2d-1e5a9b7f4a23",
          "displayName": "Production"
        }
      ]
    }
  ],
  "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

Esempio di richiesta

HTTP

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

Risposta di esempio

Codice di stato:: 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
}

List workspaces for a given capacity, ignoring the encryptionStatus filter.

Esempio di richiesta

HTTP

GET https://api.fabric.microsoft.com/v1/admin/workspaces?capacityId=61d6811f-7544-4e75-a1e6-1c59c0383312&encryptionStatus=Active

Risposta di esempio

Codice di stato:: 200

{
  "workspaces": [
    {
      "id": "abf49964-6f70-4aea-a66c-4b78a22e3ddc",
      "name": "Contoso Workspace 1",
      "type": "Workspace",
      "state": "Active",
      "capacityId": "61d6811f-7544-4e75-a1e6-1c59c0383312",
      "domainId": "039bd896-b39c-4540-93e3-e9926de135f9"
    },
    {
      "id": "90119767-07b4-4657-82ee-53e90fece225",
      "name": "Contoso Workspace 3",
      "type": "Workspace",
      "state": "Active",
      "capacityId": "61d6811f-7544-4e75-a1e6-1c59c0383312",
      "domainId": "039bd896-b39c-4540-93e3-e9926de135f9"
    }
  ],
  "continuationUri": "https://api.fabric.microsoft.com/v1/admin/workspaces?continuationToken='LDEsMTAwMDAwLDA%3D'",
  "continuationToken": "LDEsMTAwMDAwLDA%3D"
}

List workspaces with active encryption status in a given capacity

Esempio di richiesta

HTTP

GET https://api.fabric.microsoft.com/v1/admin/workspaces?capacityId=61d6811f-7544-4e75-a1e6-1c59c0383312&encryptionStatus=Active&include=encryption

Risposta di esempio

Codice di stato:: 200

{
  "workspaces": [
    {
      "id": "90119767-07b4-4657-82ee-53e90fece225",
      "name": "Contoso Workspace 3",
      "type": "Workspace",
      "state": "Active",
      "capacityId": "61d6811f-7544-4e75-a1e6-1c59c0383312",
      "domainId": "039bd896-b39c-4540-93e3-e9926de135f9",
      "encryption": {
        "status": "Active",
        "keyIdentifier": "https://westus07112025-cmktest1.vault.azure.net/keys/test2k/"
      }
    }
  ],
  "continuationUri": "https://api.fabric.microsoft.com/v1/admin/workspaces?continuationToken='LDEsMTAwMDAwLDA%3D'",
  "continuationToken": "LDEsMTAwMDAwLDA%3D"
}

List workspaces with encryption details

Esempio di richiesta

HTTP

GET https://api.fabric.microsoft.com/v1/admin/workspaces?encryptionStatus={encryptionStatus}&include=encryption

Risposta di esempio

Codice di stato:: 200

{
  "workspaces": [
    {
      "id": "abf49964-6f70-4aea-a66c-4b78a22e3ddc",
      "name": "Contoso Workspace 1",
      "type": "Workspace",
      "state": "Active",
      "capacityId": "61d6811f-7544-4e75-a1e6-1c59c0383312",
      "domainId": "039bd896-b39c-4540-93e3-e9926de135f9",
      "encryption": {
        "status": "Disabled"
      }
    },
    {
      "id": "9c7f06cc-e850-4961-b2bd-181a70b1a784",
      "name": "Contoso Workspace 2",
      "type": "Workspace",
      "state": "Active",
      "capacityId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e84",
      "domainId": "039bd896-b39c-4540-93e3-e9926de135f9",
      "encryption": {
        "status": "Disabled"
      }
    },
    {
      "id": "90119767-07b4-4657-82ee-53e90fece225",
      "name": "Contoso Workspace 3",
      "type": "Workspace",
      "state": "Active",
      "capacityId": "61d6811f-7544-4e75-a1e6-1c59c0383312",
      "domainId": "039bd896-b39c-4540-93e3-e9926de135f9",
      "encryption": {
        "status": "Active",
        "keyIdentifier": "https://westus07112025-cmktest1.vault.azure.net/keys/test2k/"
      }
    },
    {
      "id": "adaa3051-b1de-41ed-b1b4-d5e08887c1e9",
      "name": "Contoso Workspace 4",
      "type": "Workspace",
      "state": "Active",
      "capacityId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e84",
      "domainId": "039bd896-b39c-4540-93e3-e9926de135f9",
      "encryption": {
        "status": "EnableInProgress",
        "keyIdentifier": "https://westus07112025-cmktest1.vault.azure.net/keys/test2k/",
        "previousStatus": "Active",
        "previousKeyIdentifier": "https://westus07112025-cmktest1.vault.azure.net/keys/test4k/"
      }
    }
  ],
  "continuationUri": "https://api.fabric.microsoft.com/v1/admin/workspaces?continuationToken='LDEsMTAwMDAwLDA%3D'",
  "continuationToken": "LDEsMTAwMDAwLDA%3D"
}

Definizioni

Nome	Descrizione
Encryption	Dettagli di crittografia dell'area di lavoro tramite una chiave gestita dal cliente (CMK).
ErrorRelatedResource	Oggetto dettagli risorsa correlato all'errore.
ErrorResponse	Risposta di errore.
ErrorResponseDetails	Dettagli della risposta di errore.
Workspace	Workspace.
WorkspaceAppliedTag	Rappresenta un tag applicato.
WorkspaceEncryptionStatus	Stato di crittografia della chiave gestita dal cliente dell'area di lavoro.
Workspaces	Elenco di aree di lavoro.
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.

Encryption

Oggetto

Dettagli di crittografia dell'area di lavoro tramite una chiave gestita dal cliente (CMK).

Nome	Tipo	Descrizione
keyIdentifier	string	Identificatore della chiave di crittografia.
previousKeyIdentifier	string	Identificatore della chiave di crittografia precedente.
previousStatus	WorkspaceEncryptionStatus	Stato di crittografia cmk precedente dell'area di lavoro.
status	WorkspaceEncryptionStatus	Stato di crittografia della chiave gestita dal cliente dell'area di lavoro.

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.
encryption	Encryption	Dettagli della crittografia 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.

WorkspaceEncryptionStatus

Enumerazione

Stato di crittografia della chiave gestita dal cliente dell'area di lavoro.

Valore	Descrizione
Disabled	La crittografia dell'area di lavoro non è attiva.
Active	La crittografia dell'area di lavoro è attiva e l'area di lavoro è crittografata.
EnableInProgress	La crittografia dell'area di lavoro è abilitata.
DisableInProgress	La crittografia dell'area di lavoro viene disabilitata.
Failed	Applicazione di crittografia dell'area di lavoro non riuscita.

Workspaces

Oggetto

Elenco di aree di lavoro.

Nome	Tipo	Descrizione
continuationToken	string	Token per il batch del set di risultati successivo. Se non sono presenti altri record, viene rimosso dalla risposta.
continuationUri	string	URI del batch del set di risultati successivo. Se non sono presenti altri record, viene rimosso dalla risposta.
workspaces	Workspace[]	Elenco di aree di lavoro dell'infrastruttura.

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.