Items - List Environments

Služba:: Environment

Verzia rozhrania API:: v1

Vráti zoznam prostredí zo zadaného pracovného priestoru.
Toto rozhranie API podporuje stránkovanie.

Povolenia

Volajúci musí mať rolu pracovného priestoru čitateľa .

Povinné delegované rozsahy

Workspace.Read.All alebo Workspace.ReadWrite.All

Podporované identity v aplikácii Microsoft Entra

Toto rozhranie API podporuje identity Microsoft uvedené v tejto časti.

Identita	Podpora
Používateľ	Áno
Objekt služby a spravované identity	Áno

Rozhranie

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

S voliteľnými parametrami:

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

Parametre URI

Name	V	Povinné	Typ	Description
workspaceId	path	True	string (uuid)	ID pracovného priestoru.
continuationToken	query		string	Token na načítanie ďalšej stránky výsledkov.
recursive	query		boolean	Zobrazí zoznam položiek v priečinku a jeho vnorených priečinkoch alebo len v priečinku. True – všetky položky v priečinku a jeho vnorené priečinky sú uvedené v zozname, False – v priečinku sú uvedené iba položky. Predvolená hodnota je True.
rootFolderId	query		string (uuid)	Tento parameter umožňuje používateľom filtrovať položky na základe konkrétneho koreňového priečinka. Ak nie je uvedený, pracovný priestor sa použije ako koreňový priečinok.

Odpovede

Name	Typ	Description
200 OK	Environments	Požiadavka sa úspešne dokončila.
Other Status Codes	ErrorResponse	Bežné kódy chýb: InvalidItemType – Neplatný typ položky

Name

Typ

Description

200 OK

Environments

Požiadavka sa úspešne dokončila.

Other Status Codes

ErrorResponse

Bežné kódy chýb:

InvalidItemType – Neplatný typ položky

Príklady

List environments in workspace example

Vzorová požiadavka

HTTP

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

Vzorová odpoveď

Kód stavu:: 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"
            }
          }
        }
      }
    }
  ]
}

Definície

Name	Description
ComponentPublishInfo	Publikujte informácie o jednotlivých súčastiach v prostredí.
Environment	Položka prostredia.
EnvironmentProperties	Vlastnosti prostredia.
EnvironmentPublishState	Stav publikovania. V priebehu času je možné pridať ďalšie typy stavov.
Environments	Zoznam prostredí.
ErrorRelatedResource	Objekt s podrobnosťami o zdroji súvisiacej s chybou.
ErrorResponse	Odpoveď na chybu.
ErrorResponseDetails	Podrobnosti o chybovej odpovedi.
ItemTag	Predstavuje značku použitú na položke.
ItemType	Typ položky. V priebehu času je možné pridať ďalšie typy položiek.
PublishDetails	Podrobnosti o operácii publikovania.
SparkLibraries	Knižnice Spark.
SparkSettings	Nastavenia spark.

ComponentPublishInfo

Object

Publikujte informácie o jednotlivých súčastiach v prostredí.

Name	Typ	Description
sparkLibraries	SparkLibraries	Knižnice Spark publikuujú informácie.
sparkSettings	SparkSettings	Nastavenia Spark publikujte informácie.

Environment

Object

Položka prostredia.

Name	Typ	Description
description	string	Popis položky.
displayName	string	Zobrazovaný názov položky.
folderId	string (uuid)	ID priečinka.
id	string (uuid)	ID položky.
properties	EnvironmentProperties	Vlastnosti prostredia.
tags	ItemTag[]	Zoznam použitých značiek.
type	ItemType	Typ položky.
workspaceId	string (uuid)	ID pracovného priestoru.

EnvironmentProperties

Object

Vlastnosti prostredia.

Name	Typ	Description
publishDetails	PublishDetails	Podrobnosti o operácii publikovania prostredia.

EnvironmentPublishState

Enumerácia

Stav publikovania. V priebehu času je možné pridať ďalšie typy stavov.

Hodnota	Description
Success	Publikovanie prostredia je v stave úspechu.
Cancelled	Publikovanie prostredia je v stave zrušené.
Failed	Publikovanie prostredia je v stave neúspešných.
Cancelling	Publikovanie prostredia je v stave zrušenia.
Running	Publikovanie prostredia je v stave spustenia.
Waiting	Publikovanie prostredia čaká.

Environments

Object

Zoznam prostredí.

Name	Typ	Description
continuationToken	string	Token pre ďalšiu dávku množiny výsledkov. Ak už žiadne záznamy neexistujú, odstráni sa z odpovede.
continuationUri	string	Identifikátor URI ďalšej série množiny výsledkov. Ak už žiadne záznamy neexistujú, odstráni sa z odpovede.
value	Environment[]	Zoznam prostredí.

ErrorRelatedResource

Object

Objekt s podrobnosťami o zdroji súvisiacej s chybou.

Name	Typ	Description
resourceId	string	ID prostriedku, ktoré je súčasťou chyby.
resourceType	string	Typ prostriedku, ktorý je zapojený do chyby.

