Items - List Environments

Riferimento

Servizio:: Environment

Versione API:: v1

Restituisce un elenco di ambienti dall'area di lavoro specificata.
Questa API supporta paginazione.

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à	Appoggiare
Utente	Sì
'entità servizio e identità gestite	Sì

Interfaccia

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

Con parametri facoltativi:

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
workspaceId	path	True	string uuid	ID dell'area di lavoro.
continuationToken	query		string	Token per il recupero della pagina successiva dei risultati.

Risposte

Nome	Tipo	Descrizione
200 OK	Environments	Richiesta completata correttamente.
Other Status Codes	ErrorResponse	Codici di errore comuni: InvalidItemType - Tipo di elemento non valido

Nome

Tipo

Descrizione

200 OK

Environments

Richiesta completata correttamente.

Other Status Codes

ErrorResponse

Codici di errore comuni:

InvalidItemType - Tipo di elemento non valido

Esempio

List environments in workspace example

Esempio di richiesta

HTTP

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

Risposta di esempio

Codice di stato:: 200

{
  "value": [
    {
      "id": "3546052c-ae64-4526-b1a8-52af7761426f",
      "displayName": "Environment_1",
      "description": "A environment description.",
      "type": "Environment",
      "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "properties": {
        "publishDetails": {
          "state": "Failed",
          "targetVersion": "14ece8b5-68a1-4130-a9e7-074c04537588",
          "startTime": "2024-03-30T14:17:09.0697022Z",
          "endTime": "2024-03-30T14:48:09.0697022Z",
          "componentPublishInfo": {
            "sparkLibraries": {
              "state": "Failed"
            },
            "sparkSettings": {
              "state": "Success"
            }
          }
        }
      }
    },
    {
      "id": "a8a1bffa-7eea-49dc-a1d2-6281c1d031f1",
      "displayName": "Environment_2",
      "description": "A environment description.",
      "type": "Environment",
      "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "properties": {
        "publishDetails": {
          "state": "Success",
          "targetVersion": "46838a80-5450-4414-bea0-40fb6f3e0c0d",
          "startTime": "2024-03-29T14:17:09.0697022Z",
          "endTime": "2024-03-29T14:48:09.0697022Z",
          "componentPublishInfo": {
            "sparkLibraries": {
              "state": "Success"
            },
            "sparkSettings": {
              "state": "Success"
            }
          }
        }
      }
    }
  ]
}

Definizioni

Nome	Descrizione
ComponentPublishInfo	Pubblicare informazioni per ogni componente nell'ambiente.
Environment	Elemento Environment.
EnvironmentPublishInfo	Informazioni sulla pubblicazione dell'ambiente.
EnvironmentPublishState	Stato di pubblicazione. È possibile aggiungere altri tipi di stato nel tempo.
Environments	Elenco di ambienti.
ErrorRelatedResource	Oggetto dettagli risorsa correlato all'errore.
ErrorResponse	Risposta di errore.
ErrorResponseDetails	Dettagli della risposta di errore.
ItemType	Tipo dell'elemento. È possibile aggiungere altri tipi di elemento nel tempo.
PublishDetails	Dettagli dell'operazione di pubblicazione.
SparkLibraries	Librerie Spark.
SparkSettings	Impostazioni di Spark.

ComponentPublishInfo

Object

Pubblicare informazioni per ogni componente nell'ambiente.

Nome	Tipo	Descrizione
sparkLibraries	SparkLibraries	Le librerie Spark pubblicano informazioni.
sparkSettings	SparkSettings	Le impostazioni di Spark pubblicano informazioni.

Environment

Object

Elemento Environment.

Nome	Tipo	Descrizione
description	string	Descrizione dell'elemento.
displayName	string	Nome visualizzato dell'elemento.
id	string uuid	ID elemento.
properties	EnvironmentPublishInfo	Proprietà dell'ambiente.
type	ItemType	Tipo di elemento.
workspaceId	string uuid	ID dell'area di lavoro.

