Items - Get Environment

Tjeneste:: Environment

API-versjon:: v1

Returnerer egenskaper for det angitte miljøet.

Tillatelser

Innringeren må ha lesetillatelser for miljøet.

Nødvendige delegerte omfang

Environment.Read.All eller Item.Read.All eller Environment.ReadWrite.All eller Item.ReadWrite.All

Microsoft Entra støttede identiteter

Denne API-en støtter Microsoft identiteter oppført i denne delen.

Identitet	Støtte
Bruker	Ja
tjenestekontohaver og administrerte identiteter	Ja

Grensesnitt

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

URI-parametere

Navn	I	Obligatorisk	Type	Beskrivelse
environmentId	path	True	string (uuid)	Miljø-ID-en.
workspaceId	path	True	string (uuid)	Arbeidsområde-ID-en.

Svar

Navn Type Beskrivelse

200 OK

Navn	Type	Beskrivelse
200 OK	Environment	Forespørselen er fullført. Returnerer miljøobjekt.
429 Too Many Requests	ErrorResponse	Grensen for tjenestesats ble overskredet. Serveren returnerer en `Retry-After` topptekst som angir, i sekunder, hvor lenge klienten må vente før du sender flere forespørsler. Overskrifter Retry-After: integer
Other Status Codes	ErrorResponse	Vanlige feilkoder: UnknownError - Det oppstod en feil.

Environment

Forespørselen er fullført. Returnerer miljøobjekt.

429 Too Many Requests

ErrorResponse

Grensen for tjenestesats ble overskredet. Serveren returnerer en Retry-After topptekst som angir, i sekunder, hvor lenge klienten må vente før du sender flere forespørsler.

Overskrifter

Retry-After: integer

Other Status Codes

ErrorResponse

Vanlige feilkoder:

UnknownError - Det oppstod en feil.

Eksempler

Get Environment Item example

Eksempelforespørsel

HTTP

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

Eksempelsvar

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

Definisjoner

Navn	Beskrivelse
ComponentPublishInfo	Publiser informasjon for hver komponent i miljøet.
EntireTenantPrincipal	Representerer en leierkontohaver
Environment	Et miljøelement.
EnvironmentProperties	Miljøegenskaper.
EnvironmentPublishState	Publiser tilstand. Flere tilstandstyper kan legges til over tid.
ErrorRelatedResource	Objektet for feilrelaterte ressursdetaljer.
ErrorResponse	Feilsvaret.
ErrorResponseDetails	Feilsvardetaljene.
GroupDetails	Grupper bestemte detaljer. Gjelder når hovedtypen er `Group`.
GroupPrincipal	Representerer en sikkerhetsgruppe.
GroupType	Typen gruppe. Flere gruppetyper kan legges til over tid.
ItemTag	Representerer en kode som brukes på et element.
ItemType	Typen element. Flere elementtyper kan legges til over tid.
PrincipalType	Typen hovedstol. Flere hovedstoltyper kan legges til over tid.
PublishDetails	Detaljer om publiseringsoperasjon.
SensitivityLabel	Representerer en følsomhetsetikett som brukes på et element.
ServicePrincipalDetails	Spesifikke detaljer for tjenestekontohaver. Gjelder når hovedtypen er `ServicePrincipal`.
ServicePrincipalPrincipal	Representerer en Microsoft Entra tjenestekontohaver.
ServicePrincipalProfileDetails	Detaljer for tjenestekontohaverprofil. Gjelder når hovedtypen er `ServicePrincipalProfile`.
ServicePrincipalProfilePrincipal	Representerer en tjenestekontohaverprofil.
SparkLibraries	Spark-biblioteker.
SparkSettings	Spark-innstillinger.
UserDetails	Spesifikke detaljer for brukerkontohaver. Gjelder når hovedtypen er `User`.
UserPrincipal	Representerer en Microsoft Entra brukerkontohaver.

ComponentPublishInfo

