Items - List Environments

Tjänst:: Environment

API-versionen:: v1

Returnerar en lista över miljöer från den angivna arbetsytan.
Det här API:et stöder sidnumrering.

Behörigheter

Anroparen måste ha en arbetsyteroll för visningsprogrammet .

Obligatoriska delegerade omfång

Workspace.Read.All eller Workspace.ReadWrite.All

Identiteter som stöds av Microsoft Entra

Det här API:et stöder Microsoft identiteter som anges i det här avsnittet.

Identitet	Stöd
Användare	Ja
Tjänstens huvudnamn och hanterade identiteter	Ja

Gränssnitt

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

Med valfria parametrar:

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/environments?continuationToken={continuationToken}

URI-parametrar

Namn	I	Krävs	Typ	Beskrivning
workspaceId	path	True	string (uuid)	Arbetsytans ID.
continuationToken	query		string	En token för att hämta nästa sida med resultat.

Svaren

Namn	Typ	Beskrivning
200 OK	Environments	Begäran har slutförts.
Other Status Codes	ErrorResponse	Vanliga felkoder: InvalidItemType – Ogiltig objekttyp

Namn

Typ

Beskrivning

200 OK

Environments

Begäran har slutförts.

Other Status Codes

ErrorResponse

Vanliga felkoder:

InvalidItemType – Ogiltig objekttyp

Exempel

List environments in workspace example

Exempelförfrågan

HTTP

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

Exempelsvar

Statuskod:: 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"
            }
          }
        }
      }
    }
  ]
}

Definitioner

Namn	Beskrivning
ComponentPublishInfo	Publicera information för varje komponenter i miljön.
Environment	Ett miljöobjekt.
EnvironmentProperties	Miljöegenskaper.
EnvironmentPublishState	Publiceringstillstånd. Ytterligare tillståndstyper kan läggas till över tid.
Environments	En lista över miljöer.
ErrorRelatedResource	Det felrelaterade resursinformationsobjektet.
ErrorResponse	Felsvaret.
ErrorResponseDetails	Information om felsvar.
ItemTag	Representerar en tagg som tillämpas på ett objekt.
ItemType	Typ av objekt. Ytterligare objekttyper kan läggas till över tid.
PublishDetails	Information om publiceringsåtgärden.
SparkLibraries	Spark-bibliotek.
SparkSettings	Spark-inställningar.

ComponentPublishInfo

Objekt

Publicera information för varje komponenter i miljön.

Namn	Typ	Beskrivning
sparkLibraries	SparkLibraries	Spark-bibliotek publicerar information.
sparkSettings	SparkSettings	Spark-inställningar publicerar information.

Environment

Objekt

Ett miljöobjekt.

Namn	Typ	Beskrivning
description	string	Objektbeskrivningen.
displayName	string	Objektets visningsnamn.
folderId	string (uuid)	Mapp-ID:t.
id	string (uuid)	Objekt-ID:t.
properties	EnvironmentProperties	Miljöegenskaperna.
tags	ItemTag[]	Lista över tillämpade taggar.
type	ItemType	Objekttypen.
workspaceId	string (uuid)	Arbetsytans ID.

EnvironmentProperties

Objekt

Miljöegenskaper.

Namn	Typ	Beskrivning
publishDetails	PublishDetails	Information om miljöpubliceringsåtgärder.

EnvironmentPublishState

Uppräkning

Publiceringstillstånd. Ytterligare tillståndstyper kan läggas till över tid.

Värde	Beskrivning
Success	Miljöpublicering har slutförts.
Cancelled	Publiceringen av miljön är i avbrutet tillstånd.
Failed	Miljöpublicering är i fel tillstånd.
Cancelling	Miljöpublicering är i avbrutet tillstånd.
Running	Miljöpublicer är i körningstillstånd.
Waiting	Publiceringen av miljön är i vänteläge.

Environments

Objekt

En lista över miljöer.

Namn	Typ	Beskrivning
continuationToken	string	Token för nästa resultatuppsättningsbatch. Om det inte finns några fler poster tas den bort från svaret.
continuationUri	string	URI:n för nästa resultatuppsättningsbatch. Om det inte finns några fler poster tas den bort från svaret.
value	Environment[]	En lista över miljöer.

ErrorRelatedResource

Objekt

Det felrelaterade resursinformationsobjektet.

Namn	Typ	Beskrivning
resourceId	string	Det resurs-ID som ingår i felet.
resourceType	string	Typen av resurs som är inblandad i felet.

ErrorResponse

Objekt

Felsvaret.

