Workspaces - Get Workspace

Servizio:: Core

Versione API:: v1

Restituisce le informazioni dell'area di lavoro specificate.

Autorizzazioni

Il chiamante deve avere ruolo visualizzatore o superiore.

Ambiti delegati obbligatori

Workspace.Read.All o Workspace.ReadWrite.All

Identità supportate da Microsoft Entra

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

Identità	Assistenza
Utente	Sì
Principale del servizio e Identità gestite	Sì

Interfaccia

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

Con parametri facoltativi:

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}?preferWorkspaceSpecificEndpoints={preferWorkspaceSpecificEndpoints}

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
workspaceId	path	True	string (uuid)	L’ID dell’area di lavoro.
preferWorkspaceSpecificEndpoints	query		boolean	Impostazione che controlla se includere endpoint pubblici specifici dell'area di lavoro o generali per l'accesso all'API e a OneLake. True: includere endpoint specifici dell'area di lavoro per l'accesso api e OneLake, False- Includere endpoint pubblici generali per l'accesso a OneLake.

Risposte

Nome Tipo Descrizione

200 OK

Nome	Tipo	Descrizione
200 OK	WorkspaceInfo	Richiesta completata correttamente.
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: UnknownError: si è verificato un errore.

WorkspaceInfo

Richiesta completata correttamente.

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:

UnknownError: si è verificato un errore.

Esempio

Get a workspace example

Get a workspace with preferWorkspaceSpecificEndpoints example

Get a workspace example

Esempio di richiesta

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff227

Risposta di esempio

Codice di stato:: 200

{
  "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff227",
  "displayName": "New workspace",
  "description": "New workspace description",
  "type": "Workspace",
  "domainId": "9ce364e0-8e9d-4605-887a-b599b3e8b123",
  "capacityId": "56bac802-080d-4f73-8a42-1b406eb1fcac",
  "capacityAssignmentProgress": "Completed",
  "workspaceIdentity": {
    "applicationId": "00a4a8f9-78d3-41b3-b87a-6ae5271c8d0d",
    "servicePrincipalId": "5ba4ae58-d402-45c6-a848-0253e834fd78"
  },
  "capacityRegion": "East US",
  "oneLakeEndpoints": {
    "blobEndpoint": "https://eastus-onelake.blob.fabric.microsoft.com",
    "dfsEndpoint": "https://eastus-onelake.dfs.fabric.microsoft.com"
  }
}

Get a workspace with preferWorkspaceSpecificEndpoints example

Esempio di richiesta

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff227?preferWorkspaceSpecificEndpoints=True

Risposta di esempio

Codice di stato:: 200

{
  "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff227",
  "displayName": "New workspace",
  "description": "New workspace description",
  "type": "Workspace",
  "capacityId": "56bac802-080d-4f73-8a42-1b406eb1fcac",
  "capacityAssignmentProgress": "Completed",
  "workspaceIdentity": {
    "applicationId": "00a4a8f9-78d3-41b3-b87a-6ae5271c8d0d",
    "servicePrincipalId": "5ba4ae58-d402-45c6-a848-0253e834fd78"
  },
  "capacityRegion": "East US",
  "oneLakeEndpoints": {
    "blobEndpoint": "https://cfafbeb180374d0c896ea46fb27ff227.zcf.blob.fabric.microsoft.com",
    "dfsEndpoint": "https://cfafbeb180374d0c896ea46fb27ff227.zcf.dfs.fabric.microsoft.com"
  },
  "apiEndpoint": "https://cfafbeb180374d0c896ea46fb27ff227.zcf.w.api.fabric.microsoft.com"
}

Definizioni

Nome	Descrizione
CapacityAssignmentProgress	Assegnazione dell'area di lavoro allo stato di avanzamento della capacità. È possibile aggiungere altri valori di stato dell'assegnazione della capacità nel tempo.
CapacityRegion	Area della capacità associata a questa area di lavoro. È possibile aggiungere altri valori dell'area di capacità nel tempo.
ErrorRelatedResource	Oggetto dettagli risorsa correlato all'errore.
ErrorResponse	Risposta di errore.
ErrorResponseDetails	Dettagli della risposta di errore.
OneLakeEndpoints	Endpoint dell'API OneLake associati a questa area di lavoro.
WorkspaceIdentity	Oggetto Identity dell'area di lavoro.
WorkspaceInfo	Oggetto dell'area di lavoro.
WorkspaceType	Tipo di area di lavoro. È possibile aggiungere altri tipi di area di lavoro nel tempo.

CapacityAssignmentProgress

Enumerazione

Assegnazione dell'area di lavoro allo stato di avanzamento della capacità. È possibile aggiungere altri valori di stato dell'assegnazione della capacità nel tempo.

Valore	Descrizione
Completed	Ultima operazione di assegnazione della capacità completata.
Failed	L'operazione di assegnazione della capacità ha rilevato un errore o un errore e non è stato possibile completare.
InProgress	L'operazione di assegnazione della capacità è attualmente in esecuzione e non è ancora stata completata.

CapacityRegion

Enumerazione

Area della capacità associata a questa area di lavoro. È possibile aggiungere altri valori dell'area di capacità nel tempo.