Objekt

Publiser informasjon for hver komponent i miljøet.

Navn	Type	Beskrivelse
sparkLibraries	SparkLibraries	Spark-biblioteker publiserer informasjon.
sparkSettings	SparkSettings	Spark-innstillinger publiserer informasjon.

EntireTenantPrincipal

Objekt

Representerer en leierkontohaver

Navn	Type	Beskrivelse
displayName	string	Hovedkontohaverens visningsnavn.
id	string (uuid)	Hovedkontohaverens ID.
type	string: EntireTenant	Typen hovedstol. Flere hovedstoltyper kan legges til over tid.

Environment

Objekt

Et miljøelement.

Navn	Type	Beskrivelse
defaultIdentity	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	Elementets standardidentitet.
description	string	Elementbeskrivelsen.
displayName	string	Visningsnavnet for elementet.
folderId	string (uuid)	Mappe-ID-en.
id	string (uuid)	Element-ID-en.
properties	EnvironmentProperties	Miljøegenskapene.
sensitivityLabel	SensitivityLabel	Elementfølsomhetsetiketten.
tags	ItemTag[]	Liste over brukte merker.
type	ItemType	Elementtypen.
workspaceId	string (uuid)	Arbeidsområde-ID-en.

EnvironmentProperties

Objekt

Miljøegenskaper.

Navn	Type	Beskrivelse
publishDetails	PublishDetails	Detaljer for publisering av miljø.

EnvironmentPublishState

Opplisting

Publiser tilstand. Flere tilstandstyper kan legges til over tid.

Verdi	Beskrivelse
Success	Publisering av miljø er i vellykket tilstand.
Cancelled	Publisering av miljø er i avbrutt tilstand.
Failed	Publisering av miljø er i mislykket tilstand.
Cancelling	Publisering av miljø er i avbrytertilstand.
Running	Publisering av miljø er i kjørende tilstand.
Waiting	Publisering av miljø er i ventetilstand.

ErrorRelatedResource

Objekt

Objektet for feilrelaterte ressursdetaljer.

Navn	Type	Beskrivelse
resourceId	string	Ressurs-ID-en som er involvert i feilen.
resourceType	string	Typen ressurs som er involvert i feilen.

ErrorResponse

Objekt

Feilsvaret.

Navn	Type	Beskrivelse
errorCode	string	En bestemt identifikator som gir informasjon om en feilbetingelse, noe som gir standardisert kommunikasjon mellom tjenesten og brukerne.
message	string	En menneskelig lesbar representasjon av feilen.
moreDetails	ErrorResponseDetails[]	Liste over flere feildetaljer.
relatedResource	ErrorRelatedResource	Feilrelaterte ressursdetaljer.
requestId	string (uuid)	ID for forespørselen som er knyttet til feilen.

ErrorResponseDetails

Objekt

Feilsvardetaljene.

Navn	Type	Beskrivelse
errorCode	string	En bestemt identifikator som gir informasjon om en feilbetingelse, noe som gir standardisert kommunikasjon mellom tjenesten og brukerne.
message	string	En menneskelig lesbar representasjon av feilen.
relatedResource	ErrorRelatedResource	Feilrelaterte ressursdetaljer.

GroupDetails

Objekt

Grupper bestemte detaljer. Gjelder når hovedtypen er Group.

Navn	Type	Beskrivelse
groupType	GroupType	Typen gruppe. Flere gruppetyper kan legges til over tid.

GroupPrincipal

Objekt

Representerer en sikkerhetsgruppe.

Navn	Type	Beskrivelse
displayName	string	Hovedkontohaverens visningsnavn.
groupDetails	GroupDetails	Grupper bestemte detaljer. Gjelder når hovedtypen er `Group`.
id	string (uuid)	Hovedkontohaverens ID.
type	string: Group	Typen hovedstol. Flere hovedstoltyper kan legges til over tid.

GroupType