Namn	Typ	Beskrivning
errorCode	string	En specifik identifierare som ger information om ett feltillstånd, vilket möjliggör standardiserad kommunikation mellan vår tjänst och dess användare.
message	string	En mänsklig läsbar representation av felet.
moreDetails	ErrorResponseDetails[]	Lista över ytterligare felinformation.
relatedResource	ErrorRelatedResource	Felrelaterad resursinformation.
requestId	string	ID för den begäran som är associerad med felet.

ErrorResponseDetails

Objekt

Information om felsvar.

Namn	Typ	Beskrivning
errorCode	string	En specifik identifierare som ger information om ett feltillstånd, vilket möjliggör standardiserad kommunikation mellan vår tjänst och dess användare.
message	string	En mänsklig läsbar representation av felet.
relatedResource	ErrorRelatedResource	Felrelaterad resursinformation.

ItemTag

Objekt

Representerar en tagg som tillämpas på ett objekt.

Namn	Typ	Beskrivning
displayName	string	Namnet på taggen.
id	string (uuid)	Tagg-ID:t.

ItemType

Uppräkning

Typ av objekt. Ytterligare objekttyper kan läggas till över tid.

Värde	Beskrivning
Dashboard	PowerBI-instrumentpanel.
Report	PowerBI-rapport.
SemanticModel	PowerBI-semantisk modell.
PaginatedReport	Sidnumrerad PowerBI-rapport.
Datamart	PowerBI-datamart.
Lakehouse	Ett sjöhus.
Eventhouse	Ett eventhouse.
Environment	En miljö.
KQLDatabase	En KQL-databas.
KQLQueryset	En KQL-frågeuppsättning.
KQLDashboard	En KQL-instrumentpanel.
DataPipeline	En datapipeline.
Notebook	En notebook-fil.
SparkJobDefinition	En definition för Spark-jobb.
MLExperiment	Ett maskininlärningsexperiment.
MLModel	En maskininlärningsmodell.
Warehouse	Ett lager.
Eventstream	En händelseström.
SQLEndpoint	En SQL-slutpunkt.
MirroredWarehouse	Ett speglat lager.
MirroredDatabase	En speglad databas.
Reflex	En reflex.
GraphQLApi	Ett API för GraphQL-objekt.
MountedDataFactory	En MountedDataFactory.
SQLDatabase	En SQLDatabase.
CopyJob	Ett kopieringsjobb.
VariableLibrary	En VariableLibrary.
Dataflow	Ett dataflöde.
ApacheAirflowJob	Ett ApacheAirflowJob.
WarehouseSnapshot	En ögonblicksbild av lagret.
DigitalTwinBuilder	En DigitalTwinBuilder.
DigitalTwinBuilderFlow	Ett Digital Twin Builder Flow.
MirroredAzureDatabricksCatalog	En speglad azure databricks-katalog.
Map	En karta.
AnomalyDetector	En avvikelseidentifiering.
UserDataFunction	En användardatafunktion.
GraphModel	En GraphModel.
GraphQuerySet	En Graph QuerySet.
SnowflakeDatabase	En Snowflake-databas för att lagra isbergstabeller som skapats från Snowflake-kontot.
OperationsAgent	En OperationsAgent.
CosmosDBDatabase	En Cosmos DB-databas.
Ontology	En ontologi.
EventSchemaSet	En EventSchemaSet.

PublishDetails

Objekt

Information om publiceringsåtgärden.

Namn	Typ	Beskrivning
componentPublishInfo	ComponentPublishInfo	Publicera information om miljökomponenten.
endTime	string (date-time)	Sluttid för publiceringsåtgärden i UTC med formatet YYYY-MM-DDTHH:mm:ss.sssSZ.
startTime	string (date-time)	Starttid för publiceringsåtgärden i UTC med formatet YYYY-MM-DDTHH:mm:ss.ssssSZ.
state	EnvironmentPublishState	Publiceringstillstånd. Ytterligare tillståndstyper kan läggas till över tid.
targetVersion	string (uuid)	Målverion som ska publiceras.

SparkLibraries

Objekt

Spark-bibliotek.

Namn	Typ	Beskrivning
state	EnvironmentPublishState	Publiceringstillstånd. Ytterligare tillståndstyper kan läggas till över tid.

SparkSettings

Objekt

Spark-inställningar.

Namn	Typ	Beskrivning
state	EnvironmentPublishState	Publiceringstillstånd. Ytterligare tillståndstyper kan läggas till över tid.

Dela via

Items - List Environments

Behörigheter

Obligatoriska delegerade omfång

Identiteter som stöds av Microsoft Entra

Gränssnitt

URI-parametrar

Svaren

Exempel

List environments in workspace example

Exempelförfrågan

Exempelsvar

Definitioner

ComponentPublishInfo

Environment

EnvironmentProperties

EnvironmentPublishState

Environments

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ItemTag

ItemType

PublishDetails

SparkLibraries

SparkSettings