Jaa

Items - Get Environment

  • Viite
Palvelu:
Environment
Ohjelmointirajapinnan versio:
v1

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

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.
Other Status Codes

ErrorResponse

Yleiset virhekoodit:

  • UnknownError – Ilmeni virhe.

Esimerkit

Get Environment Item example

Mallipyyntö

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.
EnvironmentPublishInfo

Ympäristön julkaisutiedot.
EnvironmentPublishState

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

Virheeseen liittyvä resurssitieto-objekti.
ErrorResponse

Virhevastaus.
ErrorResponseDetails

Virheen vastauksen tiedot.
ItemType

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

Julkaisutoiminnon tiedot.
SparkLibraries

Spark-kirjastot.
SparkSettings

Spark-asetukset.

ComponentPublishInfo

Object

Julkaise ympäristön kunkin komponentin tiedot.

Nimi Tyyppi Description
sparkLibraries

SparkLibraries

Spark-kirjastot julkaisevat tietoja.
sparkSettings

SparkSettings

Spark-asetusten julkaisutiedot.

Environment

Object

Ympäristö-kohde.

Nimi Tyyppi Description
description

string

Kohteen kuvaus.
displayName

string

Kohteen näyttönimi.
id

string

uuid

Kohdetunnus.
properties

EnvironmentPublishInfo

Ympäristön ominaisuudet.
type

ItemType

Kohdetyyppi.
workspaceId

string

uuid

Työtilan tunnus.

EnvironmentPublishInfo

Object

Ympäristön julkaisutiedot.

Nimi Tyyppi Description
publishDetails

PublishDetails

Ympäristön julkaisutoiminnon tiedot.

EnvironmentPublishState

Luettelointi

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

Arvo Description
Cancelled

Ympäristön julkaiseminen on peruutettuna.
Cancelling

Ympäristön julkaisu on peruuttamassa tilaa.
Failed

Ympäristön julkaisu on epäonnistuneessa tilassa.
Running

Ympäristön julkaisu on käynnissä-tilassa.
Success

Ympäristön julkaiseminen on onnistumistilassa.
Waiting

Ympäristön julkaisu on odotustilassa.

ErrorRelatedResource

Object

Virheeseen liittyvä resurssitieto-objekti.

Nimi Tyyppi Description
resourceId

string

Virheestä liittyvä resurssitunnus.
resourceType

string

Virheestä liittyvän resurssin tyyppi.

ErrorResponse

Object

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

Object

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.

ItemType

Luettelointi

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

Arvo Description
Dashboard

Power BI -koontinäyttö.
DataPipeline

Tietoputki.
Datamart

PowerBI -tietomarssi.
Environment

Ympäristö.
Eventhouse

Tapahtumatalo.
Eventstream

Tapahtumavirta.
GraphQLApi

Ohjelmointirajapinta GraphQL-kohteelle.
KQLDashboard

KQL-koontinäyttö.
KQLDatabase

KQL-tietokanta.
KQLQueryset

KQL-kyselyjoukko.
Lakehouse

Tämä on lakehouse.
MLExperiment

Koneoppimisen kokeilu.
MLModel

Koneoppimismalli.
MirroredDatabase

Peilattu tietokanta.
MirroredWarehouse

Peilattu varasto.
MountedDataFactory

A MountedDataFactory.
Notebook

Muistikirja.
PaginatedReport

PowerBI:n sivutettu raportti.
Reflex

Refleksi.
Report

PowerBI -raportti.
SQLDatabase

A SQLDatabase.
SQLEndpoint

SQL-päätepiste.
SemanticModel

PowerBI:n semanttinen malli.
SparkJobDefinition

Spark-työn määritelmä.
Warehouse

Varasto.

PublishDetails

Object

Julkaisutoiminnon tiedot.

Nimi Tyyppi Description
componentPublishInfo

ComponentPublishInfo

Ympäristön osan julkaisutiedot.
endTime

string

date-time

Julkaisutoiminnon päättymisaika.
startTime

string

date-time

Julkaisutoiminnon alkamisaika.
state

EnvironmentPublishState

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

string

uuid

Target verion julkaistaan.

SparkLibraries

Object

Spark-kirjastot.

Nimi Tyyppi Description
state

EnvironmentPublishState

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

SparkSettings

Object

Spark-asetukset.

Nimi Tyyppi Description
state

EnvironmentPublishState

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