Items - Get Environment

Tjeneste:: Environment

API-version:: v1

Returnerer egenskaberne for det angivne miljø.

Tilladelser

Den, der ringer op, skal have læserettigheder til miljøet.

Påkrævede delegerede områder

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

Microsoft Entra understøttede identiteter

Denne API understøtter de Microsoft identities, der er angivet i dette afsnit.

Identitet	Støtte
Bruger	Ja
tjenesteprincipal og administrerede identiteter	Ja

Grænseflade

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

URI-parametre

Name	I	Påkrævet	Type	Beskrivelse
environmentId	path	True	string (uuid)	Miljø-id'et.
workspaceId	path	True	string (uuid)	Arbejdsområde-id'et.

Svar

Name Type Beskrivelse

200 OK

Name	Type	Beskrivelse
200 OK	Environment	Anmodningen blev fuldført. Returnerer objektet Environment.
429 Too Many Requests	ErrorResponse	Grænsen for tjenestetakst blev overskredet. Serveren returnerer en `Retry-After` header, der angiver, i sekunder, hvor længe klienten skal vente, før der sendes yderligere anmodninger. Headere Retry-After: integer
Other Status Codes	ErrorResponse	Almindelige fejlkoder: UnknownError – Der opstod en fejl.

Environment

Anmodningen blev fuldført. Returnerer objektet Environment.

429 Too Many Requests

ErrorResponse

Grænsen for tjenestetakst blev overskredet. Serveren returnerer en Retry-After header, der angiver, i sekunder, hvor længe klienten skal vente, før der sendes yderligere anmodninger.

Headere

Retry-After: integer

Other Status Codes

ErrorResponse

Almindelige fejlkoder:

UnknownError – Der opstod en fejl.

Eksempler

Get Environment Item example

Eksempelanmodning

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

Definitioner

Name	Beskrivelse
ComponentPublishInfo	Publicer oplysninger om de enkelte komponenter i miljøet.
EntireTenantPrincipal	Repræsenterer en lejerprincipal
Environment	Et miljøelement.
EnvironmentProperties	Miljøegenskaber.
EnvironmentPublishState	Publicer tilstand. Der kan tilføjes flere tilstandstyper over tid.
ErrorRelatedResource	Objektet med fejlrelaterede ressourceoplysninger.
ErrorResponse	Fejlsvaret.
ErrorResponseDetails	Oplysninger om fejlsvar.
GroupDetails	Gruppér specifikke oplysninger. Gælder, når hovedtypen er `Group`.
GroupPrincipal	Repræsenterer en sikkerhedsgruppe.
GroupType	Gruppens type. Der kan tilføjes flere gruppetyper over tid.
ItemTag	Repræsenterer et mærke, der er anvendt på et element.
ItemType	Elementets type. Der kan tilføjes flere elementtyper over tid.
PrincipalType	Typen af hovedprincipal. Der kan tilføjes flere hovedtyper over tid.
PublishDetails	Oplysninger om publiceringshandlingen.
SensitivityLabel	Repræsenterer en følsomhedsmærkat, der er anvendt på et element.
ServicePrincipalDetails	Specifikke oplysninger om tjenesteprincipal. Gælder, når hovedtypen er `ServicePrincipal`.
ServicePrincipalPrincipal	Repræsenterer en Microsoft Entra tjenesteprincipal.
ServicePrincipalProfileDetails	Profiloplysninger for tjenesteprincipal. Gælder, når hovedtypen er `ServicePrincipalProfile`.
ServicePrincipalProfilePrincipal	Repræsenterer en tjenesteprincipalprofil.
SparkLibraries	Spark-biblioteker.
SparkSettings	Spark-indstillinger.
UserDetails	Specifikke oplysninger om brugerens hovedprincipal. Gælder, når hovedtypen er `User`.
UserPrincipal	Repræsenterer en Microsoft Entra brugerprincipal.

ComponentPublishInfo

Objekt

Publicer oplysninger om de enkelte komponenter i miljøet.

Name	Type	Beskrivelse
sparkLibraries	SparkLibraries	Oplysninger om udgivelse af Spark-biblioteker.
sparkSettings	SparkSettings	Oplysninger om udgivelse af Spark-indstillinger.

EntireTenantPrincipal

Objekt

Repræsenterer en lejerprincipal

Name	Type	Beskrivelse
displayName	string	Hovedprincipalens viste navn.
id	string (uuid)	Hovedprincipalens id.
type	string: EntireTenant	Typen af hovedprincipal. Der kan tilføjes flere hovedtyper over tid.

Environment

Objekt

Et miljøelement.

Name	Type	Beskrivelse
defaultIdentity	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	Elementets standardidentitet.
description	string	Elementbeskrivelsen.
displayName	string	Det viste elementnavn.
folderId	string (uuid)	Mappe-id'et.
id	string (uuid)	Element-id'et.
properties	EnvironmentProperties	Miljøegenskaberne.
sensitivityLabel	SensitivityLabel	Elementets følsomhedsmærkat.
tags	ItemTag[]	Liste over anvendte mærker.
type	ItemType	Elementtypen.
workspaceId	string (uuid)	Arbejdsområde-id'et.

