Items - Get Environment

Servizio:: Environment

Versione API:: v1

Restituisce le proprietà dell'ambiente specificato.

Autorizzazioni

Il chiamante deve disporre delle autorizzazioni di lettura per l'ambiente.

Ambiti delegati obbligatori

Environment.Read.All o Item.Read.All o Environment.ReadWrite.All o Item.ReadWrite.All

Microsoft Entra identità supportate

Questa API supporta i Microsoft identities elencati in questa sezione.

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

Interfaccia

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
environmentId	path	True	string (uuid)	ID ambiente.
workspaceId	path	True	string (uuid)	ID dell'area di lavoro.

Risposte

Nome Tipo Descrizione

200 OK

Nome	Tipo	Descrizione
200 OK	Environment	Richiesta completata correttamente. Restituisce l'oggetto Environment.
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.

Environment

Richiesta completata correttamente. Restituisce l'oggetto Environment.

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 Environment Item example

Esempio di richiesta

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48/environments/41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87

Risposta di esempio

Codice di stato:: 200

{
  "displayName": "Environment_1",
  "description": "An Environment description",
  "type": "Environment",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715",
  "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"
        }
      }
    }
  },
  "sensitivityLabel": {
    "id": "b7b4f4d9-3f0d-4b3e-8f3d-4f6d3f4f3f4f"
  }
}

Definizioni

Nome	Descrizione
ComponentPublishInfo	Pubblicare informazioni per ogni componente nell'ambiente.
EntireTenantPrincipal	Rappresenta un'entità tenant
Environment	Elemento Environment.
EnvironmentProperties	Proprietà dell'ambiente.
EnvironmentPublishState	Stato di pubblicazione. È possibile aggiungere altri tipi di stato nel tempo.
ErrorRelatedResource	Oggetto dettagli risorsa correlato all'errore.
ErrorResponse	Risposta di errore.
ErrorResponseDetails	Dettagli della risposta di errore.
GroupDetails	Dettagli specifici del gruppo. Applicabile quando il tipo di entità è `Group`.
GroupPrincipal	Rappresenta un gruppo di sicurezza.
GroupType	Tipo del gruppo. È possibile aggiungere altri tipi di gruppo nel tempo.
ItemTag	Rappresenta un tag applicato a un elemento.
ItemType	Tipo dell'elemento. È possibile aggiungere altri tipi di elemento nel tempo.
PrincipalType	Tipo dell'entità. È possibile aggiungere altri tipi di entità nel tempo.
PublishDetails	Dettagli dell'operazione di pubblicazione.
SensitivityLabel	Rappresenta un'etichetta di riservatezza applicata a un elemento.
ServicePrincipalDetails	Dettagli specifici dell'entità servizio. Applicabile quando il tipo di entità è `ServicePrincipal`.
ServicePrincipalPrincipal	Rappresenta un'entità servizio Microsoft Entra.
ServicePrincipalProfileDetails	Dettagli del profilo dell'entità servizio. Applicabile quando il tipo di entità è `ServicePrincipalProfile`.
ServicePrincipalProfilePrincipal	Rappresenta un profilo dell'entità servizio.
SparkLibraries	Librerie Spark.
SparkSettings	Impostazioni di Spark.
UserDetails	Dettagli specifici dell'entità utente. Applicabile quando il tipo di entità è `User`.
UserPrincipal	Rappresenta un'entità utente Microsoft Entra.

ComponentPublishInfo

Oggetto

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.

EntireTenantPrincipal

Oggetto

Rappresenta un'entità tenant

Nome	Tipo	Descrizione
displayName	string	Nome visualizzato dell'entità.
id	string (uuid)	ID dell'entità.
type	string: EntireTenant	Tipo dell'entità. È possibile aggiungere altri tipi di entità nel tempo.

Environment

Oggetto

Elemento Environment.

