Items - Get Environment

Palvelu:

Environment

Ohjelmointirajapinnan versio:

v1

Palauttaa määritetyn ympäristön ominaisuudet.

Käyttöoikeudet

Soittajalla on oltava ympäristön lukuoikeudet .

Vaaditut delegoidut vaikutusalueet

Environment.Read.All tai Item.Read.All tai Environment.ReadWrite.All tai Item.ReadWrite.All

Microsoft Entran tukemat käyttäjätiedot

Tämä ohjelmointirajapinta tukee tässä osiossa lueteltuja Microsoft -käyttäjätietoja.

Identiteetti	Tuki
Käyttäjä	Kyllä
palvelun päänimen ja Hallittujen käyttäjätietojen	Kyllä

Rajapinta

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

URI-parametrit

Nimi	Kohteessa	Pakollinen	Tyyppi	Description
environmentId	path	True	string (uuid)	Ympäristötunnus.
workspaceId	path	True	string (uuid)	Työtilan tunnus.

Vastaukset

Nimi	Tyyppi	Description
200 OK	Environment	Pyynnön valmistuttua. Palauttaa Ympäristö-objektin.
Other Status Codes	ErrorResponse	Yleiset virhekoodit: UnknownError – Ilmeni virhe.

Esimerkit

Get Environment Item example

Mallipyyntö

HTTP

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

Mallivastaus

Tilakoodi:

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

Määritelmät

Nimi	Description
ComponentPublishInfo	Julkaise ympäristön kunkin komponentin tiedot.
Environment	Ympäristö-kohde.
EnvironmentProperties	Ympäristön ominaisuudet.
EnvironmentPublishState	Julkaisutila. Muita tilatyyppejä voidaan lisätä ajan kuluessa.
ErrorRelatedResource	Virheeseen liittyvä resurssitieto-objekti.
ErrorResponse	Virhevastaus.
ErrorResponseDetails	Virheen vastauksen tiedot.
ItemTag	Edustaa kohteelle käytettyä tunnistetta.
ItemType	Kohteen tyyppi. Muita kohdetyyppejä voidaan lisätä ajan kuluessa.
PublishDetails	Julkaisutoiminnon tiedot.
SparkLibraries	Spark-kirjastot.
SparkSettings	Spark-asetukset.

ComponentPublishInfo

Kohde

Julkaise ympäristön kunkin komponentin tiedot.

Nimi	Tyyppi	Description
sparkLibraries	SparkLibraries	Spark-kirjastot julkaisevat tietoja.
sparkSettings	SparkSettings	Spark-asetusten julkaisutiedot.

Environment

Kohde

Ympäristö-kohde.

Nimi	Tyyppi	Description
description	string	Kohteen kuvaus.
displayName	string	Kohteen näyttönimi.
folderId	string (uuid)	Kansion tunnus.
id	string (uuid)	Kohdetunnus.
properties	EnvironmentProperties	Ympäristön ominaisuudet.
tags	ItemTag[]	Luettelo käytössä olevista tunnisteista.
type	ItemType	Kohdetyyppi.
workspaceId	string (uuid)	Työtilan tunnus.

EnvironmentProperties

Kohde

Ympäristön ominaisuudet.

Nimi	Tyyppi	Description
publishDetails	PublishDetails	Ympäristön julkaisutoiminnon tiedot.

EnvironmentPublishState

Luettelointi

Julkaisutila. Muita tilatyyppejä voidaan lisätä ajan kuluessa.

Arvo	Description
Success	Ympäristön julkaiseminen on onnistumistilassa.
Cancelled	Ympäristön julkaiseminen on peruutettuna.
Failed	Ympäristön julkaisu on epäonnistuneessa tilassa.
Cancelling	Ympäristön julkaisu on peruuttamassa tilaa.
Running	Ympäristön julkaisu on käynnissä-tilassa.
Waiting	Ympäristön julkaisu on odotustilassa.

ErrorRelatedResource

Kohde

Virheeseen liittyvä resurssitieto-objekti.

Nimi	Tyyppi	Description
resourceId	string	Virheestä liittyvä resurssitunnus.
resourceType	string	Virheestä liittyvän resurssin tyyppi.

ErrorResponse

Kohde

Virhevastaus.

