Items - Get Environment

Dienst:: Environment

API-Version:: v1

Gibt Eigenschaften der angegebenen Umgebung zurück.

Erlaubnisse

Der Aufrufer muss über Leseberechtigungen für die Umgebung verfügen.

Erforderliche delegierte Bereiche

Environment.Read.All oder Item.Read.All oder Environment.ReadWrite.All oder Item.ReadWrite.All

Microsoft Entra unterstützte Identitäten

Diese API unterstützt die in diesem Abschnitt aufgeführten Microsoft identities.

Identität	Unterstützen
Benutzer	Ja
Service Principal und Verwaltete Identitäten	Ja

Schnittstelle

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
environmentId	path	True	string (uuid)	Die Umgebungs-ID.
workspaceId	path	True	string (uuid)	Die Arbeitsbereichs-ID.

Antworten

Name Typ Beschreibung

200 OK

Name	Typ	Beschreibung
200 OK	Environment	Die Anforderung wurde erfolgreich abgeschlossen. Gibt das Environment -Objekt zurück.
429 Too Many Requests	ErrorResponse	Der Dienstratengrenzwert wurde überschritten. Der Server gibt einen `Retry-After` Header zurück, der in Sekunden angibt, wie lange der Client warten muss, bevor zusätzliche Anforderungen gesendet werden. Header Retry-After: integer
Other Status Codes	ErrorResponse	Häufige Fehlercodes: UnknownError – Ein Fehler ist aufgetreten.

Environment

Die Anforderung wurde erfolgreich abgeschlossen. Gibt das Environment -Objekt zurück.

429 Too Many Requests

ErrorResponse

Der Dienstratengrenzwert wurde überschritten. Der Server gibt einen Retry-After Header zurück, der in Sekunden angibt, wie lange der Client warten muss, bevor zusätzliche Anforderungen gesendet werden.

Header

Retry-After: integer

Other Status Codes

ErrorResponse

Häufige Fehlercodes:

UnknownError – Ein Fehler ist aufgetreten.

Beispiele

Get Environment Item example

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:: 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"
  }
}

Definitionen

Name	Beschreibung
ComponentPublishInfo	Veröffentlichen Sie Informationen für die einzelnen Komponenten in der Umgebung.
EntireTenantPrincipal	Stellt einen Mandantenprinzipal dar.
Environment	Ein Umgebungselement.
EnvironmentProperties	Umgebungseigenschaften.
EnvironmentPublishState	Veröffentlichungsstatus. Zusätzliche Statustypen können im Laufe der Zeit hinzugefügt werden.
ErrorRelatedResource	Das Fehlerbezogene Ressourcendetails-Objekt.
ErrorResponse	Die Fehlerantwort.
ErrorResponseDetails	Die Fehlerantwortdetails.
GroupDetails	Gruppieren Sie bestimmte Details. Gilt, wenn der Prinzipaltyp `Group`ist.
GroupPrincipal	Steht für eine Sicherheitsgruppe.
GroupType	Der Typ der Gruppe. Weitere Gruppentypen können im Laufe der Zeit hinzugefügt werden.
ItemTag	Stellt ein Tag dar, das auf ein Element angewendet wird.
ItemType	Der Typ des Elements. Zusätzliche Elementtypen können im Laufe der Zeit hinzugefügt werden.
PrincipalType	Der Typ des Prinzipals. Im Laufe der Zeit können zusätzliche Prinzipaltypen hinzugefügt werden.
PublishDetails	Details des Veröffentlichungsvorgangs.
SensitivityLabel	Stellt eine Vertraulichkeitsbezeichnung dar, die auf ein Element angewendet wird.
ServicePrincipalDetails	Spezifische Details des Dienstprinzipals. Gilt, wenn der Prinzipaltyp `ServicePrincipal`ist.
ServicePrincipalPrincipal	Stellt einen Microsoft Entra Dienstprinzipal dar.
ServicePrincipalProfileDetails	Dienstprinzipalprofildetails. Gilt, wenn der Prinzipaltyp `ServicePrincipalProfile`ist.
ServicePrincipalProfilePrincipal	Stellt ein Dienstprinzipalprofil dar.
SparkLibraries	Spark-Bibliotheken.
SparkSettings	Spark-Einstellungen.
UserDetails	Spezifische Details des Benutzerprinzipals. Gilt, wenn der Prinzipaltyp `User`ist.
UserPrincipal	Stellt einen Microsoft Entra Benutzerprinzipal dar.