Opplisting

Typen gruppe. Flere gruppetyper kan legges til over tid.

Verdi	Beskrivelse
Unknown	Hovedgruppetypen er ukjent.
SecurityGroup	Hovedstol er en sikkerhetsgruppe.
DistributionList	Hovedstol er en distribusjonsliste.

ItemTag

Objekt

Representerer en kode som brukes på et element.

Navn	Type	Beskrivelse
displayName	string	Navnet på koden.
id	string (uuid)	Kode-ID-en.

ItemType

Opplisting

Typen element. Flere elementtyper kan legges til over tid.

Verdi	Beskrivelse
Dashboard	PowerBI-instrumentbord.
Report	PowerBI-rapport.
SemanticModel	Semantisk PowerBI-modell.
PaginatedReport	Paginert powerbi-rapport.
Datamart	PowerBI-datamart.
Lakehouse	Et innsjøhus.
Eventhouse	Et arrangementshus.
Environment	Et miljø.
KQLDatabase	En KQL-database.
KQLQueryset	Et KQL-spørringssett.
KQLDashboard	Et KQL-instrumentbord.
DataPipeline	Et datasamlebånd.
Notebook	En notatblokk.
SparkJobDefinition	En spark-jobbdefinisjon.
MLExperiment	Et maskinlæringseksperiment.
MLModel	En maskinlæringsmodell.
Warehouse	Et lager.
Eventstream	En hendelsesstrøm.
SQLEndpoint	Et SQL-endepunkt.
MirroredWarehouse	Et speilvendt lager.
MirroredDatabase	En speilvendt database.
Reflex	En refleks.
GraphQLApi	En API for GraphQL-element.
MountedDataFactory	En MountedDataFactory.
SQLDatabase	En SQLDatabase.
CopyJob	En kopieringsjobb.
VariableLibrary	En VariableLibrary.
Dataflow	En dataflyt.
ApacheAirflowJob	En ApacheAirflowJob.
WarehouseSnapshot	Et øyeblikksbilde av lageret.
DigitalTwinBuilder	En DigitalTwinBuilder.
DigitalTwinBuilderFlow	En digital Twin Builder-flyt.
MirroredAzureDatabricksCatalog	En speilet azure databricks-katalog.
Map	Et kart.
AnomalyDetector	En avviksdetektor.
UserDataFunction	En brukerdatafunksjon.
GraphModel	En GraphModel.
GraphQuerySet	Et graph QuerySet.
SnowflakeDatabase	En Snowflake Database for å lagre Iceberg-tabeller opprettet fra Snowflake-kontoen.
OperationsAgent	En OperationsAgent.
CosmosDBDatabase	En Cosmos DB-database.
Ontology	En ontologi.
EventSchemaSet	En EventSchemaset.
DataAgent	En DataAgent.

PrincipalType

Opplisting

Typen hovedstol. Flere hovedstoltyper kan legges til over tid.

Verdi	Beskrivelse
User	Hovedstol er en Microsoft Entra brukerkontohaver.
ServicePrincipal	Principal er en Microsoft Entra tjenestekontohaver.
Group	Hovedstol er en sikkerhetsgruppe.
ServicePrincipalProfile	Principal er en tjenestekontohaverprofil.
EntireTenant	Hovedstol representerer alle leierbrukere.

PublishDetails

Objekt

Detaljer om publiseringsoperasjon.

Navn	Type	Beskrivelse
componentPublishInfo	ComponentPublishInfo	Informasjon om miljøkomponenten publiserer.
endTime	string (date-time)	Sluttidspunktet for publiseringsoperasjonen i UTC ved hjelp av formatet ÅÅÅÅÅ-MM-DDTHH:mm:ss.sssssssZ.
startTime	string (date-time)	Starttidspunktet for publiseringsoperasjonen i UTC ved hjelp av YYYY-MM-DDTHH:mm:ss.ssssssssZ-formatet.
state	EnvironmentPublishState	Publiser tilstand. Flere tilstandstyper kan legges til over tid.
targetVersion	string (uuid)	Mål-verion som skal publiseres.

