Získání metadat smluv pro Smlouvu se zákazníkem Microsoftu

  • Článek

Platí pro: Partnerské centrum

Nevztahuje se na: Partnerské centrum provozované společností 21Vianet | Partnerské centrum pro Microsoft Cloud pro státní správu USA

Metadata smlouvy pro Smlouva se zákazníkem Microsoftu jsou v současné době podporována v Partnerském centru pouze ve veřejném cloudu Microsoftu.

Než budete moct, musíte načíst metadata smlouvy pro Smlouva se zákazníkem Microsoftu:

Požadavky

  • Pokud používáte sadu .NET SDK partnerského centra, vyžaduje se verze 1.14 nebo novější.

    Důležité

    Od června 2023 se teď archivuje nejnovější verze sady .NET SDK partnerského centra 3.4.0. Vydání sady SDK si můžete stáhnout z GitHubu spolu se souborem readme, který obsahuje užitečné informace.

    Doporučujeme, aby partneři dál používali rozhraní REST API Partnerského centra.

  • Přihlašovací údaje popsané v ověřování v Partnerském centru Tento scénář podporuje pouze ověřování aplikací a uživatelů.

.NET (verze 1.14 nebo novější)

Načtení metadat smlouvy pro Smlouva se zákazníkem Microsoftu:

  1. Nejprve načtěte kolekci IAggregatePartner.AgreementDetails .

  2. Volání ByAgreementType metoda filtrování kolekce na Smlouva se zákazníkem Microsoftu.

  3. Nakonec volejte metodu Get nebo GetAsync .

// IAggregatePartner partnerOperations;

string agreementType = "MicrosoftCustomerAgreement";

var microsoftCustomerAgreementDetails = partnerOperations.AgreementDetails.ByAgreementType(agreementType).Get().Items.Single();

Kompletní ukázku najdete ve třídě GetAgreementDetails z projektu testovací aplikace konzoly.

Požadavek REST

Načtení metadat smlouvy pro Smlouva se zákazníkem Microsoftu:

  1. Vytvořte požadavek REST pro načtení kolekce AgreementMetaData .

  2. K určení rozsahu výsledku použijte parametr dotazu agreementType pouze na Smlouva se zákazníkem Microsoftu.

Syntaxe požadavku

metoda Identifikátor URI žádosti
GET {baseURL}/v1/agreements?agreementType={agreement-type} HTTP/1.1

Parametry identifikátoru URI

V požadavku použijte následující parametry identifikátoru URI:

Name Type Požadováno Popis
typ smlouvy string No Tento parametr použijte k určení rozsahu odpovědi dotazu na konkrétní typ smlouvy. Podporované hodnoty jsou:

MicrosoftCloudAgreement , který obsahuje pouze metadata smlouvy typu MicrosoftCloudAgreement

MicrosoftCustomerAgreement , který obsahuje metadata smlouvy pouze typu MicrosoftCustomerAgreement.

* vrátí všechna metadata smlouvy. (Nepoužívejte * , pokud váš kód nemá potřebnou logiku modulu runtime pro zpracování neznámých typů smluv, protože Microsoft může kdykoli zavést metadata smlouvy s novými typy smluv.)

Poznámka: Pokud není zadaný parametr URI, nastaví se ve výchozím nastavení dotazu MicrosoftCloudAgreement pro zpětnou kompatibilitu.

Záhlaví žádosti

Další informace najdete v tématu Hlavičky REST Partnerského centra.

Text požadavku

Nezaokrouhlovat.

Příklad požadavku

GET https://api.partnercenter.microsoft.com/v1/agreements?agreementType=MicrosoftCustomerAgreement HTTP/1.1
Authorization: Bearer <token>
Accept: application/json
MS-RequestId: 94e4e214-6b06-4fb7-96d1-94d559f9b47f
MS-CorrelationId: ab993325-1605-4cf4-bac4-fb584142a31b

Odpověď REST

V případě úspěchu vrátí tato metoda kolekci prostředků AgreementMetaData v těle odpovědi.

Kódy úspěšnosti a chyb odpovědi

Každá odpověď obsahuje stavový kód HTTP, který označuje úspěch nebo selhání a další informace o ladění.

Ke čtení tohoto kódu, typu chyby a dalších parametrů použijte nástroj pro trasování sítě. Úplný seznam najdete v tématu Kódy chyb REST v Partnerském centru.

Příklad odpovědi

HTTP/1.1 200 OK
Content-Length: 620
Content-Type: application/json
MS-RequestId: 94e4e214-6b06-4fb7-96d1-94d559f9b47f
MS-CorrelationId: ab993325-1605-4cf4-bac4-fb584142a31b
{
    "totalCount": 1,
    "items": [
        {
            "templateId": "117a77b0-9360-443b-8795-c6dedc750cf9",
            "agreementType": "MicrosoftCustomerAgreement",
            "agreementLink": "https://aka.ms/customeragreement",
            "versionRank": 0
        }
    ],
    "attributes": {
        "objectType": "Collection"
    }
}