ComponentPublishInfo

Objekt

Veröffentlichen Sie Informationen für die einzelnen Komponenten in der Umgebung.

Name	Typ	Beschreibung
sparkLibraries	SparkLibraries	Spark-Bibliotheken veröffentlichen Informationen.
sparkSettings	SparkSettings	Spark-Einstellungen veröffentlichen Informationen.

EntireTenantPrincipal

Objekt

Stellt einen Mandantenprinzipal dar.

Name	Typ	Beschreibung
displayName	string	Der Anzeigename des Prinzipals.
id	string (uuid)	Die ID des Prinzipals.
type	string: EntireTenant	Der Typ des Prinzipals. Im Laufe der Zeit können zusätzliche Prinzipaltypen hinzugefügt werden.

Environment

Objekt

Ein Umgebungselement.

Name	Typ	Beschreibung
defaultIdentity	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	Die Standardidentität des Elements.
description	string	Die Elementbeschreibung.
displayName	string	Der Anzeigename des Elements.
folderId	string (uuid)	Die Ordner-ID.
id	string (uuid)	Die Element-ID.
properties	EnvironmentProperties	Die Umgebungseigenschaften.
sensitivityLabel	SensitivityLabel	Die Vertraulichkeitsbezeichnung des Elements.
tags	ItemTag[]	Liste der angewendeten Tags.
type	ItemType	Der Elementtyp.
workspaceId	string (uuid)	Die Arbeitsbereichs-ID.

EnvironmentProperties

Objekt

Umgebungseigenschaften.

Name	Typ	Beschreibung
publishDetails	PublishDetails	Details zum Veröffentlichen von Vorgängen in der Umgebung.

EnvironmentPublishState

Enumeration

Veröffentlichungsstatus. Zusätzliche Statustypen können im Laufe der Zeit hinzugefügt werden.

Wert	Beschreibung
Success	Die Veröffentlichung der Umgebung befindet sich im Erfolgszustand.
Cancelled	Die Veröffentlichung der Umgebung befindet sich im Zustand "Abgebrochen".
Failed	Die Veröffentlichung der Umgebung ist fehlgeschlagen.
Cancelling	Die Veröffentlichung der Umgebung befindet sich im Zustand "Abbrechen".
Running	Die Veröffentlichung der Umgebung befindet sich im Ausführungszustand.
Waiting	Die Veröffentlichung der Umgebung befindet sich im Wartezustand.

ErrorRelatedResource

Objekt

Das Fehlerbezogene Ressourcendetails-Objekt.

Name	Typ	Beschreibung
resourceId	string	Die Ressourcen-ID, die an dem Fehler beteiligt ist.
resourceType	string	Der Typ der Ressource, die an dem Fehler beteiligt ist.

ErrorResponse

Objekt

Die Fehlerantwort.

Name	Typ	Beschreibung
errorCode	string	Ein bestimmter Bezeichner, der Informationen über eine Fehlerbedingung bereitstellt und eine standardisierte Kommunikation zwischen unserem Dienst und seinen Benutzern ermöglicht.
message	string	Eine lesbare Darstellung des Fehlers.
moreDetails	ErrorResponseDetails[]	Liste der zusätzlichen Fehlerdetails.
relatedResource	ErrorRelatedResource	Die fehlerbezogenen Ressourcendetails.
requestId	string (uuid)	ID der Anforderung, die dem Fehler zugeordnet ist.

ErrorResponseDetails

Objekt

Die Fehlerantwortdetails.

Name	Typ	Beschreibung
errorCode	string	Ein bestimmter Bezeichner, der Informationen über eine Fehlerbedingung bereitstellt und eine standardisierte Kommunikation zwischen unserem Dienst und seinen Benutzern ermöglicht.
message	string	Eine lesbare Darstellung des Fehlers.
relatedResource	ErrorRelatedResource	Die fehlerbezogenen Ressourcendetails.

GroupDetails

Objekt

Gruppieren Sie bestimmte Details. Gilt, wenn der Prinzipaltyp Groupist.

Name	Typ	Beschreibung
groupType	GroupType	Der Typ der Gruppe. Weitere Gruppentypen können im Laufe der Zeit hinzugefügt werden.

GroupPrincipal

Objekt

Steht für eine Sicherheitsgruppe.

Name	Typ	Beschreibung
displayName	string	Der Anzeigename des Prinzipals.
groupDetails	GroupDetails	Gruppieren Sie bestimmte Details. Gilt, wenn der Prinzipaltyp `Group`ist.
id	string (uuid)	Die ID des Prinzipals.
type	string: Group	Der Typ des Prinzipals. Im Laufe der Zeit können zusätzliche Prinzipaltypen hinzugefügt werden.

