Freigeben über

Items - Cancel Publish Environment

Dienst:
Environment
API-Version:
v1

Auslösen eines Veröffentlichungsabbruchs in einer Umgebung.

Erlaubnisse

Schreibberechtigung für das Umgebungselement.

Erforderliche delegierte Bereiche

Item.ReadWrite.All oder Environment.ReadWrite.All

Von Microsoft Entra unterstützte Identitäten

Diese API unterstützt die in diesem Abschnitt aufgeführten Microsoft Identitäten.

Identität Support
Benutzer Yes
Service Principal und Verwaltete Identitäten Yes

Schnittstelle

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
environmentId
 path True

string (uuid)

Die Umgebungs-ID.
workspaceId
 path True

string (uuid)

Die Arbeitsbereichs-ID.

Antworten

Name Typ Beschreibung
200 OK

EnvironmentProperties

Die Anforderung wurde erfolgreich abgeschlossen.
Other Status Codes

ErrorResponse

Häufige Fehlercodes:

  • InvalidEnvironmentCancel - Vorgang der Umgebung für die Versions-GUID< des fehlgeschlagenen Veröffentlichungsabbruchs> aufgrund eines Fehlers fehlgeschlagen: Code = EnvironmentUpsupportedStateForCancel.

Beispiele

Publish environment cancellation example

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:
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"
      }
    }
  }
}

Definitionen

Name Beschreibung
ComponentPublishInfo

Veröffentlichen Sie Informationen für die einzelnen Komponenten in der Umgebung.
EnvironmentProperties

Umgebungseigenschaften.
EnvironmentPublishState

Veröffentlichungsstatus. Zusätzliche Statustypen können im Laufe der Zeit hinzugefügt werden.
ErrorRelatedResource

Das Fehlerbezogene Ressourcendetails-Objekt.
ErrorResponse

Die Fehlerantwort.
ErrorResponseDetails

Die Fehlerantwortdetails.
PublishDetails

Details des Veröffentlichungsvorgangs.
SparkLibraries

Spark-Bibliotheken.
SparkSettings

Spark-Einstellungen.

ComponentPublishInfo

Objekt

Veröffentlichen Sie Informationen für die einzelnen Komponenten in der Umgebung.

Name Typ Beschreibung
sparkLibraries

SparkLibraries

Spark-Bibliotheken veröffentlichen Informationen.
sparkSettings

SparkSettings

Spark-Einstellungen veröffentlichen Informationen.

EnvironmentProperties

Objekt

Umgebungseigenschaften.

Name Typ Beschreibung
publishDetails

PublishDetails

Details zum Veröffentlichen von Vorgängen in der Umgebung.

EnvironmentPublishState

Enumeration

Veröffentlichungsstatus. Zusätzliche Statustypen können im Laufe der Zeit hinzugefügt werden.

Wert Beschreibung
Success

Die Veröffentlichung der Umgebung befindet sich im Erfolgszustand.
Cancelled

Die Veröffentlichung der Umgebung befindet sich im Zustand "Abgebrochen".
Failed

Die Veröffentlichung der Umgebung ist fehlgeschlagen.
Cancelling

Die Veröffentlichung der Umgebung befindet sich im Zustand "Abbrechen".
Running

Die Veröffentlichung der Umgebung befindet sich im Ausführungszustand.
Waiting

Die Veröffentlichung der Umgebung befindet sich im Wartezustand.

ErrorRelatedResource

Objekt

Das Fehlerbezogene Ressourcendetails-Objekt.

Name Typ Beschreibung
resourceId

string

Die Ressourcen-ID, die an dem Fehler beteiligt ist.
resourceType

string

Der Typ der Ressource, die an dem Fehler beteiligt ist.

ErrorResponse

Objekt

Die Fehlerantwort.

Name Typ Beschreibung
errorCode

string

Ein bestimmter Bezeichner, der Informationen über eine Fehlerbedingung bereitstellt und eine standardisierte Kommunikation zwischen unserem Dienst und seinen Benutzern ermöglicht.
message

string

Eine lesbare Darstellung des Fehlers.
moreDetails

ErrorResponseDetails[]

Liste der zusätzlichen Fehlerdetails.
relatedResource

ErrorRelatedResource

Die fehlerbezogenen Ressourcendetails.
requestId

string

ID der Anforderung, die dem Fehler zugeordnet ist.

ErrorResponseDetails

Objekt

Die Fehlerantwortdetails.

Name Typ Beschreibung
errorCode

string

Ein bestimmter Bezeichner, der Informationen über eine Fehlerbedingung bereitstellt und eine standardisierte Kommunikation zwischen unserem Dienst und seinen Benutzern ermöglicht.
message

string

Eine lesbare Darstellung des Fehlers.
relatedResource

ErrorRelatedResource

Die fehlerbezogenen Ressourcendetails.

PublishDetails

Objekt

Details des Veröffentlichungsvorgangs.

Name Typ Beschreibung
componentPublishInfo

ComponentPublishInfo

Informationen zur Umgebungskomponente veröffentlichen.
endTime

string (date-time)

Endzeit des Veröffentlichungsvorgangs in UTC mit dem Format JJJJ-MM-DDTHH:mm:sssZ.
startTime

string (date-time)

Startzeit des Veröffentlichungsvorgangs in UTC mit dem Format JJJJ-MM-TTTHH:mm:sssZ.
state

EnvironmentPublishState

Veröffentlichungsstatus. Zusätzliche Statustypen können im Laufe der Zeit hinzugefügt werden.
targetVersion

string (uuid)

Zielverion, die veröffentlicht werden soll.

SparkLibraries

Objekt

Spark-Bibliotheken.

Name Typ Beschreibung
state

EnvironmentPublishState

Veröffentlichungsstatus. Zusätzliche Statustypen können im Laufe der Zeit hinzugefügt werden.

SparkSettings

Objekt

Spark-Einstellungen.

Name Typ Beschreibung
state

EnvironmentPublishState

Veröffentlichungsstatus. Zusätzliche Statustypen können im Laufe der Zeit hinzugefügt werden.