Nome	Tipo	Descrizione
defaultIdentity	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	Identità predefinita dell'elemento.
description	string	Descrizione dell'elemento.
displayName	string	Nome visualizzato dell'elemento.
folderId	string (uuid)	ID cartella.
id	string (uuid)	ID elemento.
properties	EnvironmentProperties	Proprietà dell'ambiente.
sensitivityLabel	SensitivityLabel	Etichetta di riservatezza dell'elemento.
tags	ItemTag[]	Elenco di tag applicati.
type	ItemType	Tipo di elemento.
workspaceId	string (uuid)	ID dell'area di lavoro.

EnvironmentProperties

Oggetto

Proprietà dell'ambiente.

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

EnvironmentPublishState

Enumerazione

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

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

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.

GroupDetails

Oggetto

Dettagli specifici del gruppo. Applicabile quando il tipo di entità è Group.

Nome	Tipo	Descrizione
groupType	GroupType	Tipo del gruppo. È possibile aggiungere altri tipi di gruppo nel tempo.

GroupPrincipal

Oggetto

Rappresenta un gruppo di sicurezza.

Nome	Tipo	Descrizione
displayName	string	Nome visualizzato dell'entità.
groupDetails	GroupDetails	Dettagli specifici del gruppo. Applicabile quando il tipo di entità è `Group`.
id	string (uuid)	ID dell'entità.
type	string: Group	Tipo dell'entità. È possibile aggiungere altri tipi di entità nel tempo.

GroupType

Enumerazione

Tipo del gruppo. È possibile aggiungere altri tipi di gruppo nel tempo.

Valore	Descrizione
Unknown	Il tipo di gruppo principale è sconosciuto.
SecurityGroup	Principal è un gruppo di sicurezza.
DistributionList	Principal è una lista di distribuzione.

ItemTag

Oggetto

Rappresenta un tag applicato a un elemento.

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

ItemType

Enumerazione

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

Valore	Descrizione
Dashboard	Dashboard di Power BI.
Report	Report di Power BI.
SemanticModel	Modello semantico di PowerBI.
PaginatedReport	Report impaginato di Power BI.
Datamart	Datamart di PowerBI.
Lakehouse	Una lakehouse.
Eventhouse	Una casa eventi.
Environment	Un ambiente.
KQLDatabase	Un database KQL.
KQLQueryset	Set di query KQL.
KQLDashboard	Dashboard KQL.
DataPipeline	Una pipeline di dati.
Notebook	Un notebook.
SparkJobDefinition	Definizione di processo Spark.
MLExperiment	Esperimento di Machine Learning.
MLModel	Modello di Machine Learning.
Warehouse	Un magazzino.
Eventstream	Flusso di eventi.
SQLEndpoint	Endpoint SQL.
MirroredWarehouse	Magazzino con mirroring.
MirroredDatabase	Database con mirroring.
Reflex	Un riflesso.
GraphQLApi	API per l'elemento GraphQL.
MountedDataFactory	Oggetto MountedDataFactory.
SQLDatabase	A SQLDatabase.
CopyJob	Processo di copia.
VariableLibrary	VariabileLibrary.
Dataflow	Flusso di dati.
ApacheAirflowJob	An ApacheAirflowJob.
WarehouseSnapshot	Uno snapshot del warehouse.
DigitalTwinBuilder	A DigitalTwinBuilder.
DigitalTwinBuilderFlow	Flusso di Generatore di gemelli digitali.
MirroredAzureDatabricksCatalog	Catalogo di Azure databricks con mirroring.
Map	Una mappa.
AnomalyDetector	Rilevamento anomalie.
UserDataFunction	Funzione dati utente.
GraphModel	A GraphModel.
GraphQuerySet	Oggetto Graph QuerySet.
SnowflakeDatabase	Un database Snowflake per archiviare le tabelle Iceberg create dall'account Snowflake.
OperationsAgent	Oggetto OperationsAgent.
CosmosDBDatabase	Un database Cosmos DB.
Ontology	Ontologia.
EventSchemaSet	An EventSchemaSet.
DataAgent	Oggetto DataAgent.

PrincipalType

Enumerazione

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

Valore	Descrizione
User	Principal è un'entità utente Microsoft Entra.
ServicePrincipal	Principal è un'entità servizio Microsoft Entra.
Group	Principal è un gruppo di sicurezza.
ServicePrincipalProfile	Principal è un profilo dell'entità servizio.
EntireTenant	Principal rappresenta tutti gli utenti tenant.