GroupType

Enumeration

Der Typ der Gruppe. Weitere Gruppentypen können im Laufe der Zeit hinzugefügt werden.

Wert	Beschreibung
Unknown	Der Prinzipalgruppentyp ist unbekannt.
SecurityGroup	Prinzipal ist eine Sicherheitsgruppe.
DistributionList	Prinzipal ist eine Verteilerliste.

ItemTag

Objekt

Stellt ein Tag dar, das auf ein Element angewendet wird.

Name	Typ	Beschreibung
displayName	string	Der Name des Tags.
id	string (uuid)	Die Tag-ID.

ItemType

Enumeration

Der Typ des Elements. Zusätzliche Elementtypen können im Laufe der Zeit hinzugefügt werden.

Wert	Beschreibung
Dashboard	PowerBI-Dashboard.
Report	PowerBI-Bericht.
SemanticModel	PowerBI-Semantikmodell.
PaginatedReport	PowerBI-Paginated-Bericht.
Datamart	PowerBI datamart.
Lakehouse	Ein Seehaus.
Eventhouse	Ein Eventhouse.
Environment	Eine Umgebung.
KQLDatabase	Eine KQL-Datenbank.
KQLQueryset	Ein KQL-Abfrageset.
KQLDashboard	Ein KQL-Dashboard.
DataPipeline	Eine Datenpipeline.
Notebook	Ein Notizbuch.
SparkJobDefinition	Eine Sparkauftragsdefinition.
MLExperiment	Ein Machine Learning-Experiment.
MLModel	Ein Machine Learning-Modell.
Warehouse	Ein Lagerhaus.
Eventstream	Ein Ereignisstream.
SQLEndpoint	Ein SQL-Endpunkt.
MirroredWarehouse	Ein gespiegeltes Lager.
MirroredDatabase	Eine gespiegelte Datenbank.
Reflex	Ein Reflex.
GraphQLApi	Eine API für GraphQL-Element.
MountedDataFactory	Eine MountedDataFactory.
SQLDatabase	Eine SQLDatabase.
CopyJob	Ein Kopierauftrag.
VariableLibrary	Eine VariableLibrary.
Dataflow	Ein Datenfluss.
ApacheAirflowJob	Ein ApacheAirflowJob.
WarehouseSnapshot	Eine Warehouse-Momentaufnahme.
DigitalTwinBuilder	Ein DigitalTwinBuilder.
DigitalTwinBuilderFlow	Ein Digital Twin Builder Flow.
MirroredAzureDatabricksCatalog	Ein gespiegelter Azure Databricks-Katalog.
Map	Eine Karte.
AnomalyDetector	Anomaliedetektor.
UserDataFunction	Eine Benutzerdatenfunktion.
GraphModel	Ein GraphModel.
GraphQuerySet	Ein Graph QuerySet.
SnowflakeDatabase	Eine Snowflake-Datenbank zum Speichern von Iceberg-Tabellen, die aus dem Snowflake-Konto erstellt wurden.
OperationsAgent	Ein OperationsAgent.
CosmosDBDatabase	Eine Cosmos DB-Datenbank.
Ontology	Eine Ontologie.
EventSchemaSet	Ein EventSchemaSet.
DataAgent	Ein DataAgent.

PrincipalType

Enumeration

Der Typ des Prinzipals. Im Laufe der Zeit können zusätzliche Prinzipaltypen hinzugefügt werden.

Wert	Beschreibung
User	Prinzipal ist ein Microsoft Entra Benutzerprinzipal.
ServicePrincipal	Prinzipal ist ein Microsoft Entra Dienstprinzipal.
Group	Prinzipal ist eine Sicherheitsgruppe.
ServicePrincipalProfile	Prinzipal ist ein Dienstprinzipalprofil.
EntireTenant	Prinzipal stellt alle Mandantenbenutzer dar.

PublishDetails

Objekt

Details des Veröffentlichungsvorgangs.

Name	Typ	Beschreibung
componentPublishInfo	ComponentPublishInfo	Informationen zur Umgebungskomponente veröffentlichen.
endTime	string (date-time)	Endzeit des Veröffentlichungsvorgangs in UTC mit dem Format JJJJ-MM-DDTHH:mm:sssZ.
startTime	string (date-time)	Startzeit des Veröffentlichungsvorgangs in UTC mit dem Format JJJJ-MM-TTTHH:mm:sssZ.
state	EnvironmentPublishState	Veröffentlichungsstatus. Zusätzliche Statustypen können im Laufe der Zeit hinzugefügt werden.
targetVersion	string (uuid)	Zielverion, die veröffentlicht werden soll.

