Récupérer des opérations

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.

Récupère toutes les opérations sur l’offre ou pour obtenir une opération particulière pour la valeur operationId spécifiée. Le client peut utiliser des paramètres de requête pour filtrer sur les opérations en cours d’exécution.

GET https://cloudpartner.azure.com/api/publishers/<publisherId>/offers/<offerId>/operations/<operationId>?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
operationId	GUID qui identifie de façon unique l’opération sur l’offre. L’operationId peut être récupéré à l’aide de cette API et est également retourné dans l’en-tête HTTP de la réponse pour toute opération de longue durée, telle que l’API d’offre De publication.	Guid
api-version	Dernière version de l’API	Date

En-tête

Nom	Valeur
Type de contenu	application/json
Autorisation	Bearer YOUR_TOKEN

Exemple de corps

Response

Opérations GET

    [
        {
            "id": "5a63deb5-925b-4ee0-938b-7c86fbf287c5",
            "offerId": "56615b67-2185-49fe-80d2-c4ddf77bb2e8",
            "offerVersion": 1,
            "offerTypeId": "microsoft-azure-virtualmachines",
            "publisherId": "contoso",
            "submissionType": "publish",
            "submissionState": "running",
            "publishingVersion": 2,
            "slot": "staging",
            "version": 636576975611768314,
            "definition": {
                "metadata": {
                    "emails": "jdoe@contoso.com"
                }
            },
            "changedTime": "2018-03-26T21:46:01.179948Z"
        }
    ]

Opération GET

    [
        {
            "status" : "running",
            "messages" : [],
            "publishingVersion" : 2,
            "offerVersion" : 1,
            "cancellationRequestState": "canCancel",
            "steps": [
                        {
                            "estimatedTimeFrame": "< 15 min",
                            "id": "displaydummycertify",
                            "stepName": "Validate Pre-Requisites",
                            "description": "Offer settings provided are validated",
                            "status": "complete",
                            "messages": 
                            [
                                {
                                    "messageHtml": "Step completed.",
                                    "level": "information",
                                    "timestamp": "2017-03-28T19:50:36.500052Z"
                                }
                            ],
                            "progressPercentage": 100
                        },
                        {
                            "estimatedTimeFrame": "< 5 day",
                            "id": "displaycertify",
                            "stepName": "Certification",
                            "description": "Your offer is analyzed by our certification systems for issues.",
                            "status": "blocked",
                            "messages": 
                            [
                                {
                                    "messageHtml": "No virtual machine image was found for the plan contoso.",
                                    "level": "error",
                                    "timestamp": "2017-03-28T19:50:39.5506018Z"
                                },
                                {
                                    "messageHtml": "This step has not started yet.",
                                    "level": "information",
                                    "timestamp": "2017-03-28T19:50:39.5506018Z"
                                }
                            ],
                            "progressPercentage": 0
                        },
                        {
                            "estimatedTimeFrame": "< 1 day",
                            "id": "displayprovision",
                            "stepName": "Provisioning",
                            "description": "Your virtual machine is being replicated in our production systems.",
                            "status": "notStarted",
                            "messages": [],
                            "progressPercentage": 0
                        },
                        {
                            "estimatedTimeFrame": "< 1 hour",
                            "id": "displaypackage",
                            "stepName": "Packaging and Lead Generation Registration",
                            "description": "Your virtual machine is packaged for being shown to your customers. Additionally, we hookup our lead generation systems to send leads for your offer.",
                            "status": "notStarted",
                            "messages": [],
                            "progressPercentage": 0
                        },
                        {
                            "id": "publisher-signoff",
                            "stepName": "Publisher signoff",
                            "description": "Offer is available to preview. Ensure that everything looks good before making your offer live.",
                            "status": "notStarted",
                            "messages": [],
                            "progressPercentage": 0
                        },
                        {
                            "estimatedTimeFrame": "~2-5 days",
                            "id": "live",
                            "stepName": "Live",
                            "description": "Offer is publicly visible and is available for purchase.",
                            "status": "notStarted",
                            "messages": [],
                            "progressPercentage": 0
                        }
                    ],
                "previewLinks": [],
                "liveLinks": [],
            }
        }
    ]

Propriétés du corps de réponse

Nom	Description
id	GUID qui identifie de façon unique l’opération
submissionType	Identifie le type d’opération signalé pour l’offre, par exemple Publish/GoLive
createdDateTime	Date/heure UTC de création de l’opération
lastActionDateTime	Date/heure UTC de la dernière mise à jour de l’opération
statut	État de l’opération (not started | running | failed | completed). Une seule opération à la fois peut avoir l’état running.
error	Message d’erreur pour l’échec des opérations

Propriétés de l’étape de réponse

Nom	Description
estimatedTimeFrame	Durée estimée de cette opération
id	Identificateur unique du processus de l’étape
description	Description de l’étape
stepName	Nom convivial de l’étape
statut	État de l’étape, notStarted | running | failed | ou completed
Cloud vers appareil	Toute notification ou avertissement rencontré(e) lors de l’étape. Tableau de chaînes
progressPercentage	Entier compris entre 0 et 100 indiquant la progression de l’étape

Codes d’état de réponse

Code	Description
200	OK : la demande a été traitée et les opérations sont annulées de manière synchrone.
400	Bad/Malformed request - Le corps de la réponse d’erreur peut contenir plus d’informations.
403	Forbidden : le client n’a pas accès à l’espace de noms spécifié.
404	Not found : l’entité spécifiée n’existe pas.