ErrorResponse

Object

Odpoveď na chybu.

Name	Typ	Description
errorCode	string	Konkrétny identifikátor, ktorý poskytuje informácie o chybovej podmienke a umožňuje štandardizovanú komunikáciu medzi našou službou a používateľmi.
message	string	Zobrazenie chyby čitateľné ľuďmi.
moreDetails	ErrorResponseDetails[]	Zoznam ďalších podrobností o chybe.
relatedResource	ErrorRelatedResource	Podrobnosti o zdrojoch súvisiacich s chybou.
requestId	string	ID požiadavky súvisiacej s chybou.

ErrorResponseDetails

Object

Podrobnosti o chybovej odpovedi.

Name	Typ	Description
errorCode	string	Konkrétny identifikátor, ktorý poskytuje informácie o chybovej podmienke a umožňuje štandardizovanú komunikáciu medzi našou službou a používateľmi.
message	string	Zobrazenie chyby čitateľné ľuďmi.
relatedResource	ErrorRelatedResource	Podrobnosti o zdrojoch súvisiacich s chybou.

ItemTag

Object

Predstavuje značku použitú na položke.

Name	Typ	Description
displayName	string	Názov značky.
id	string (uuid)	ID značky.

ItemType

Enumerácia

Typ položky. V priebehu času je možné pridať ďalšie typy položiek.

Hodnota	Description
Dashboard	Tabuľa služby PowerBI.
Report	Zostava PowerBI.
SemanticModel	Sémantický model PowerBI.
PaginatedReport	Stránkovaná zostava služby PowerBI.
Datamart	Údajový diagram služby PowerBI.
Lakehouse	Jazero.
Eventhouse	Eventhouse.
Environment	Prostredie.
KQLDatabase	Databáza KQL.
KQLQueryset	Množina dotazov KQL.
KQLDashboard	Tabuľa KQL.
DataPipeline	Kanál údajov.
Notebook	Poznámkový blok.
SparkJobDefinition	Definícia úlohy iskry.
MLExperiment	Experiment strojového učenia.
MLModel	Model strojového učenia.
Warehouse	Sklad.
Eventstream	Udalosť eventstream.
SQLEndpoint	Koncový bod SQL.
MirroredWarehouse	Zrkadlový sklad.
MirroredDatabase	Zrkadlová databáza.
Reflex	A Reflex.
GraphQLApi	Rozhranie API pre položku GraphQL.
MountedDataFactory	A MountedDataFactory.
SQLDatabase	Databáza SQLDatabase.
CopyJob	Kopírovať úlohu.
VariableLibrary	A VariableLibrary.
Dataflow	Tok údajov.
ApacheAirflowJob	An ApacheAirflowJob.
WarehouseSnapshot	Snímka skladu.
DigitalTwinBuilder	A DigitalTwinBuilder.
DigitalTwinBuilderFlow	Digitálny postup Twin Buildera.
MirroredAzureDatabricksCatalog	Zrkadlový katalóg Azure databricks.
Map	Mapa.
AnomalyDetector	Detektor anomálií.
UserDataFunction	Funkcia user data function.
GraphModel	A GraphModel.
GraphQuerySet	Množina dotazov Graphu.
SnowflakeDatabase	Databáza Snowflake na ukladanie tabuliek ľadovec vytvorených z konta Snowflake.
OperationsAgent	OperationsAgent (Operácia).
CosmosDBDatabase	Databáza Cosmos DB.
Ontology	Ontológia.
EventSchemaSet	Množina schém udalosti.

PublishDetails

Object

Podrobnosti o operácii publikovania.

Name	Typ	Description
componentPublishInfo	ComponentPublishInfo	Súčasť prostredia publikuje informácie.
endTime	string (date-time)	Čas ukončenia operácie publikovania v UTC pomocou formátu RRRR-MM-DDTHH:mm:sssssZ.
startTime	string (date-time)	Čas začatia operácie publikovania v UTC pomocou formátu RRRR-MM-DDTHH:mm:sssssZ.
state	EnvironmentPublishState	Stav publikovania. V priebehu času je možné pridať ďalšie typy stavov.
targetVersion	string (uuid)	Cieľová verion, ktorá sa má publikovať.

SparkLibraries

Object

Knižnice Spark.

Name	Typ	Description
state	EnvironmentPublishState	Stav publikovania. V priebehu času je možné pridať ďalšie typy stavov.

SparkSettings

Object

Nastavenia spark.

Name	Typ	Description
state	EnvironmentPublishState	Stav publikovania. V priebehu času je možné pridať ďalšie typy stavov.

Zdieľať cez

Items - List Environments

Povolenia

Povinné delegované rozsahy

Podporované identity v aplikácii Microsoft Entra

Rozhranie

Parametre URI

Odpovede

Príklady

List environments in workspace example

Vzorová požiadavka

Vzorová odpoveď

Definície

ComponentPublishInfo

Environment

EnvironmentProperties

EnvironmentPublishState

Environments

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ItemTag

ItemType

PublishDetails

SparkLibraries

SparkSettings