Udostępnij przez

Items - Cancel Publish Environment

Usługa:
Environment
Wersja interfejsu API:
v1

Wyzwalanie anulowania publikowania środowiska.

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
environmentId
 path True

string (uuid)

Identyfikator środowiska.
workspaceId
 path True

string (uuid)

Identyfikator przestrzeni roboczej.

Odpowiedzi

Nazwa Typ Opis
200 OK

EnvironmentProperties

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

ErrorResponse

Typowe kody błędów:

  • InvalidEnvironmentCancel — operacja anulowania środowiska dla identyfikatora GUID wersji < nieudanego anulowania publikowania> nie powiodła się z powodu błędu: Kod = EnvironmentUpsupportedStateForCancel.

Przykłady

Publish environment cancellation example

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:
200 
{
  "publishDetails": {
    "state": "Cancelled",
    "targetVersion": "d9d95b01-248f-4ef4-bd7e-9d3f1f6447be",
    "startTime": "2024-03-29T14:17:09.0697022Z",
    "endTime": "2024-03-29T14:48:18.0697022Z",
    "componentPublishInfo": {
      "sparkLibraries": {
        "state": "Cancelled"
      },
      "sparkSettings": {
        "state": "Cancelled"
      }
    }
  }
}

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

Wyliczanie

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.