EnvironmentPublishInfo

Object

Informazioni sulla pubblicazione dell'ambiente.

Nome	Tipo	Descrizione
publishDetails	PublishDetails	Dettagli dell'operazione di pubblicazione dell'ambiente.

EnvironmentPublishState

Enumeration

Stato di pubblicazione. È possibile aggiungere altri tipi di stato nel tempo.

Valore	Descrizione
Cancelled	La pubblicazione dell'ambiente è in stato annullato.
Cancelling	La pubblicazione dell'ambiente è in stato di annullamento.
Failed	Lo stato di pubblicazione dell'ambiente non è riuscito.
Running	La pubblicazione dell'ambiente è in esecuzione.
Success	La pubblicazione dell'ambiente è in stato di esito positivo.
Waiting	La pubblicazione dell'ambiente è in stato di attesa.

Environments

Object

Elenco di ambienti.

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.
value	Environment[]	Elenco di ambienti.

ErrorRelatedResource

Object

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

Object

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	ID della richiesta associata all'errore.

ErrorResponseDetails

Object

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.

ItemType

Enumeration

Tipo dell'elemento. È possibile aggiungere altri tipi di elemento nel tempo.

Valore	Descrizione
Dashboard	Dashboard di Power BI.
DataPipeline	Una pipeline di dati.
Datamart	Datamart di PowerBI.
Environment	Un ambiente.
Eventhouse	Una casa eventi.
Eventstream	Flusso di eventi.
GraphQLApi	API per l'elemento GraphQL.
KQLDashboard	Dashboard KQL.
KQLDatabase	Un database KQL.
KQLQueryset	Set di query KQL.
Lakehouse	Una lakehouse.
MLExperiment	Esperimento di Machine Learning.
MLModel	Modello di Machine Learning.
MirroredDatabase	Database con mirroring.
MirroredWarehouse	Magazzino con mirroring.
MountedDataFactory	Oggetto MountedDataFactory.
Notebook	Un notebook.
PaginatedReport	Report impaginato di Power BI.
Reflex	Un riflesso.
Report	Report di Power BI.
SQLDatabase	A SQLDatabase.
SQLEndpoint	Endpoint SQL.
SemanticModel	Modello semantico di PowerBI.
SparkJobDefinition	Definizione di processo Spark.
Warehouse	Un magazzino.

PublishDetails

Object

Dettagli dell'operazione di pubblicazione.

Nome	Tipo	Descrizione
componentPublishInfo	ComponentPublishInfo	Informazioni sulla pubblicazione dei componenti dell'ambiente.
endTime	string date-time	Ora di fine dell'operazione di pubblicazione.
startTime	string date-time	Ora di inizio dell'operazione di pubblicazione.
state	EnvironmentPublishState	Stato di pubblicazione. È possibile aggiungere altri tipi di stato nel tempo.
targetVersion	string uuid	Verifica di destinazione da pubblicare.

SparkLibraries

Object

Librerie Spark.

Nome	Tipo	Descrizione
state	EnvironmentPublishState	Stato di pubblicazione. È possibile aggiungere altri tipi di stato nel tempo.

SparkSettings

Object

Impostazioni di Spark.

Nome	Tipo	Descrizione
state	EnvironmentPublishState	Stato di pubblicazione. È possibile aggiungere altri tipi di stato nel tempo.

Condividi tramite

Items - List Environments

Autorizzazioni

Ambiti delegati obbligatori

Identità supportate da Microsoft Entra

Interfaccia

Parametri dell'URI

Risposte

Esempio

List environments in workspace example

Esempio di richiesta

Risposta di esempio

Definizioni

ComponentPublishInfo

Environment

EnvironmentPublishInfo

EnvironmentPublishState

Environments

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ItemType

PublishDetails

SparkLibraries

SparkSettings

Risorse aggiuntive