Annuler une opération

Article
06/14/2024

Remarque

Les API de Portail Cloud Partner sont intégrées à Espace partenaires et continueront d’y fonctionner. La transition introduit de légères modifications. Passez en revue les changements répertoriés dans les informations de référence relatives aux API de Portail Cloud Partner pour vous assurer que votre code continue de fonctionner après la transition vers Espace partenaires. Les API du Portail Cloud Partner ne doivent être utilisées que pour les produits intégrés avant la transition vers l’Espace partenaires. Les nouveaux produits doivent employer les API de soumission à l’Espace partenaires.

Cette API annule une opération qui est en cours sur l’offre. Utilisez l’API de récupération d’opérations pour obtenir un operationId à transmettre à cette API. L’annulation est généralement une opération synchrone, mais dans certains scénarios complexes, une nouvelle opération peut être nécessaire pour annuler une opération existante. Dans ce cas, le corps de la réponse HTTP contient l’emplacement de l’opération qui doit être utilisé pour interroger l’état de la requête.

POST https://cloudpartner.azure.com/api/publishers/<publisherId>/offers/<offerId>/cancel?api-version=2017-10-31

Paramètres d’URI

Nom	Description	Type de données
publisherId	Identificateur du serveur de publication, par exemple `contoso`	Chaîne
offerId	Identificateur de l’offre	Chaîne
api-version	Version actuelle de l’API	Date

Nom	Valeur
Type de contenu	application/json
Autorisation	Porteur de VOTRE JETON

Exemple de corps

Requête

{
   "metadata": {
     "notification-emails": "jondoe@contoso.com"
    }
}

Propriétés du corps de la requête

Nom	Description
e-mails de notification	Liste d’ID d’e-mail séparés par des virgules pour informer de la progression de l’opération de publication.

Response

Offres migrées

Location: /api/publishers/contoso/offers/contoso-offer/operations/56615b67-2185-49fe-80d2-c4ddf77bb2e8?api-version=2017-10-31

Offres non migrées

Location: /api/operations/contoso$contoso-offer$2$preview?api-version=2017-10-31

En-tête de réponse

Nom	Valeur
Emplacement	Chemin relatif permettant de récupérer l’état de cette opération.

Codes d’état de réponse

Code	Description
200	OK. La requête a été traitée avec succès et l’opération est annulée de manière synchrone.
202	Accepté. La requête a été traitée avec succès et l’opération est en cours d’annulation. L’emplacement de l’opération d’annulation est renvoyé dans l’en-tête de la réponse.
400	Requête inappropriée/mal formée. Le corps de la réponse d’erreur pourrait fournir plus d’informations.
403	Accès interdit. Le client n’a pas accès à l’espace de noms spécifié dans la requête.
404	Introuvable. L’entité spécifiée n’existe pas.

Partage via