Items - Get Environment

Tjeneste:

Environment

API-version:

v1

Returnerer egenskaberne for det angivne miljø.

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 -identiteter, der 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	Environment	Anmodningen blev fuldført.
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"
        }
      }
    }
  }
}

Definitioner

Name	Beskrivelse
ComponentPublishInfo	Publicer oplysninger om de enkelte komponenter i miljøet.
Environment	Et miljøelement.
EnvironmentPublishInfo	Publicer miljøoplysninger.
EnvironmentPublishState	Publicer tilstand. Der kan tilføjes flere tilstandstyper over tid.
ErrorRelatedResource	Objektet med fejlrelaterede ressourceoplysninger.
ErrorResponse	Fejlsvaret.
ErrorResponseDetails	Oplysninger om fejlsvar.
ItemType	Elementets type. Der kan tilføjes flere elementtyper over tid.
PublishDetails	Oplysninger om publiceringshandlingen.
SparkLibraries	Spark-biblioteker.
SparkSettings	Spark-indstillinger.

ComponentPublishInfo

Object

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.

Environment

Object

Et miljøelement.

Name	Type	Beskrivelse
description	string	Elementbeskrivelsen.
displayName	string	Det viste elementnavn.
id	string uuid	Element-id'et.
properties	EnvironmentPublishInfo	Miljøegenskaberne.
type	ItemType	Elementtypen.
workspaceId	string uuid	Arbejdsområde-id'et.

EnvironmentPublishInfo

Object

Publicer miljøoplysninger.

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
Cancelled	Publicering af miljøet er i annulleret tilstand.
Cancelling	Publicering af miljø er i annulleringstilstand.
Failed	Publiceringen af miljøet er i mislykket tilstand.
Running	Publicering af miljø er i kørselstilstand.
Success	Publicering af miljø er i succestilstand.
Waiting	Publicering af miljø er i ventetilstand.

ErrorRelatedResource

Object

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

Object

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	Id'et for den anmodning, der er knyttet til fejlen.

ErrorResponseDetails

Object

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.

ItemType

Optælling

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

Værdi	Beskrivelse
Dashboard	PowerBI-dashboard.
DataPipeline	En datapipeline.
Datamart	PowerBI-datamart.
Environment	Et miljø.
Eventhouse	Et eventhouse.
Eventstream	En hændelsesstream.
GraphQLApi	En API til GraphQL-element.
KQLDashboard	Et KQL-dashboard.
KQLDatabase	En KQL-database.
KQLQueryset	Et KQL-forespørgselssæt.
Lakehouse	Et søhus.
MLExperiment	Et maskinel indlæringseksperiment.
MLModel	En model til maskinel indlæring.
MirroredDatabase	En spejlet database.
MirroredWarehouse	Et spejlvendt lager.
MountedDataFactory	En MountedDataFactory.
Notebook	En notesbog.
PaginatedReport	Sideinddelt PowerBI-rapport.
Reflex	En refleks.
Report	PowerBI-rapport.
SQLDatabase	En SQLDatabase.
SQLEndpoint	Et SQL-slutpunkt.
SemanticModel	Semantisk PowerBI-model.
SparkJobDefinition	En spark jobdefinition.
Warehouse	Et lager.

PublishDetails

Object

Oplysninger om publiceringshandlingen.

Name	Type	Beskrivelse
componentPublishInfo	ComponentPublishInfo	Publicer oplysninger om miljøkomponent.
endTime	string date-time	Sluttidspunktet for publiceringshandlingen.
startTime	string date-time	Starttidspunktet for publiceringshandlingen.
state	EnvironmentPublishState	Publicer tilstand. Der kan tilføjes flere tilstandstyper over tid.
targetVersion	string uuid	Målversion, der skal publiceres.

SparkLibraries

Object

Spark-biblioteker.

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

SparkSettings

Object

Spark-indstillinger.

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