SensitivityLabel

Objekt

Representerer en følsomhetsetikett som brukes på et element.

Navn	Type	Beskrivelse
id	string (uuid)	Følsomhetsetikett-ID-en.

ServicePrincipalDetails

Objekt

Spesifikke detaljer for tjenestekontohaver. Gjelder når hovedtypen er ServicePrincipal.

Navn	Type	Beskrivelse
aadAppId	string (uuid)	Tjenestekontohaverens Microsoft Entra AppId.

ServicePrincipalPrincipal

Objekt

Representerer en Microsoft Entra tjenestekontohaver.

Navn	Type	Beskrivelse
displayName	string	Hovedkontohaverens visningsnavn.
id	string (uuid)	Hovedkontohaverens ID.
servicePrincipalDetails	ServicePrincipalDetails	Spesifikke detaljer for tjenestekontohaver. Gjelder når hovedtypen er `ServicePrincipal`.
type	string: ServicePrincipal	Typen hovedstol. Flere hovedstoltyper kan legges til over tid.

ServicePrincipalProfileDetails

Objekt

Detaljer for tjenestekontohaverprofil. Gjelder når hovedtypen er ServicePrincipalProfile.

Navn	Type	Beskrivelse
parentPrincipal	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	Overordnet hovedkontohaver for tjenestekontohaverprofilen.

ServicePrincipalProfilePrincipal

Objekt

Representerer en tjenestekontohaverprofil.

Navn	Type	Beskrivelse
displayName	string	Hovedkontohaverens visningsnavn.
id	string (uuid)	Hovedkontohaverens ID.
servicePrincipalProfileDetails	ServicePrincipalProfileDetails	Detaljer for tjenestekontohaverprofil. Gjelder når hovedtypen er `ServicePrincipalProfile`.
type	string: ServicePrincipalProfile	Typen hovedstol. Flere hovedstoltyper kan legges til over tid.

SparkLibraries

Objekt

Spark-biblioteker.

Navn	Type	Beskrivelse
state	EnvironmentPublishState	Publiser tilstand. Flere tilstandstyper kan legges til over tid.

SparkSettings

Objekt

Spark-innstillinger.

Navn	Type	Beskrivelse
state	EnvironmentPublishState	Publiser tilstand. Flere tilstandstyper kan legges til over tid.

UserDetails

Objekt

Spesifikke detaljer for brukerkontohaver. Gjelder når hovedtypen er User.

Navn	Type	Beskrivelse
userPrincipalName	string	Brukerhovednavn.

UserPrincipal

Objekt

Representerer en Microsoft Entra brukerkontohaver.

Navn	Type	Beskrivelse
displayName	string	Hovedkontohaverens visningsnavn.
id	string (uuid)	Hovedkontohaverens ID.
type	string: User	Typen hovedstol. Flere hovedstoltyper kan legges til over tid.
userDetails	UserDetails	Spesifikke detaljer for brukerkontohaver. Gjelder når hovedtypen er `User`.

Del via

Items - Get Environment

Tillatelser

Nødvendige delegerte omfang

Microsoft Entra støttede identiteter

Grensesnitt

URI-parametere

Svar

Eksempler

Get Environment Item example

Eksempelforespørsel

Eksempelsvar

Definisjoner

ComponentPublishInfo

EntireTenantPrincipal

Environment

EnvironmentProperties

EnvironmentPublishState

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

GroupDetails

GroupPrincipal

GroupType

ItemTag

ItemType

PrincipalType

PublishDetails

SensitivityLabel

ServicePrincipalDetails

ServicePrincipalPrincipal

ServicePrincipalProfileDetails

ServicePrincipalProfilePrincipal

SparkLibraries

SparkSettings

UserDetails

UserPrincipal