Items - Create Environment

Usługa:: Environment

Wersja interfejsu API:: v1

Tworzy środowisko w określonym obszarze roboczym.
Ten interfejs API obsługuje długotrwałych operacji (LRO).

Uprawnienia

Obiekt wywołujący musi mieć rolę obszaru roboczego współautora .

Wymagane zakresy delegowane

Environment.ReadWrite.All lub Item.ReadWrite.All

Ograniczenia

Aby utworzyć środowisko, obszar roboczy musi znajdować się w obsługiwanej pojemności sieci szkieletowej.

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

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
workspaceId	path	True	string (uuid)	Identyfikator obszaru roboczego.

Treść żądania

Nazwa	Wymagane	Typ	Opis
displayName	True	string	Nazwa wyświetlana środowiska.
definition		EnvironmentDefinition	Definicja publiczna środowiska.
description		string	Opis środowiska. Maksymalna długość to 256 znaków.
folderId		string (uuid)	Identyfikator folderu. Jeśli nie zostanie określony lub ma wartość null, środowisko zostanie utworzone z obszarem roboczym jako jego folderem.

Odpowiedzi

Nazwa	Typ	Opis
201 Created	Environment	Pomyślnie utworzono
202 Accepted		Żądanie zaakceptowane, aprowizowanie środowiska w toku Nagłówki Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Typowe kody błędów: InvalidItemType — typ elementu jest nieprawidłowy ItemDisplayNameAlreadyInUse — nazwa wyświetlana elementu jest już używana CorruptedPayload — podany ładunek jest uszkodzony. WorkspaceItemsLimitExceeded — przekroczono limit elementu obszaru roboczego.

Nazwa

Typ

Opis

201 Created

Environment

Pomyślnie utworzono

202 Accepted

Żądanie zaakceptowane, aprowizowanie środowiska w toku

Nagłówki

Location: string
x-ms-operation-id: string
Retry-After: integer

Other Status Codes

ErrorResponse

Typowe kody błędów:

InvalidItemType — typ elementu jest nieprawidłowy
ItemDisplayNameAlreadyInUse — nazwa wyświetlana elementu jest już używana
CorruptedPayload — podany ładunek jest uszkodzony.
WorkspaceItemsLimitExceeded — przekroczono limit elementu obszaru roboczego.

Przykłady

Create an environment example

Create an environment with public definition example

Create an environment example

Przykładowe zapytanie

HTTP

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

{
  "displayName": "Environment_1",
  "description": "An environment description."
}

Przykładowa odpowiedź

Kod stanu:: 201

{
  "displayName": "Environment_1",
  "description": "An environment description.",
  "type": "Environment",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}

Kod stanu:: 202

Location: https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6
x-ms-operation-id: 0acd697c-1550-43cd-b998-91bfbfbd47c6
Retry-After: 30

Create an environment with public definition example

Przykładowe zapytanie

HTTP

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

{
  "displayName": "Environment_1",
  "description": "An environment description.",
  "definition": {
    "parts": [
      {
        "path": "Libraries/CustomLibraries/samplelibrary.jar",
        "payload": "eyJuYmZvcm1hdCI6N..",
        "payloadType": "InlineBase64"
      },
      {
        "path": "Libraries/CustomLibraries/samplepython.py",
        "payload": "FyJuYmZvcm1hdCI6N..",
        "payloadType": "InlineBase64"
      },
      {
        "path": "Libraries/CustomLibraries/samplewheel-0.18.0-py2.py3-none-any.whl",
        "payload": "LyJuYmZvcm1hdCI6N..",
        "payloadType": "InlineBase64"
      },
      {
        "path": "Libraries/CustomLibraries/sampleR.tar.gz",
        "payload": "ZyJuYmZvcm1hdCI6N..",
        "payloadType": "InlineBase64"
      },
      {
        "path": "Libraries/PublicLibraries/environment.yml",
        "payload": "IyJuYmZvcm1hdCI6N..",
        "payloadType": "InlineBase64"
      },
      {
        "path": "Setting/Sparkcompute.yml",
        "payload": "GyJuYmZvcm1hdCI6N..",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

Przykładowa odpowiedź

Kod stanu:: 201

{
  "displayName": "Environment_1",
  "description": "An environment description.",
  "type": "Environment",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}

Kod stanu:: 202

Location: https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6
x-ms-operation-id: 0acd697c-1550-43cd-b998-91bfbfbd47c6
Retry-After: 30

Definicje

Nazwa	Opis
ComponentPublishInfo	Publikowanie informacji dla poszczególnych składników w środowisku.
CreateEnvironmentRequest	Tworzenie ładunku żądania środowiska.
Environment	Element środowisko.
EnvironmentDefinition	Obiekt definicji publicznej środowiska. Zapoznaj się z tym artykułem , aby uzyskać więcej informacji na temat tworzenia definicji publicznej środowiska.
EnvironmentDefinitionPart	Obiekt części definicji środowiska.
EnvironmentProperties	Właściwości środowiska.
EnvironmentPublishState	Stan publikowania. W miarę upływu czasu można dodawać dodatkowe typy stanów.
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.
PayloadType	Typ ładunku części definicji. Dodatkowe typy ładunków mogą być dodawane 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.

CreateEnvironmentRequest

Sprzeciwiać się

Tworzenie ładunku żądania środowiska.

Nazwa	Typ	Opis
definition	EnvironmentDefinition	Definicja publiczna środowiska.
description	string	Opis środowiska. Maksymalna długość to 256 znaków.
displayName	string	Nazwa wyświetlana środowiska.
folderId	string (uuid)	Identyfikator folderu. Jeśli nie zostanie określony lub ma wartość null, środowisko zostanie utworzone z obszarem roboczym jako jego folderem.

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.

EnvironmentDefinition

Sprzeciwiać się

Obiekt definicji publicznej środowiska. Zapoznaj się z tym artykułem , aby uzyskać więcej informacji na temat tworzenia definicji publicznej środowiska.

Nazwa	Typ	Opis
format	string	Format definicji środowiska.
parts	EnvironmentDefinitionPart[]	Lista części definicji.

EnvironmentDefinitionPart

Sprzeciwiać się

Obiekt części definicji środowiska.

Nazwa	Typ	Opis
path	string	Ścieżka części środowiska.
payload	string	Ładunek części środowiska.
payloadType	PayloadType	Typ ładunku.

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.

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.

PayloadType

Wyliczenie

Typ ładunku części definicji. Dodatkowe typy ładunków mogą być dodawane w czasie.

Wartość	Opis
InlineBase64	Śródliniowa baza 64.

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 - Create Environment

Uprawnienia

Wymagane zakresy delegowane

Ograniczenia

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

Interfejs

Parametry identyfikatora URI

Treść żądania

Odpowiedzi

Przykłady

Create an environment example

Przykładowe zapytanie

Przykładowa odpowiedź

Create an environment with public definition example

Przykładowe zapytanie

Przykładowa odpowiedź

Definicje

ComponentPublishInfo

CreateEnvironmentRequest

Environment

EnvironmentDefinition

EnvironmentDefinitionPart

EnvironmentProperties

EnvironmentPublishState

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ItemTag

ItemType

PayloadType

PublishDetails

SparkLibraries

SparkSettings