EnvironmentProperties

Objekt

Miljøegenskaber.

Name	Type	Beskrivelse
publishDetails	PublishDetails	Oplysninger om publicering af miljøhandling.

EnvironmentPublishState

Optælling

Publicer tilstand. Der kan tilføjes flere tilstandstyper over tid.

Værdi	Beskrivelse
Success	Publicering af miljø er i succestilstand.
Cancelled	Publicering af miljøet er i annulleret tilstand.
Failed	Publiceringen af miljøet er i mislykket tilstand.
Cancelling	Publicering af miljø er i annulleringstilstand.
Running	Publicering af miljø er i kørselstilstand.
Waiting	Publicering af miljø er i ventetilstand.

ErrorRelatedResource

Objekt

Objektet med fejlrelaterede ressourceoplysninger.

Name	Type	Beskrivelse
resourceId	string	Det ressource-id, der er involveret i fejlen.
resourceType	string	Typen af ressource, der er involveret i fejlen.

ErrorResponse

Objekt

Fejlsvaret.

Name	Type	Beskrivelse
errorCode	string	Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.
message	string	En menneskelig læsbar gengivelse af fejlen.
moreDetails	ErrorResponseDetails[]	Liste over yderligere oplysninger om fejl.
relatedResource	ErrorRelatedResource	De fejlrelaterede ressourceoplysninger.
requestId	string (uuid)	Id'et for den anmodning, der er knyttet til fejlen.

ErrorResponseDetails

Objekt

Oplysninger om fejlsvar.

Name	Type	Beskrivelse
errorCode	string	Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.
message	string	En menneskelig læsbar gengivelse af fejlen.
relatedResource	ErrorRelatedResource	De fejlrelaterede ressourceoplysninger.

GroupDetails

Objekt

Gruppér specifikke oplysninger. Gælder, når hovedtypen er Group.

Name	Type	Beskrivelse
groupType	GroupType	Gruppens type. Der kan tilføjes flere gruppetyper over tid.

GroupPrincipal

Objekt

Repræsenterer en sikkerhedsgruppe.

Name	Type	Beskrivelse
displayName	string	Hovedprincipalens viste navn.
groupDetails	GroupDetails	Gruppér specifikke oplysninger. Gælder, når hovedtypen er `Group`.
id	string (uuid)	Hovedprincipalens id.
type	string: Group	Typen af hovedprincipal. Der kan tilføjes flere hovedtyper over tid.

GroupType

Optælling

Gruppens type. Der kan tilføjes flere gruppetyper over tid.

Værdi	Beskrivelse
Unknown	Hovedgruppetypen er ukendt.
SecurityGroup	Principal er en sikkerhedsgruppe.
DistributionList	Principal er en distributionsliste.

ItemTag

Objekt

Repræsenterer et mærke, der er anvendt på et element.

Name	Type	Beskrivelse
displayName	string	Navnet på mærket.
id	string (uuid)	Tag-id'et.

ItemType

Optælling

Elementets type. Der kan tilføjes flere elementtyper over tid.

Værdi	Beskrivelse
Dashboard	PowerBI-dashboard.
Report	PowerBI-rapport.
SemanticModel	Semantisk PowerBI-model.
PaginatedReport	Sideinddelt PowerBI-rapport.
Datamart	PowerBI-datamart.
Lakehouse	Et søhus.
Eventhouse	Et eventhouse.
Environment	Et miljø.
KQLDatabase	En KQL-database.
KQLQueryset	Et KQL-forespørgselssæt.
KQLDashboard	Et KQL-dashboard.
DataPipeline	En datapipeline.
Notebook	En notesbog.
SparkJobDefinition	En spark jobdefinition.
MLExperiment	Et maskinel indlæringseksperiment.
MLModel	En model til maskinel indlæring.
Warehouse	Et lager.
Eventstream	En hændelsesstream.
SQLEndpoint	Et SQL-slutpunkt.
MirroredWarehouse	Et spejlvendt lager.
MirroredDatabase	En spejlet database.
Reflex	En refleks.
GraphQLApi	En API til GraphQL-element.
MountedDataFactory	En MountedDataFactory.
SQLDatabase	En SQLDatabase.
CopyJob	Et kopijob.
VariableLibrary	En VariabelLibrary.
Dataflow	Et dataflow.
ApacheAirflowJob	En ApacheAirflowJob.
WarehouseSnapshot	Et lagersnapshot.
DigitalTwinBuilder	En DigitalTwinBuilder.
DigitalTwinBuilderFlow	Et Digital Twin Builder-flow.
MirroredAzureDatabricksCatalog	Et spejlet Azure Databricks-katalog.
Map	Et kort.
AnomalyDetector	En uregelmæssighedsregistrering.
UserDataFunction	En brugerdatafunktion.
GraphModel	En GraphModel.
GraphQuerySet	Et Graph QuerySet.
SnowflakeDatabase	En Snowflake-database til lagring af Iceberg-tabeller, der er oprettet fra Snowflake-konto.
OperationsAgent	En OperationsAgent.
CosmosDBDatabase	En Cosmos DB-database.
Ontology	En ontologi.
EventSchemaSet	Et EventSchemaSet.
DataAgent	En DataAgent.
MirroredCatalog	En MirroredCatalog.

