Delen via


Bewerkingen ophalen

Notitie

De Cloud Partner Portal-API's zijn geïntegreerd met en blijven werken in partnercentrum. De overgang introduceert kleine wijzigingen. Bekijk de wijzigingen die worden vermeld in de API-naslaginformatie voor de Cloud Partner-portal om ervoor te zorgen dat uw code blijft werken na de overgang naar Het Partnercentrum. CPP-API's mogen alleen worden gebruikt voor bestaande producten die al vóór de overgang naar partnercentrum zijn geïntegreerd; nieuwe producten moeten gebruikmaken van api's voor het indienen van partnercentrums.

Hiermee haalt u alle bewerkingen voor de aanbieding op of haalt u een bepaalde bewerking op voor de opgegeven operationId. De client kan queryparameters gebruiken om te filteren op actieve bewerkingen.

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

URI-parameters

Naam Beschrijving Gegevenstype
publisherId Publisher-id, bijvoorbeeld Contoso String
offerId Aanbiedings-id String
operationId GUID waarmee de bewerking voor de aanbieding uniek wordt geïdentificeerd. De operationId kan worden opgehaald met behulp van deze API en wordt ook geretourneerd in de HTTP-header van het antwoord voor langdurige bewerkingen, zoals de API voor het publiceren van aanbiedingen . Guid
api-versie Nieuwste versie van API Datum
Naam Value
Inhoudstype application/json
Autorisatie Bearer YOUR_TOKEN

Voorbeeld van hoofdtekst

Respons

GET-bewerkingen

    [
        {
            "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"
        }
    ]

GET-bewerking

    [
        {
            "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": [],
            }
        }
    ]

Eigenschappen van antwoordtekst

Naam Beschrijving
id GUID waarmee de bewerking uniek wordt geïdentificeerd
submissionType Identificeert het type bewerking dat wordt gerapporteerd voor de aanbieding, bijvoorbeeld Publish/GoLive
createdDateTime UTC-datum/tijd waarop de bewerking is gemaakt
lastActionDateTime UTC-datum/tijd waarop de laatste update is uitgevoerd voor de bewerking
status Status van de bewerking, ofwel not startedcompleted | | running | failed. Slechts één bewerking kan status running tegelijk hebben.
error Foutbericht voor mislukte bewerkingen

Eigenschappen van antwoordstap

Naam Beschrijving
estimatedTimeFrame De geschatte duur van deze bewerking
id De unieke id voor het stapproces
beschrijving Beschrijving van de stap
stepName De beschrijvende naam voor de stap
status De status van de stap, ofwel notStarted | running | failed | completed
messages Eventuele meldingen of waarschuwingen die tijdens de stap zijn opgetreden. Matrix tekenreeksen
progressPercentage Een geheel getal van 0 tot 100 dat de voortgang van de stap aangeeft

Antwoordstatuscodes

Code Beschrijving
200 OK - De aanvraag is verwerkt en de aangevraagde bewerkingen zijn geretourneerd.
400 Bad/Malformed request - De hoofdtekst van het foutbericht kan meer informatie bevatten.
403 Forbidden - De client heeft geen toegang tot de opgegeven naamruimte.
404 Not found - De opgegeven entiteit bestaat niet.