Partager via

Items - Cancel Publish Environment

Service:
Environment
Version d'API:
v1

Déclenchez une annulation de publication d’environnement.

Permissions

Autorisation d’écriture pour l’élément d’environnement.

Étendues déléguées requises

Item.ReadWrite.All ou Environment.ReadWrite.All

Identités prises en charge par Microsoft Entra

Cette API prend en charge les identités Microsoft répertoriées dans cette section.

Identité Support
Utilisateur Oui
Service principal et identités gérées Oui

Interface

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

Paramètres URI

Nom Dans Obligatoire Type Description
environmentId
 path True

string (uuid)

ID d’environnement.
workspaceId
 path True

string (uuid)

Identifiant de l’espace de travail.

Réponses

Nom Type Description
200 OK

EnvironmentProperties

La demande s’est terminée avec succès.
Other Status Codes

ErrorResponse

Codes d’erreur courants :

  • InvalidEnvironmentCancel - Opération d’annulation d’environnement pour le GUID de version < de l’annulation> de publication ayant échoué en raison d’une erreur : Code = EnvironmentUpsupportedStateForCancel.

Exemples

Publish environment cancellation example

Exemple de requête

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

Exemple de réponse

Code d’état:
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"
      }
    }
  }
}

Définitions

Nom Description
ComponentPublishInfo

Publier des informations pour chaque composant dans l’environnement.
EnvironmentProperties

Propriétés de l’environnement.
EnvironmentPublishState

État de publication. Des types d’état supplémentaires peuvent être ajoutés au fil du temps.
ErrorRelatedResource

Objet de détails de ressource associé à l’erreur.
ErrorResponse

Réponse d’erreur.
ErrorResponseDetails

Détails de la réponse d’erreur.
PublishDetails

Détails de l’opération de publication.
SparkLibraries

Bibliothèques Spark.
SparkSettings

Paramètres Spark.

ComponentPublishInfo

Object

Publier des informations pour chaque composant dans l’environnement.

Nom Type Description
sparkLibraries

SparkLibraries

Les bibliothèques Spark publient des informations.
sparkSettings

SparkSettings

Les paramètres Spark publient des informations.

EnvironmentProperties

Object

Propriétés de l’environnement.

Nom Type Description
publishDetails

PublishDetails

Détails de l’opération de publication de l’environnement.

EnvironmentPublishState

Énumération

État de publication. Des types d’état supplémentaires peuvent être ajoutés au fil du temps.

Valeur Description
Success

La publication de l’environnement est en état de réussite.
Cancelled

La publication de l’environnement est à l’état annulé.
Failed

La publication de l’environnement est en état d’échec.
Cancelling

La publication de l’environnement est en état d’annulation.
Running

La publication de l’environnement est en cours d’exécution.
Waiting

La publication de l’environnement est en attente.

ErrorRelatedResource

Object

Objet de détails de ressource associé à l’erreur.

Nom Type Description
resourceId

string

ID de ressource impliqué dans l’erreur.
resourceType

string

Type de la ressource impliquée dans l’erreur.

ErrorResponse

Object

Réponse d’erreur.

Nom Type Description
errorCode

string

Identificateur spécifique qui fournit des informations sur une condition d’erreur, ce qui permet une communication standardisée entre notre service et ses utilisateurs.
message

string

Représentation lisible humaine de l’erreur.
moreDetails

ErrorResponseDetails[]

Liste des détails d’erreur supplémentaires.
relatedResource

ErrorRelatedResource

Détails de la ressource associée à l’erreur.
requestId

string

ID de la demande associée à l’erreur.

ErrorResponseDetails

Object

Détails de la réponse d’erreur.

Nom Type Description
errorCode

string

Identificateur spécifique qui fournit des informations sur une condition d’erreur, ce qui permet une communication standardisée entre notre service et ses utilisateurs.
message

string

Représentation lisible humaine de l’erreur.
relatedResource

ErrorRelatedResource

Détails de la ressource associée à l’erreur.

PublishDetails

Object

Détails de l’opération de publication.

Nom Type Description
componentPublishInfo

ComponentPublishInfo

Informations de publication du composant d’environnement.
endTime

string (date-time)

Heure de fin de l’opération de publication au format UTC, à l’aide du format AAAA-MM-DDTHH :mm :sssssssz.
startTime

string (date-time)

Heure de début de l’opération de publication au format UTC, à l’aide du format AAAA-MM-DDTHH :mm :sssssssZ.
state

EnvironmentPublishState

État de publication. Des types d’état supplémentaires peuvent être ajoutés au fil du temps.
targetVersion

string (uuid)

Verion cible à publier.

SparkLibraries

Object

Bibliothèques Spark.

Nom Type Description
state

EnvironmentPublishState

État de publication. Des types d’état supplémentaires peuvent être ajoutés au fil du temps.

SparkSettings

Object

Paramètres Spark.

Nom Type Description
state

EnvironmentPublishState

État de publication. Des types d’état supplémentaires peuvent être ajoutés au fil du temps.