Items - List Environments

Usługa:: Environment

Wersja interfejsu API:: v1

Zwraca listę środowisk z określonego obszaru roboczego.
Ten interfejs API obsługuje stronicowanie.

Uprawnienia

Obiekt wywołujący musi mieć rolę obszaru roboczego przeglądarki .

Wymagane zakresy delegowane

Workspace.Read.All lub Workspace.ReadWrite.All

Tożsamości obsługiwane przez firmę Microsoft

Ten interfejs API obsługuje tożsamości firmy Microsoft wymienione w tej sekcji.

Tożsamość	Wsparcie
Użytkownik	Tak
jednostki usługi i tożsamości zarządzanych	Tak

Interfejs

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

Z parametrami opcjonalnymi:

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
workspaceId	path	True	string (uuid)	Identyfikator obszaru roboczego.
continuationToken	query		string	Token do pobierania następnej strony wyników.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	Environments	Żądanie zostało ukończone pomyślnie.
Other Status Codes	ErrorResponse	Typowe kody błędów: InvalidItemType — nieprawidłowy typ elementu

Nazwa

Typ

Opis

200 OK

Environments

Żądanie zostało ukończone pomyślnie.

Other Status Codes

ErrorResponse

Typowe kody błędów:

InvalidItemType — nieprawidłowy typ elementu

Przykłady

List environments in workspace example

Przykładowe zapytanie

HTTP

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

Przykładowa odpowiedź

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

Definicje

Nazwa	Opis
ComponentPublishInfo	Publikowanie informacji dla poszczególnych składników w środowisku.
Environment	Element środowisko.
EnvironmentProperties	Właściwości środowiska.
EnvironmentPublishState	Stan publikowania. W miarę upływu czasu można dodawać dodatkowe typy stanów.
Environments	Lista środowisk.
ErrorRelatedResource	Obiekt szczegółów zasobu powiązanego z błędem.
ErrorResponse	Odpowiedź na błąd.
ErrorResponseDetails	Szczegóły odpowiedzi na błąd.
ItemTag	Reprezentuje tag zastosowany w elemencie.
ItemType	Typ elementu. Dodatkowe typy elementów można dodawać w czasie.
PublishDetails	Szczegóły operacji publikowania.
SparkLibraries	Biblioteki platformy Spark.
SparkSettings	Ustawienia platformy Spark.

ComponentPublishInfo

Sprzeciwiać się

Publikowanie informacji dla poszczególnych składników w środowisku.

Nazwa	Typ	Opis
sparkLibraries	SparkLibraries	Biblioteki platformy Spark publikują informacje.
sparkSettings	SparkSettings	Ustawienia platformy Spark publikują informacje.

Environment

Sprzeciwiać się

Element środowisko.

Nazwa	Typ	Opis
description	string	Opis elementu.
displayName	string	Nazwa wyświetlana elementu.
folderId	string (uuid)	Identyfikator folderu.
id	string (uuid)	Identyfikator elementu.
properties	EnvironmentProperties	Właściwości środowiska.
tags	ItemTag[]	Lista zastosowanych tagów.
type	ItemType	Typ elementu.
workspaceId	string (uuid)	Identyfikator obszaru roboczego.

EnvironmentProperties

Sprzeciwiać się

Właściwości środowiska.

Nazwa	Typ	Opis
publishDetails	PublishDetails	Szczegóły operacji publikowania środowiska.

EnvironmentPublishState

Wyliczenie

Stan publikowania. W miarę upływu czasu można dodawać dodatkowe typy stanów.

Wartość	Opis
Success	Publikowanie środowiska jest w stanie powodzenia.
Cancelled	Publikowanie środowiska jest w stanie anulowania.
Failed	Publikowanie środowiska jest w stanie niepowodzenia.
Cancelling	Publikowanie środowiska jest w stanie anulowania.
Running	Publikowanie środowiska jest w stanie uruchomienia.
Waiting	Publikowanie środowiska jest w stanie oczekiwania.

Environments

Sprzeciwiać się

Lista środowisk.

Nazwa	Typ	Opis
continuationToken	string	Token dla następnej partii zestawu wyników. Jeśli nie ma więcej rekordów, zostanie on usunięty z odpowiedzi.
continuationUri	string	Identyfikator URI następnego zestawu wyników wsadowy. Jeśli nie ma więcej rekordów, zostanie on usunięty z odpowiedzi.
value	Environment[]	Lista środowisk.

ErrorRelatedResource

Sprzeciwiać się

Obiekt szczegółów zasobu powiązanego z błędem.

Nazwa	Typ	Opis
resourceId	string	Identyfikator zasobu, który jest zaangażowany w błąd.
resourceType	string	Typ zasobu, który jest zaangażowany w błąd.

ErrorResponse

Sprzeciwiać się

Odpowiedź na błąd.

Nazwa	Typ	Opis
errorCode	string	Określony identyfikator, który zawiera informacje o stanie błędu, co pozwala na ustandaryzowaną komunikację między naszą usługą a jej użytkownikami.
message	string	Czytelna reprezentacja błędu przez człowieka.
moreDetails	ErrorResponseDetails[]	Lista dodatkowych szczegółów błędu.
relatedResource	ErrorRelatedResource	Szczegóły zasobu powiązanego z błędem.
requestId	string	Identyfikator żądania skojarzonego z błędem.