Nimi	Tyyppi	Description
errorCode	string	Tietty tunniste, joka antaa tietoja virheehdosta ja mahdollistaa standardoidun tietoliikenteen palvelumme ja sen käyttäjien välillä.
message	string	Ihmisen luettavissa oleva esitys virheestä.
moreDetails	ErrorResponseDetails[]	Luettelo virheiden lisätiedoista.
relatedResource	ErrorRelatedResource	Virheisiin liittyvät resurssitiedot.
requestId	string	Virheeseen liittyvän pyynnön tunnus.

ErrorResponseDetails

Kohde

Virheen vastauksen tiedot.

Nimi	Tyyppi	Description
errorCode	string	Tietty tunniste, joka antaa tietoja virheehdosta ja mahdollistaa standardoidun tietoliikenteen palvelumme ja sen käyttäjien välillä.
message	string	Ihmisen luettavissa oleva esitys virheestä.
relatedResource	ErrorRelatedResource	Virheisiin liittyvät resurssitiedot.

ItemTag

Kohde

Edustaa kohteelle käytettyä tunnistetta.

Nimi	Tyyppi	Description
displayName	string	Tunnisteen nimi.
id	string (uuid)	Tunnisteen tunnus.

ItemType

Luettelointi

Kohteen tyyppi. Muita kohdetyyppejä voidaan lisätä ajan kuluessa.

Arvo	Description
Dashboard	Power BI -koontinäyttö.
Report	PowerBI -raportti.
SemanticModel	PowerBI:n semanttinen malli.
PaginatedReport	PowerBI:n sivutettu raportti.
Datamart	PowerBI -tietomarssi.
Lakehouse	Tämä on lakehouse.
Eventhouse	Tapahtumatalo.
Environment	Ympäristö.
KQLDatabase	KQL-tietokanta.
KQLQueryset	KQL-kyselyjoukko.
KQLDashboard	KQL-koontinäyttö.
DataPipeline	Tietoputki.
Notebook	Muistikirja.
SparkJobDefinition	Spark-työn määritelmä.
MLExperiment	Koneoppimisen kokeilu.
MLModel	Koneoppimismalli.
Warehouse	Varasto.
Eventstream	Tapahtumavirta.
SQLEndpoint	SQL-päätepiste.
MirroredWarehouse	Peilattu varasto.
MirroredDatabase	Peilattu tietokanta.
Reflex	Refleksi.
GraphQLApi	Ohjelmointirajapinta GraphQL-kohteelle.
MountedDataFactory	A MountedDataFactory.
SQLDatabase	A SQLDatabase.
CopyJob	Kopiotyö.
VariableLibrary	MuuttujaLibrary.
Dataflow	Tietovuo.
ApacheAirflowJob	An ApacheAirflowJob.
WarehouseSnapshot	Varastotilannevedos.
DigitalTwinBuilder	A DigitalTwinBuilder.
DigitalTwinBuilderFlow	Digital Twin Builder -työnkulku.
MirroredAzureDatabricksCatalog	Peilattu Azure Databricks -luettelo.
Map	Kartta.
AnomalyDetector	Poikkeamien tunnistaminen.
UserDataFunction	Käyttäjätietofunktio.
GraphModel	A GraphModel.
GraphQuerySet	A Graph QuerySet.
SnowflakeDatabase	Snowflake-tietokannalla tallennetaan Snowflake-tililtä luodut Iceberg-taulukot.
OperationsAgent	A OperationsAgent.
CosmosDBDatabase	Cosmos DB -tietokanta.
Ontology	Ontologia.
EventSchemaSet	An EventSchemaSet.

PublishDetails

Kohde

Julkaisutoiminnon tiedot.

Nimi	Tyyppi	Description
componentPublishInfo	ComponentPublishInfo	Ympäristön osan julkaisutiedot.
endTime	string (date-time)	Julkaisutoiminnon päättymisaika UTC-muodossa VVVV-KK-PPTHH:mm:ss.ssssssZ.
startTime	string (date-time)	Julkaisutoiminnon alkamisaika UTC-muodossa VVVV-KK-PPTHH:mm:ss.ssssssZ.
state	EnvironmentPublishState	Julkaisutila. Muita tilatyyppejä voidaan lisätä ajan kuluessa.
targetVersion	string (uuid)	Target verion julkaistaan.

SparkLibraries

Kohde

Spark-kirjastot.

Nimi	Tyyppi	Description
state	EnvironmentPublishState	Julkaisutila. Muita tilatyyppejä voidaan lisätä ajan kuluessa.

SparkSettings

Kohde

Spark-asetukset.

Nimi	Tyyppi	Description
state	EnvironmentPublishState	Julkaisutila. Muita tilatyyppejä voidaan lisätä ajan kuluessa.