PublishDetails

Oggetto

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 in formato UTC, utilizzando il formato YYYY-MM-DDTHH:mm:ss.ssZ.
startTime	string (date-time)	Ora di inizio dell'operazione di pubblicazione in formato UTC, usando il formato YYYY-MM-DDTHH:mm:ss.ssssZ.
state	EnvironmentPublishState	Stato di pubblicazione. È possibile aggiungere altri tipi di stato nel tempo.
targetVersion	string (uuid)	Verifica di destinazione da pubblicare.

SensitivityLabel

Oggetto

Rappresenta un'etichetta di riservatezza applicata a un elemento.

Nome	Tipo	Descrizione
id	string (uuid)	ID etichetta di riservatezza.

ServicePrincipalDetails

Oggetto

Dettagli specifici dell'entità servizio. Applicabile quando il tipo di entità è ServicePrincipal.

Nome	Tipo	Descrizione
aadAppId	string (uuid)	L'entità servizio Microsoft Entra AppId.

ServicePrincipalPrincipal

Oggetto

Rappresenta un'entità servizio Microsoft Entra.

Nome	Tipo	Descrizione
displayName	string	Nome visualizzato dell'entità.
id	string (uuid)	ID dell'entità.
servicePrincipalDetails	ServicePrincipalDetails	Dettagli specifici dell'entità servizio. Applicabile quando il tipo di entità è `ServicePrincipal`.
type	string: ServicePrincipal	Tipo dell'entità. È possibile aggiungere altri tipi di entità nel tempo.

ServicePrincipalProfileDetails

Oggetto

Dettagli del profilo dell'entità servizio. Applicabile quando il tipo di entità è ServicePrincipalProfile.

Nome	Tipo	Descrizione
parentPrincipal	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	Entità padre del profilo dell'entità servizio.

ServicePrincipalProfilePrincipal

Oggetto

Rappresenta un profilo dell'entità servizio.

Nome	Tipo	Descrizione
displayName	string	Nome visualizzato dell'entità.
id	string (uuid)	ID dell'entità.
servicePrincipalProfileDetails	ServicePrincipalProfileDetails	Dettagli del profilo dell'entità servizio. Applicabile quando il tipo di entità è `ServicePrincipalProfile`.
type	string: ServicePrincipalProfile	Tipo dell'entità. È possibile aggiungere altri tipi di entità nel tempo.

SparkLibraries

Oggetto

Librerie Spark.

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

SparkSettings

Oggetto

Impostazioni di Spark.

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

UserDetails

Oggetto

Dettagli specifici dell'entità utente. Applicabile quando il tipo di entità è User.

Nome	Tipo	Descrizione
userPrincipalName	string	Nome principale utente.

UserPrincipal

Oggetto

Rappresenta un'entità utente Microsoft Entra.

Nome	Tipo	Descrizione
displayName	string	Nome visualizzato dell'entità.
id	string (uuid)	ID dell'entità.
type	string: User	Tipo dell'entità. È possibile aggiungere altri tipi di entità nel tempo.
userDetails	UserDetails	Dettagli specifici dell'entità utente. Applicabile quando il tipo di entità è `User`.

Condividi tramite

Items - Get Environment

Autorizzazioni

Ambiti delegati obbligatori

Microsoft Entra identità supportate

Interfaccia

Parametri dell'URI

Risposte

Esempio

Get Environment Item example

Esempio di richiesta

Risposta di esempio

Definizioni

ComponentPublishInfo

EntireTenantPrincipal

Environment

EnvironmentProperties

EnvironmentPublishState

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

GroupDetails

GroupPrincipal

GroupType

ItemTag

ItemType

PrincipalType

PublishDetails

SensitivityLabel

ServicePrincipalDetails

ServicePrincipalPrincipal

ServicePrincipalProfileDetails

ServicePrincipalProfilePrincipal

SparkLibraries

SparkSettings

UserDetails

UserPrincipal