Udostępnij przez

Items - Publish Environment

Usługa:
Environment
Wersja interfejsu API:
v1

Wyzwalanie operacji publikowania środowiska.

Uwaga / Notatka

Ten interfejs API jest wersją wersji beta, która zostanie wycofana 1 marca 2026 r. Podczas wywoływania tego interfejsu API obiekt wywołujący musi ustawić parametr beta zapytania na wartość false

Ten interfejs API obsługuje długotrwałych operacji (LRO).

Permissions

Uprawnienie do zapisu dla elementu środowiska.

Wymagane zakresy delegowane

Item.ReadWrite.All lub Environment.ReadWrite.All

Tożsamości obsługiwane przez Microsoft Entra

To API obsługuje tożsamości Microsoft wymienione w tej sekcji.

Tożsamość Support
User Tak
Główne usługi i Tożsamości zarządzane Tak

Interfejs

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/environments/{environmentId}/staging/publish?beta={beta}

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
environmentId
 path True

string (uuid)

Identyfikator środowiska.
workspaceId
 path True

string (uuid)

Identyfikator przestrzeni roboczej.
beta
 query True

boolean

Ten parametr określa, która wersja interfejsu API ma być używana. Ustaw wartość na , aby false używać wersji wydania.

Odpowiedzi

Nazwa Typ Opis
200 OK

EnvironmentProperties

Pomyślnie przesłano żądanie operacji publikowania.
202 Accepted

Żądanie zaakceptowane, trwa operacja publikowania. Zwraca kontrakt ga, gdy beta=false (wartość domyślna po 1 marca 2026 r.).

Nagłówki

  • Location: string
  • x-ms-operation-id: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

Typowe kody błędów:

  • InvalidEnvironmentPublish — operacja publikowania środowiska dla < wersji nieudanej operacji> publikowania nie powiodła się z powodu błędu: Kod = EnvironmentAnotherOngoingPublishProcess.

Przykłady

Publish environment example

Przykładowe żądanie

POST https://api.fabric.microsoft.com/v1/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48/environments/41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87/staging/publish?beta=false

Przykładowa odpowiedź

Kod stanu:
200 
{
  "publishDetails": {
    "state": "Running",
    "targetVersion": "46838a80-5450-4414-bea0-40fb6f3e0c0d",
    "startTime": "2024-03-29T14:17:09.0697022Z",
    "componentPublishInfo": {
      "sparkLibraries": {
        "state": "Running"
      },
      "sparkSettings": {
        "state": "Running"
      }
    }
  }
}
Kod stanu:
202 
Location: https://api.fabric.microsoft.com/v1/operations/abcdef00-9d7e-469a-abf1-fca847a0ea69
x-ms-operation-id: abcdef00-9d7e-469a-abf1-fca847a0ea69
Retry-After: 120

Definicje

Nazwa Opis
ComponentPublishInfo

Publikowanie informacji dla poszczególnych składników w środowisku.
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.
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.

EnvironmentProperties

Objekt

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

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.

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

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.