ErrorResponseDetails

Sprzeciwiać się

Szczegóły odpowiedzi na błąd.

Nazwa	Typ	Opis
errorCode	string	Określony identyfikator, który zawiera informacje o stanie błędu, co pozwala na ustandaryzowaną komunikację między naszą usługą a jej użytkownikami.
message	string	Czytelna reprezentacja błędu przez człowieka.
relatedResource	ErrorRelatedResource	Szczegóły zasobu powiązanego z błędem.

ItemTag

Sprzeciwiać się

Reprezentuje tag zastosowany w elemencie.

Nazwa	Typ	Opis
displayName	string	Nazwa znacznika.
id	string (uuid)	Identyfikator tagu.

ItemType

Wyliczenie

Typ elementu. Dodatkowe typy elementów można dodawać w czasie.

Wartość	Opis
Dashboard	Pulpit nawigacyjny usługi Power BI.
Report	Raport usługi Power BI.
SemanticModel	Model semantyczny usługi PowerBI.
PaginatedReport	Raport podzielony na strony usługi PowerBI.
Datamart	Datamart usługi Power BI.
Lakehouse	Jezioro.
Eventhouse	Magazyn zdarzeń.
Environment	Środowisko.
KQLDatabase	Baza danych KQL.
KQLQueryset	Zestaw zapytań KQL.
KQLDashboard	Pulpit nawigacyjny KQL.
DataPipeline	Potok danych.
Notebook	Notes.
SparkJobDefinition	Definicja zadania platformy Spark.
MLExperiment	Eksperyment uczenia maszynowego.
MLModel	Model uczenia maszynowego.
Warehouse	Magazyn.
Eventstream	Strumień zdarzeń.
SQLEndpoint	Punkt końcowy SQL.
MirroredWarehouse	Dublowany magazyn.
MirroredDatabase	Dublowana baza danych.
Reflex	Refleks.
GraphQLApi	Interfejs API dla elementu GraphQL.
MountedDataFactory	A MountedDataFactory.
SQLDatabase	Baza danych SQLDatabase.
CopyJob	Zadanie kopiowania.
VariableLibrary	ZmiennaLibrary.
Dataflow	Przepływ danych.
ApacheAirflowJob	Zadanie ApacheAirflowJob.
WarehouseSnapshot	Migawka magazynu.
DigitalTwinBuilder	A DigitalTwinBuilder.
DigitalTwinBuilderFlow	Przepływ usługi Digital Twin Builder.
MirroredAzureDatabricksCatalog	Dublowany wykaz usługi Azure Databricks.
Map	Mapa.
AnomalyDetector	Wykrywacz anomalii.
UserDataFunction	Funkcja danych użytkownika.
GraphModel	Model programu Graph.
GraphQuerySet	Zestaw zapytań programu Graph.
SnowflakeDatabase	Baza danych Snowflake do przechowywania tabel góry lodowej utworzonych na podstawie konta Snowflake.
OperationsAgent	A OperationsAgent.
CosmosDBDatabase	Baza danych usługi Cosmos DB.
Ontology	Ontologia.

PublishDetails

Sprzeciwiać się

Szczegóły operacji publikowania.

Nazwa	Typ	Opis
componentPublishInfo	ComponentPublishInfo	Składnik środowiska publikuje informacje.
endTime	string (date-time)	Godzina zakończenia operacji publikowania w formacie UTC przy użyciu formatu RRRR-MM-DDTHH:mm:ss.sssssZ.
startTime	string (date-time)	Godzina rozpoczęcia operacji publikowania w formacie UTC przy użyciu formatu RRRR-MM-DDTHH:mm:ss.ssssZ.
state	EnvironmentPublishState	Stan publikowania. W miarę upływu czasu można dodawać dodatkowe typy stanów.
targetVersion	string (uuid)	Docelowa verion do opublikowania.

SparkLibraries

Sprzeciwiać się

Biblioteki platformy Spark.

Nazwa	Typ	Opis
state	EnvironmentPublishState	Stan publikowania. W miarę upływu czasu można dodawać dodatkowe typy stanów.

SparkSettings

Sprzeciwiać się

Ustawienia platformy Spark.

Nazwa	Typ	Opis
state	EnvironmentPublishState	Stan publikowania. W miarę upływu czasu można dodawać dodatkowe typy stanów.

Udostępnij przez

Items - List Environments

Uprawnienia

Wymagane zakresy delegowane

Tożsamości obsługiwane przez firmę Microsoft

Interfejs

Parametry identyfikatora URI

Odpowiedzi

Przykłady

List environments in workspace example

Przykładowe zapytanie

Przykładowa odpowiedź

Definicje

ComponentPublishInfo

Environment

EnvironmentProperties

EnvironmentPublishState

Environments

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ItemTag

ItemType

PublishDetails

SparkLibraries

SparkSettings