SensitivityLabel

Objekt

Stellt eine Vertraulichkeitsbezeichnung dar, die auf ein Element angewendet wird.

Name	Typ	Beschreibung
id	string (uuid)	Die Vertraulichkeitsbezeichnungs-ID.

ServicePrincipalDetails

Objekt

Spezifische Details des Dienstprinzipals. Gilt, wenn der Prinzipaltyp ServicePrincipalist.

Name	Typ	Beschreibung
aadAppId	string (uuid)	Die Microsoft Entra AppId des Dienstprinzipals.

ServicePrincipalPrincipal

Objekt

Stellt einen Microsoft Entra Dienstprinzipal dar.

Name	Typ	Beschreibung
displayName	string	Der Anzeigename des Prinzipals.
id	string (uuid)	Die ID des Prinzipals.
servicePrincipalDetails	ServicePrincipalDetails	Spezifische Details des Dienstprinzipals. Gilt, wenn der Prinzipaltyp `ServicePrincipal`ist.
type	string: ServicePrincipal	Der Typ des Prinzipals. Im Laufe der Zeit können zusätzliche Prinzipaltypen hinzugefügt werden.

ServicePrincipalProfileDetails

Objekt

Dienstprinzipalprofildetails. Gilt, wenn der Prinzipaltyp ServicePrincipalProfileist.

Name	Typ	Beschreibung
parentPrincipal	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	Der übergeordnete Prinzipal des Dienstprinzipals.

ServicePrincipalProfilePrincipal

Objekt

Stellt ein Dienstprinzipalprofil dar.

Name	Typ	Beschreibung
displayName	string	Der Anzeigename des Prinzipals.
id	string (uuid)	Die ID des Prinzipals.
servicePrincipalProfileDetails	ServicePrincipalProfileDetails	Dienstprinzipalprofildetails. Gilt, wenn der Prinzipaltyp `ServicePrincipalProfile`ist.
type	string: ServicePrincipalProfile	Der Typ des Prinzipals. Im Laufe der Zeit können zusätzliche Prinzipaltypen hinzugefügt werden.

SparkLibraries

Objekt

Spark-Bibliotheken.

Name	Typ	Beschreibung
state	EnvironmentPublishState	Veröffentlichungsstatus. Zusätzliche Statustypen können im Laufe der Zeit hinzugefügt werden.

SparkSettings

Objekt

Spark-Einstellungen.

Name	Typ	Beschreibung
state	EnvironmentPublishState	Veröffentlichungsstatus. Zusätzliche Statustypen können im Laufe der Zeit hinzugefügt werden.

UserDetails

Objekt

Spezifische Details des Benutzerprinzipals. Gilt, wenn der Prinzipaltyp Userist.

Name	Typ	Beschreibung
userPrincipalName	string	Der Benutzerprinzipalname.

UserPrincipal

Objekt

Stellt einen Microsoft Entra Benutzerprinzipal dar.

Name	Typ	Beschreibung
displayName	string	Der Anzeigename des Prinzipals.
id	string (uuid)	Die ID des Prinzipals.
type	string: User	Der Typ des Prinzipals. Im Laufe der Zeit können zusätzliche Prinzipaltypen hinzugefügt werden.
userDetails	UserDetails	Spezifische Details des Benutzerprinzipals. Gilt, wenn der Prinzipaltyp `User`ist.

Freigeben über

Items - Get Environment

Erlaubnisse

Erforderliche delegierte Bereiche

Microsoft Entra unterstützte Identitäten

Schnittstelle

URI-Parameter

Antworten

Beispiele

Get Environment Item example

Beispielanforderung

Beispiel für eine Antwort

Definitionen

ComponentPublishInfo

EntireTenantPrincipal

Environment

EnvironmentProperties

EnvironmentPublishState

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

GroupDetails

GroupPrincipal

GroupType

ItemTag

ItemType

PrincipalType

PublishDetails

SensitivityLabel

ServicePrincipalDetails

ServicePrincipalPrincipal

ServicePrincipalProfileDetails

ServicePrincipalProfilePrincipal

SparkLibraries

SparkSettings

UserDetails

UserPrincipal