Metagegevens van de overeenkomst voor de Microsoft-klantovereenkomst ophalen

  • Artikel

Van toepassing op: Partnercentrum

Is niet van toepassing op: Partnercentrum beheerd door 21Vianet | Partnercentrum voor Microsoft Cloud voor de Amerikaanse overheid

Metagegevens van overeenkomsten voor Microsoft-klantovereenkomst worden momenteel alleen ondersteund door partnercentrum in de openbare Cloud van Microsoft.

U moet de metagegevens van de overeenkomst voor de Microsoft-klantovereenkomst ophalen voordat u het volgende kunt doen:

Vereisten

  • Als u de .NET SDK van Partnercentrum gebruikt, is versie 1.14 of hoger vereist.

    Belangrijk

    Vanaf juni 2023 wordt de nieuwste Versie van Partner Center .NET SDK 3.4.0 gearchiveerd. U kunt de SDK-release downloaden van GitHub, samen met een leesmij-bestand dat nuttige informatie bevat.

    Partners worden aangemoedigd om de REST API's van partnercentrum te blijven gebruiken.

  • Referenties zoals beschreven in verificatie in partnercentrum. Dit scenario biedt alleen ondersteuning voor App+User-verificatie.

.NET (versie 1.14 of hoger)

De metagegevens van de overeenkomst voor Microsoft-klantovereenkomst ophalen:

  1. Haal eerst de verzameling IAggregatePartner.AgreementDetails op.

  2. Roep de methode ByAgreementType aan om de verzameling te filteren op Microsoft-klantovereenkomst.

  3. Roep tot slot de get - of GetAsync-methode aan.

// IAggregatePartner partnerOperations;

string agreementType = "MicrosoftCustomerAgreement";

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

Een volledig voorbeeld vindt u in de klasse GetAgreementDetails van het consoletest-app-project .

REST-aanvraag

De metagegevens van de overeenkomst voor Microsoft-klantovereenkomst ophalen:

  1. Maak een REST-aanvraag om de AgreementMetaData-verzameling op te halen.

  2. Gebruik de queryparameter agreementType om het resultaat alleen te beperken tot de Microsoft-klantovereenkomst.

Aanvraagsyntaxis

Methode Aanvraag-URI
GET {baseURL}/v1/agreements?agreementType={agreement-type} HTTP/1.1

URI-parameters

Gebruik de volgende URI-parameters voor uw aanvraag:

Name Type Vereist Beschrijving
overeenkomsttype tekenreeks Nee Gebruik deze parameter om het bereik van het queryantwoord op een specifiek overeenkomsttype te bepalen. De ondersteunde waarden zijn:

MicrosoftCloudAgreement met alleen metagegevens van overeenkomst van het type MicrosoftCloudAgreement

MicrosoftCustomerAgreement dat alleen metagegevens van de overeenkomst bevat van het type MicrosoftCustomerAgreement.

* die alle metagegevens van de overeenkomst retourneert. (Gebruik deze optie alleen * als uw code de benodigde runtimelogica heeft om niet-bekende overeenkomsttypen af te handelen, omdat Microsoft op elk gewenst moment metagegevens van overeenkomsten kan introduceren met nieuwe overeenkomsttypen.)

Opmerking: Als de URI-parameter niet is opgegeven, wordt de query standaard ingesteld op MicrosoftCloudAgreement voor achterwaartse compatibiliteit.

Aanvraagheaders

Zie Rest-headers in Partnercentrum voor meer informatie.

Aanvraagtekst

Geen.

Aanvraagvoorbeeld

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

REST-antwoord

Als dit lukt, retourneert deze methode een verzameling AgreementMetaData-resources in de hoofdtekst van het antwoord.

Geslaagde antwoorden en foutcodes

Elk antwoord wordt geleverd met een HTTP-statuscode die aangeeft dat de fout is geslaagd of mislukt en andere informatie over foutopsporing.

Gebruik een hulpprogramma voor netwerktracering om deze code, het fouttype en andere parameters te lezen. Zie rest-foutcodes in Partnercentrum voor de volledige lijst.

Responsvoorbeeld

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"
    }
}