Udostępnij za pośrednictwem

Pobieranie metadanych umowy dla umowy klienta firmy Microsoft

  • Artykuł

Dotyczy: Centrum partnerskie

Nie dotyczy: Centrum partnerskie obsługiwane przez firmę 21Vianet | Centrum partnerskie dla chmury firmy Microsoft dla instytucji rządowych USA

Metadane umowy dla Umowa z Klientem Microsoft są obecnie obsługiwane przez Centrum partnerskie tylko w chmurze publicznej firmy Microsoft.

Aby można było wykonać następujące czynności, musisz pobrać metadane umowy dla Umowa z Klientem Microsoft:

Wymagania wstępne

  • Jeśli używasz zestawu .NET SDK Centrum partnerskiego, wymagana jest wersja 1.14 lub nowsza.

    Ważne

    Od czerwca 2023 r. najnowsza wersja zestawu .NET SDK Centrum partnerskiego 3.4.0 jest teraz archiwizowana. Możesz pobrać wersję zestawu SDK z usługi GitHub wraz z plikiem readme zawierającym przydatne informacje.

    Zachęcamy partnerów do dalszego korzystania z interfejsów API REST Centrum partnerskiego.

  • Poświadczenia zgodnie z opisem w temacie Uwierzytelnianie w Centrum partnerskim. Ten scenariusz obsługuje tylko uwierzytelnianie aplikacji i użytkownika.

.NET (wersja 1.14 lub nowsza)

Aby pobrać metadane umowy dla Umowa z Klientem Microsoft:

  1. Najpierw pobierz kolekcję IAggregatePartner.AgreementDetails .

  2. Wywołaj metodę ByAgreementType, aby przefiltrować kolekcję w celu Umowa z Klientem Microsoft.

  3. Na koniec wywołaj metodę Get lub GetAsync .

// IAggregatePartner partnerOperations;

string agreementType = "MicrosoftCustomerAgreement";

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

Kompletny przykład można znaleźć w klasie GetAgreementDetails z projektu aplikacji testowej konsoli.

Żądanie REST

Aby pobrać metadane umowy dla Umowa z Klientem Microsoft:

  1. Utwórz żądanie REST w celu pobrania kolekcji AgreementMetaData .

  2. Użyj parametru zapytania agreementType, aby ograniczyć zakres wyniku tylko do Umowa z Klientem Microsoft.

Składnia żądania

Method Identyfikator URI żądania
GET {baseURL}/v1/agreement?agreementType={agreement-type} HTTP/1.1

Parametry identyfikatora URI

Użyj następujących parametrów identyfikatora URI z żądaniem:

Nazwisko Type Wymagania opis
typ umowy string Nie Użyj tego parametru, aby określić zakres odpowiedzi zapytania na określony typ umowy. Obsługiwane wartości to:

MicrosoftCloudAgreement , który zawiera metadane umowy tylko typu MicrosoftCloudAgreement

MicrosoftCustomerAgreement , który zawiera metadane umowy tylko typu MicrosoftCustomerAgreement.

* zwraca wszystkie metadane umowy. (Nie używaj * , chyba że kod ma niezbędną logikę środowiska uruchomieniowego do obsługi nieznanych typów umów, ponieważ firma Microsoft może wprowadzać metadane umowy z nowymi typami umów w dowolnym momencie).

Uwaga: jeśli parametr URI nie jest określony, zapytanie jest domyślnie ustawione na MicrosoftCloudAgreement w celu zapewnienia zgodności z poprzednimi wersjami.

Nagłówki żądań

Aby uzyskać więcej informacji, zobacz Nagłówki REST Centrum partnerskiego.

Treść żądania

Brak.

Przykład żądania

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

Odpowiedź REST

Jeśli ta metoda powiedzie się, zwraca kolekcję zasobów AgreementMetaData w treści odpowiedzi.

Kody powodzenia i błędów odpowiedzi

Każda odpowiedź zawiera kod stanu HTTP, który wskazuje powodzenie lub niepowodzenie i inne informacje o debugowaniu.

Użyj narzędzia do śledzenia sieci, aby odczytać ten kod, typ błędu i inne parametry. Aby uzyskać pełną listę, zobacz Kody błędów REST Centrum partnerskiego.

Przykład odpowiedzi

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