Del via

Items - List Environments

  • Referanse
Tjeneste:
Environment
API-versjon:
v1

Returnerer en liste over miljøer fra det angitte arbeidsområdet.
Denne API-en støtter paginering.

Tillatelser

Innringeren må ha visningsprogram eller høyere arbeidsområderolle.

Nødvendige delegerte omfang

Workspace.Read.All eller Workspace.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
Med valgfrie parametere: 
GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/environments?continuationToken={continuationToken}

URI-parametere

Navn I Obligatorisk Type Beskrivelse
workspaceId
 path True

string

uuid

Arbeidsområde-ID-en.
continuationToken
 query

string

Et token for å hente neste side med resultater.

Svar

Navn Type Beskrivelse
200 OK

Environments

Forespørselen er fullført.
Other Status Codes

ErrorResponse

Vanlige feilkoder:

  • InvalidItemType – ugyldig elementtype

Eksempler

List environments in workspace example

Eksempelforespørsel

GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/environments

Eksempelsvar

Statuskode:
200 
{
  "value": [
    {
      "id": "3546052c-ae64-4526-b1a8-52af7761426f",
      "displayName": "Environment_1",
      "description": "A environment description.",
      "type": "Environment",
      "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "properties": {
        "publishDetails": {
          "state": "Failed",
          "targetVersion": "14ece8b5-68a1-4130-a9e7-074c04537588",
          "startTime": "2024-03-30T14:17:09.0697022Z",
          "endTime": "2024-03-30T14:48:09.0697022Z",
          "componentPublishInfo": {
            "sparkLibraries": {
              "state": "Failed"
            },
            "sparkSettings": {
              "state": "Success"
            }
          }
        }
      }
    },
    {
      "id": "a8a1bffa-7eea-49dc-a1d2-6281c1d031f1",
      "displayName": "Environment_2",
      "description": "A environment description.",
      "type": "Environment",
      "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "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"
            }
          }
        }
      }
    }
  ]
}

Definisjoner

Navn Beskrivelse
ComponentPublishInfo

Publiser informasjon for hver komponent i miljøet.
Environment

Et miljøelement.
EnvironmentPublishInfo

Informasjon om publisering av miljø.
EnvironmentPublishState

Publiser tilstand. Flere tilstandstyper kan legges til over tid.
Environments

En liste over miljøer.
ErrorRelatedResource

Objektet for feilrelaterte ressursdetaljer.
ErrorResponse

Feilsvaret.
ErrorResponseDetails

Feilsvardetaljene.
ItemType

Typen element. Flere elementtyper kan legges til over tid.
PublishDetails

Detaljer om publiseringsoperasjon.
SparkLibraries

Spark-biblioteker.
SparkSettings

Spark-innstillinger.

ComponentPublishInfo

Object

Publiser informasjon for hver komponent i miljøet.

Navn Type Beskrivelse
sparkLibraries

SparkLibraries

Spark-biblioteker publiserer informasjon.
sparkSettings

SparkSettings

Spark-innstillinger publiserer informasjon.

Environment

Object

Et miljøelement.

Navn Type Beskrivelse
description

string

Elementbeskrivelsen.
displayName

string

Visningsnavnet for elementet.
id

string

uuid

Element-ID-en.
properties

EnvironmentPublishInfo

Miljøegenskapene.
type

ItemType

Elementtypen.
workspaceId

string

uuid

Arbeidsområde-ID-en.

EnvironmentPublishInfo

Object

Informasjon om publisering av miljø.

Navn Type Beskrivelse
publishDetails

PublishDetails

Detaljer for publisering av miljø.

EnvironmentPublishState

Opplisting

Publiser tilstand. Flere tilstandstyper kan legges til over tid.

Verdi Beskrivelse
Cancelled

Publisering av miljø er i avbrutt tilstand.
Cancelling

Publisering av miljø er i avbrytertilstand.
Failed

Publisering av miljø er i mislykket tilstand.
Running

Publisering av miljø er i kjørende tilstand.
Success

Publisering av miljø er i vellykket tilstand.
Waiting

Publisering av miljø er i ventetilstand.

Environments

Object

En liste over miljøer.

Navn Type Beskrivelse
continuationToken

string

Tokenet for den neste resultatsettgruppen. Hvis det ikke er flere poster, fjernes den fra svaret.
continuationUri

string

URI-en for neste satsvise resultatsett. Hvis det ikke er flere poster, fjernes den fra svaret.
value

Environment[]

En liste over miljøer.

ErrorRelatedResource

Object

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

Object

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

ID for forespørselen som er knyttet til feilen.

ErrorResponseDetails

Object

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.

ItemType

Opplisting

Typen element. Flere elementtyper kan legges til over tid.

Verdi Beskrivelse
Dashboard

PowerBI-instrumentbord.
DataPipeline

Et datasamlebånd.
Datamart

PowerBI-datamart.
Environment

Et miljø.
Eventhouse

Et arrangementshus.
Eventstream

En hendelsesstrøm.
GraphQLApi

En API for GraphQL-element.
KQLDashboard

Et KQL-instrumentbord.
KQLDatabase

En KQL-database.
KQLQueryset

Et KQL-spørringssett.
Lakehouse

Et innsjøhus.
MLExperiment

Et maskinlæringseksperiment.
MLModel

En maskinlæringsmodell.
MirroredDatabase

En speilvendt database.
MirroredWarehouse

Et speilvendt lager.
MountedDataFactory

En MountedDataFactory.
Notebook

En notatblokk.
PaginatedReport

Paginert powerbi-rapport.
Reflex

En refleks.
Report

PowerBI-rapport.
SQLDatabase

En SQLDatabase.
SQLEndpoint

Et SQL-endepunkt.
SemanticModel

Semantisk PowerBI-modell.
SparkJobDefinition

En spark-jobbdefinisjon.
Warehouse

Et lager.

PublishDetails

Object

Detaljer om publiseringsoperasjon.

Navn Type Beskrivelse
componentPublishInfo

ComponentPublishInfo

Informasjon om miljøkomponenten publiserer.
endTime

string

date-time

Sluttidspunkt for publiseringsoperasjonen.
startTime

string

date-time

Starttidspunktet for publiseringsoperasjonen.
state

EnvironmentPublishState

Publiser tilstand. Flere tilstandstyper kan legges til over tid.
targetVersion

string

uuid

Mål-verion som skal publiseres.

SparkLibraries

Object

Spark-biblioteker.

Navn Type Beskrivelse
state

EnvironmentPublishState

Publiser tilstand. Flere tilstandstyper kan legges til over tid.

SparkSettings

Object

Spark-innstillinger.

Navn Type Beskrivelse
state

EnvironmentPublishState

Publiser tilstand. Flere tilstandstyper kan legges til over tid.