Pobieranie konkretnej oferty

Uwaga

Interfejsy API portalu Cloud Partner Portal są zintegrowane z usługą i będą nadal działać w Centrum partnerskim. Przejście wprowadza niewielkie zmiany. Przejrzyj zmiany wymienione w dokumentacji interfejsu API portalu Cloud Partner Portal, aby upewnić się, że kod będzie nadal działać po przejściu do Centrum partnerskiego. Interfejsy API CPP powinny być używane tylko dla istniejących produktów, które zostały już zintegrowane przed przejściem do Centrum partnerskiego; nowe produkty powinny używać interfejsów API przesyłania w Centrum partnerskim.

Pobiera określoną ofertę w przestrzeni nazw wydawcy.

Możesz również pobrać określoną wersję oferty lub pobrać ofertę w wersji roboczej, widoku lub miejscach produkcyjnych. Jeśli miejsce nie zostanie określone, wartość domyślna to draft. Próba pobrania oferty, która nie została w wersji zapoznawczej lub opublikowana, spowoduje wystąpienie błędu 404 Not Found .

Ostrzeżenie

Wartości wpisów tajnych dla pól typu wpisu tajnego nie zostaną pobrane przez ten interfejs API.

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

Parametry identyfikatora URI

Nazwa/nazwisko Opis Typ danych
publisherId publisherId. Na przykład Contoso String
offerId Identyfikator GUID, który jednoznacznie identyfikuje ofertę. String
version Wersja pobieranej oferty. Domyślnie pobierana jest najnowsza wersja oferty. Integer
slotId Miejsce, z którego ma zostać pobrana oferta, może być jednym z następujących elementów:
- Draft (ustawienie domyślne) pobiera wersję oferty obecnie w wersji roboczej.
- Preview pobiera wersję oferty obecnie w wersji zapoznawczej.
- Production pobiera wersję oferty obecnie w środowisku produkcyjnym.
wyliczenie
api-version Najnowsza wersja interfejsu API Data
Nazwa/nazwisko Wartość
Typ zawartości application/json
Autoryzacja Bearer YOUR_TOKEN

Przykład treści

Response