PrincipalType

Optælling

Typen af hovedprincipal. Der kan tilføjes flere hovedtyper over tid.

Værdi	Beskrivelse
User	Principal er en Microsoft Entra brugerprincipal.
ServicePrincipal	Principal er en Microsoft Entra tjenesteprincipal.
Group	Principal er en sikkerhedsgruppe.
ServicePrincipalProfile	Principal er en tjenesteprincipalprofil.
EntireTenant	Principal repræsenterer alle lejerbrugere.

PublishDetails

Objekt

Oplysninger om publiceringshandlingen.

Name	Type	Beskrivelse
componentPublishInfo	ComponentPublishInfo	Publicer oplysninger om miljøkomponent.
endTime	string (date-time)	Sluttidspunktet for publiceringshandlingen i UTC ved hjælp af formatet YYYY-MM-DDTHH:mm:ss.ssssssZ.
startTime	string (date-time)	Starttidspunktet for publiceringshandlingen i UTC ved hjælp af formatet YYYY-MM-DDTHH:mm:ss.ssssssZ.
state	EnvironmentPublishState	Publicer tilstand. Der kan tilføjes flere tilstandstyper over tid.
targetVersion	string (uuid)	Målversion, der skal publiceres.

SensitivityLabel

Objekt

Repræsenterer en følsomhedsmærkat, der er anvendt på et element.

Name	Type	Beskrivelse
id	string (uuid)	Id'et for følsomhedsmærkaten.

ServicePrincipalDetails

Objekt

Specifikke oplysninger om tjenesteprincipal. Gælder, når hovedtypen er ServicePrincipal.

Name	Type	Beskrivelse
aadAppId	string (uuid)	Tjenesteprincipalens Microsoft Entra AppId.

ServicePrincipalPrincipal

Objekt

Repræsenterer en Microsoft Entra tjenesteprincipal.

Name	Type	Beskrivelse
displayName	string	Hovedprincipalens viste navn.
id	string (uuid)	Hovedprincipalens id.
servicePrincipalDetails	ServicePrincipalDetails	Specifikke oplysninger om tjenesteprincipal. Gælder, når hovedtypen er `ServicePrincipal`.
type	string: ServicePrincipal	Typen af hovedprincipal. Der kan tilføjes flere hovedtyper over tid.

ServicePrincipalProfileDetails

Objekt

Profiloplysninger for tjenesteprincipal. Gælder, når hovedtypen er ServicePrincipalProfile.

Name	Type	Beskrivelse
parentPrincipal	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	Profilen for tjenesteprincipalens overordnede hoved.

ServicePrincipalProfilePrincipal

Objekt

Repræsenterer en tjenesteprincipalprofil.

Name	Type	Beskrivelse
displayName	string	Hovedprincipalens viste navn.
id	string (uuid)	Hovedprincipalens id.
servicePrincipalProfileDetails	ServicePrincipalProfileDetails	Profiloplysninger for tjenesteprincipal. Gælder, når hovedtypen er `ServicePrincipalProfile`.
type	string: ServicePrincipalProfile	Typen af hovedprincipal. Der kan tilføjes flere hovedtyper over tid.

SparkLibraries

Objekt

Spark-biblioteker.

Name	Type	Beskrivelse
state	EnvironmentPublishState	Publicer tilstand. Der kan tilføjes flere tilstandstyper over tid.

SparkSettings

Objekt

Spark-indstillinger.

Name	Type	Beskrivelse
state	EnvironmentPublishState	Publicer tilstand. Der kan tilføjes flere tilstandstyper over tid.

UserDetails

Objekt

Specifikke oplysninger om brugerens hovedprincipal. Gælder, når hovedtypen er User.

Name	Type	Beskrivelse
userPrincipalName	string	Brugerens hovednavn.

UserPrincipal

Objekt

Repræsenterer en Microsoft Entra brugerprincipal.

Name	Type	Beskrivelse
displayName	string	Hovedprincipalens viste navn.
id	string (uuid)	Hovedprincipalens id.
type	string: User	Typen af hovedprincipal. Der kan tilføjes flere hovedtyper over tid.
userDetails	UserDetails	Specifikke oplysninger om brugerens hovedprincipal. Gælder, når hovedtypen er `User`.