Items - List Environments

Odwołanie

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ć lub większą rolę obszaru roboczego.

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 żądanie

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.
EnvironmentPublishInfo	Informacje o publikowaniu ś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.
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

Objekt

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

Objekt

Element środowisko.

Nazwa	Typ	Opis
description	string	Opis elementu.
displayName	string	Nazwa wyświetlana elementu.
id	string uuid	Identyfikator elementu.
properties	EnvironmentPublishInfo	Właściwości środowiska.
type	ItemType	Typ elementu.
workspaceId	string uuid	Identyfikator obszaru roboczego.

EnvironmentPublishInfo

Objekt

Informacje o publikowaniu środowiska.

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

EnvironmentPublishState

Wyliczanie

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

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

Environments

Objekt

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

Objekt

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

Objekt

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

Objekt

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.

ItemType

Wyliczanie

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

Wartość	Opis
Dashboard	Pulpit nawigacyjny usługi Power BI.
DataPipeline	Potok danych.
Datamart	Datamart usługi Power BI.
Environment	Środowisko.
Eventhouse	Magazyn zdarzeń.
Eventstream	Strumień zdarzeń.
GraphQLApi	Interfejs API dla elementu GraphQL.
KQLDashboard	Pulpit nawigacyjny KQL.
KQLDatabase	Baza danych KQL.
KQLQueryset	Zestaw zapytań KQL.
Lakehouse	Jezioro.
MLExperiment	Eksperyment uczenia maszynowego.
MLModel	Model uczenia maszynowego.
MirroredDatabase	Dublowana baza danych.
MirroredWarehouse	Dublowany magazyn.
MountedDataFactory	A MountedDataFactory.
Notebook	Notes.
PaginatedReport	Raport podzielony na strony usługi PowerBI.
Reflex	Refleks.
Report	Raport usługi Power BI.
SQLDatabase	Baza danych SQLDatabase.
SQLEndpoint	Punkt końcowy SQL.
SemanticModel	Model semantyczny usługi PowerBI.
SparkJobDefinition	Definicja zadania platformy Spark.
Warehouse	Magazyn.

PublishDetails

Objekt

Szczegóły operacji publikowania.

Nazwa	Typ	Opis
componentPublishInfo	ComponentPublishInfo	Składnik środowiska publikuje informacje.
endTime	string date-time	Godzina zakończenia operacji publikowania.
startTime	string date-time	Godzina rozpoczęcia operacji publikowania.
state	EnvironmentPublishState	Stan publikowania. W miarę upływu czasu można dodawać dodatkowe typy stanów.
targetVersion	string uuid	Docelowa verion do opublikowania.

SparkLibraries

Objekt

Biblioteki platformy Spark.

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

SparkSettings

Objekt

Ustawienia platformy Spark.

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

Udostępnij za pośrednictwem

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 żądanie

Przykładowa odpowiedź

Definicje

ComponentPublishInfo

Environment

EnvironmentPublishInfo

EnvironmentPublishState

Environments

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ItemType

PublishDetails

SparkLibraries

SparkSettings

Dodatkowe zasoby