Valore	Descrizione
Australia East	Australia orientale
Australia Southeast	Australia sud-orientale
Brazil South	Regione Brasile meridionale
Brazil Southeast	Area brasile sud-orientale
Canada Central	Area centrale del Canada
Canada East	Area canada orientale
Central India	Area india centrale
Central US	Area Stati Uniti centrali
Central US EUAP	Area UEAP stati Uniti centrali
East Asia	Area Asia orientale
East US	Area Stati Uniti orientali
East US 2	Area Stati Uniti orientali 2
France Central	Francia centrale
France South	Regione Francia meridionale
Germany Central	Area centrale germania
Germany Northeast	Germania nord-orientale
Israel Central	Israele Centrale
Italy North	Italia Nord
Japan East	Giappone orientale
Japan West	Giappone occidentale
Korea Central	Corea centrale
Korea South	Corea del Sud
Mexico Central	Area centrale del Messico
North Central US	Area Stati Uniti centro-settentrionali
North Europe	Area Europa settentrionale
Norway East	Norvegia orientale
Norway West	Norvegia occidentale
Poland Central	Polonia Centrale
South Africa North	Area del Nord Africa
South Africa West	Sud Africa occidentale
South Central US	Area Stati Uniti centro-meridionali
South India	India meridionale
Southeast Asia	Area Asia sud-orientale
Spain Central	Spagna Centrale
Sweden Central	Regione centrale della Svezia
Switzerland North	Svizzera Settentrionale
Switzerland West	Svizzera occidentale
West Europe	Area Europa occidentale
West India	Area india occidentale
West US	Area Stati Uniti occidentali
West US 2	Area Stati Uniti occidentali 2
West US 3	Area Stati Uniti occidentali 3
West Central US	Area Stati Uniti centro-occidentali
UAE Central	Emirati Arabi Uniti centrali
UAE North	Emirati Arabi Uniti settentrionali
Qatar Central	Area centrale del Qatar
Germany West Central	Germania centro-occidentale
Germany North	Area nord della Germania
UK South	Regno Unito meridionale
UK West	Area Regno Unito occidentale
China North	Cina settentrionale
China East	Area Cina orientale
China East 2	Area Cina orientale 2
China East 3	Area Cina orientale 3
China North 2	Cina settentrionale 2 area
China North 3	Cina settentrionale 3 area

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

OneLakeEndpoints

Oggetto

Endpoint dell'API OneLake associati a questa area di lavoro.

Nome	Tipo	Descrizione
blobEndpoint	string	Endpoint dell'API OneLake disponibile per le operazioni dell'API BLOB. Per impostazione predefinita, si tratta di un endpoint specifico dell'area. Se l'utente abilita preferWorkspaceSpecificEndpoints o l'area di lavoro ha accesso pubblico disabilitato, viene fornito l'endpoint specifico dell'area di lavoro per consentire l'accesso tramite collegamenti privati.
dfsEndpoint	string	L'endpoint DELL'API OneLake disponibile per le operazioni dell'API File System distribuita (DFS) o ADLSgen2. Per impostazione predefinita, si tratta di un endpoint specifico dell'area. Se l'utente abilita preferWorkspaceSpecificEndpoints o l'area di lavoro ha accesso pubblico disabilitato, viene fornito l'endpoint specifico dell'area di lavoro per consentire l'accesso tramite collegamenti privati.

WorkspaceIdentity

Oggetto

Oggetto Identity dell'area di lavoro.

Nome	Tipo	Descrizione
applicationId	string (uuid)	ID applicazione.
servicePrincipalId	string (uuid)	ID entità servizio.

WorkspaceInfo

Oggetto

Oggetto dell'area di lavoro.

Nome	Tipo	Descrizione
apiEndpoint	string (uri)	URL HTTP che rappresenta l'endpoint API specifico dell'area di lavoro. Questo valore dell'endpoint viene restituito quando l'utente abilita preferWorkspaceSpecificEndpoints. Consente l'accesso all'API tramite collegamenti privati.
capacityAssignmentProgress	CapacityAssignmentProgress	Stato dell'avanzamento dell'assegnazione della capacità dell'area di lavoro.
capacityId	string (uuid)	ID della capacità a cui è assegnata l'area di lavoro.
capacityRegion	CapacityRegion	Area della capacità associata a questa area di lavoro.
description	string	Descrizione dell'area di lavoro.
displayName	string	Nome visualizzato dell'area di lavoro.
domainId	string (uuid)	ID del dominio a cui è assegnata l'area di lavoro.
id	string (uuid)	L’ID dell’area di lavoro.
oneLakeEndpoints	OneLakeEndpoints	Endpoint dell'API OneLake associati a questa area di lavoro.
type	WorkspaceType	Tipo di area di lavoro.
workspaceIdentity	WorkspaceIdentity	Identità dell'area di lavoro.

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.

Condividi tramite

Workspaces - Get Workspace

Autorizzazioni

Ambiti delegati obbligatori

Identità supportate da Microsoft Entra

Interfaccia

Parametri dell'URI

Risposte

Esempio

Get a workspace example

Esempio di richiesta

Risposta di esempio

Get a workspace with preferWorkspaceSpecificEndpoints example

Esempio di richiesta

Risposta di esempio

Definizioni

CapacityAssignmentProgress

CapacityRegion

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

OneLakeEndpoints

WorkspaceIdentity

WorkspaceInfo

WorkspaceType