{
    "offerTypeId": "microsoft-azure-virtualmachines",
    "publisherId": "contoso",
    "status": "failed",
    "id": "059afc24-07de-4126-b004-4e42a51816fe",
    "version": 5,
    "definition": {
        "displayText": "Contoso Virtual Machine Offer",
        "offer": {
            "microsoft-azure-marketplace-testdrive.enabled": false,
            "microsoft-azure-marketplace-testdrive.videos": [],
            "microsoft-azure-marketplace.title": "Contoso App",
            "microsoft-azure-marketplace.summary": "Contoso App makes dev ops a breeze",
            "microsoft-azure-marketplace.longSummary": "Contoso App makes dev ops a breeze",
            "microsoft-azure-marketplace.description": "Contoso App makes dev ops a breeze",
            "microsoft-azure-marketplace.offerMarketingUrlIdentifier": "contosoapp",
            "microsoft-azure-marketplace.allowedSubscriptions": [
                "59160c40-2e25-4dcf-a2fd-6514cb08bf08"
            ],
            "microsoft-azure-marketplace.usefulLinks": [
            {
                "linkTitle": "Contoso App for Azure",
                "linkUrl": "https://azuremarketplace.microsoft.com"
            }
            ],
                "microsoft-azure-marketplace.categoryMap": [
                {
                "categoryL1": "analytics",
                "categoryL2-analytics": [
                "visualization-and-reporting"
                ]
                },
                {
                "categoryL1": "ai-plus-machine-learning",
                "categoryL2-ai-plus-machine-learning": [
                "bot-services",
                "cognitive-services",
                "other"
                ]
                }
            ],
            "microsoft-azure-marketplace.smallLogo": "https://publishingapistore.blob.core.windows.net/testcontent/D6191_publishers_contoso/contosovirtualmachine/6218c455-9cbc-450c-9920-f2e7a69ee132.png?sv=2014-02-14&sr=b&sig=6O8MM9dgiJ48VK0MwddkyVbprRAnBszyhVkVHGShhkI%3D&se=2019-03-28T19%3A46%3A50Z&sp=r",
            "microsoft-azure-marketplace.mediumLogo": "https://publishingapistore.blob.core.windows.net/testcontent/D6191_publishers_contoso/contosovirtualmachine/557e714b-2f31-4e12-b0cc-e48dd840edf4.png?sv=2014-02-14&sr=b&sig=NwL67NTQf9Gc9VScmZehtbHXpYmxhwZc2foy3o4xavs%3D&se=2019-03-28T19%3A46%3A49Z&sp=r",
            "microsoft-azure-marketplace.largeLogo": "https://publishingapistore.blob.core.windows.net/testcontent/D6191_publishers_contoso/contosovirtualmachine/142485da-784c-44cb-9523-d4f396446258.png?sv=2014-02-14&sr=b&sig=xaMxhwx%2FlKYfz33mJGIg8UBdVpsOwVvqhjTJ883o0iY%3D&se=2019-03-28T19%3A46%3A49Z&sp=r",
            "microsoft-azure-marketplace.wideLogo": "https://publishingapistore.blob.core.windows.net/testcontent/D6191_publishers_contoso/contosovirtualmachine/48af9013-1df7-4c94-8da8-4626e5039ce0.png?sv=2014-02-14&sr=b&sig=%2BnN7f2tprkrqb45ID6JlT01zXcy1PMTkWXtLKD6nfoE%3D&se=2019-03-28T19%3A46%3A49Z&sp=r",
            "microsoft-azure-marketplace.screenshots": [],
            "microsoft-azure-marketplace.videos": [],
            "microsoft-azure-marketplace.leadDestination": "None",
            "microsoft-azure-marketplace.tableLeadConfiguration": {},
            "microsoft-azure-marketplace.blobLeadConfiguration": {},
            "microsoft-azure-marketplace.salesForceLeadConfiguration": {},
            "microsoft-azure-marketplace.crmLeadConfiguration": {},
            "microsoft-azure-marketplace.httpsEndpointLeadConfiguration": {},
            "microsoft-azure-marketplace.marketoLeadConfiguration": {},
            "microsoft-azure-marketplace.privacyURL": "https://azuremarketplace.microsoft.com",
            "microsoft-azure-marketplace.termsOfUse": "Terms of use",
            "microsoft-azure-marketplace.engineeringContactName": "Jon Doe",
            "microsoft-azure-marketplace.engineeringContactEmail": "jondoe@outlook.com",
            "microsoft-azure-marketplace.engineeringContactPhone": "555-555-5555",
            "microsoft-azure-marketplace.supportContactName": "Jon Doe",
            "microsoft-azure-marketplace.supportContactEmail": "jondoe@outlook.com",
            "microsoft-azure-marketplace.supportContactPhone": "555-555-5555",
            "microsoft-azure-marketplace.publicAzureSupportUrl": "",
            "microsoft-azure-marketplace.fairfaxSupportUrl": ""
            },
            "plans": [
            {
                "planId": "contososkuidentifier",
                "microsoft-azure-virtualmachines.skuTitle": "Contoso App",
                "microsoft-azure-virtualmachines.skuSummary": "Contoso App makes dev ops a breeze.",
                "microsoft-azure-virtualmachines.skuDescription": "This is a description for the Contoso App that makes dev ops a breeze.",
                "microsoft-azure-virtualmachines.hideSKUForSolutionTemplate": false,
                "microsoft-azure-virtualmachines.cloudAvailability": [
                    "PublicAzure"
                ],
                "microsoft-azure-virtualmachines.certificationsFairfax": [],
                "virtualMachinePricing": {
                    "isByol": true,
                    "freeTrialDurationInMonths": 0
                },
                "microsoft-azure-virtualmachines.operatingSystemFamily": "Windows",
                "microsoft-azure-virtualmachines.windowsOSType": "Other",
                "microsoft-azure-virtualmachines.operationSystem": "Contoso App",
                "microsoft-azure-virtualmachines.recommendedVMSizes": [
                    "a0-basic",
                    "a0-standard",
                    "a1-basic",
                    "a1-standard",
                    "a2-basic",
                    "a2-standard"
                ],
                "microsoft-azure-virtualmachines.openPorts": [],
                "microsoft-azure-virtualmachines.vmImages": {
                    "1.0.1": {
                    "osVhdUrl": "http://contosoteststorage.blob.core.windows.net/test/contosoVM.vhd?sv=2014-02-14&sig=WlDo6Q4xwYH%2B5QEJbItPUVdgHhBcrVxPBmntZ2vU96w%3D&st=2016-06-25T18%3A30%3A00Z&se=2017-06-25T18%3A30%3A00Z&sp=rl",
                    "lunVhdDetails": []
                    }
                },
                "regions": [
                    "DZ",
                    "AR"
                ]
            }
            ]
        },
        "changedTime": "2017-06-07T06:15:39.7349221Z"
    }
}

Właściwości treści odpowiedzi

Nazwa/nazwisko Opis
offerTypeId Określa typ oferty
publisherId Unikatowy identyfikator wydawcy
status Stan oferty. Aby uzyskać listę możliwych wartości, zobacz Stan oferty.
Id Identyfikator GUID, który jednoznacznie identyfikuje ofertę
version Bieżąca wersja oferty. Nie można zmodyfikować właściwości wersji przez klienta. Jest zwiększana po każdym opublikowaniu.
Definicji Rzeczywista definicja obciążenia
changedTime data/godzina UTC ostatniej modyfikacji oferty

Kody stanu odpowiedzi

Kod Opis
200 OK — Żądanie zostało pomyślnie przetworzone, a wszystkie oferty w ramach wydawcy zostały zwrócone klientowi.
400 Bad/Malformed request — Treść odpowiedzi na błąd może zawierać więcej informacji.
403 Forbidden — Klient nie ma dostępu do określonej przestrzeni nazw.
404 Not found - Określona jednostka nie istnieje. Klient powinien sprawdzić identyfikator publisherId, offerId i wersję (jeśli określono).

Stan oferty

Nazwa/nazwisko Opis
NeverPublished Oferta nigdy nie została opublikowana.
Nierozpoczęte Oferta jest nowa, ale nie została uruchomiona.
OczekiwanieForPublisherReview Oferta czeka na zatwierdzenie wydawcy.
Uruchomiono Przesyłanie oferty jest przetwarzane.
Powodzenie Przetwarzanie przesyłania oferty zostało zakończone.
Anulowany Przesyłanie oferty zostało anulowane.
Nie działa Przesyłanie oferty nie powiodło się.