Abrufen von Vertragsmetadaten für den Microsoft-Kundenvertrag

Artikel
03/05/2024

Gilt für: Partner Center

Gilt nicht für: Partner Center | Partner Center-Betrieb durch 21Vianet | Partner Center für Microsoft Cloud for US Government

Vereinbarungsmetadaten für Microsoft-Kundenvereinbarung werden derzeit nur von Partner Center in der öffentlichen Microsoft-Cloud unterstützt.

Sie müssen die Vereinbarungsmetadaten für die Microsoft-Kundenvereinbarung abrufen, bevor Sie folgende Aktionen ausführen können:

Voraussetzungen

Wenn Sie das Partner Center .NET SDK verwenden, ist Version 1.14 oder höher erforderlich.

Wichtig

Ab Juni 2023 ist jetzt die neueste Partner Center .NET SDK-Version 3.4.0 archiviert. Sie können das SDK-Release von GitHub zusammen mit einer Infodatei herunterladen, die nützliche Informationen enthält.

Partnern wird empfohlen, weiterhin die Partner Center-REST-APIs zu verwenden.
Anmeldeinformationen, wie unter Partner Center-Authentifizierung beschrieben. Dieses Szenario unterstützt nur die App+Benutzerauthentifizierung.

.NET (Version 1.14 oder höher)

So rufen Sie die Vereinbarungsmetadaten für Microsoft-Kundenvereinbarung ab:

Rufen Sie zunächst die IAggregatePartner.AgreementDetails-Auflistung ab.
Rufen Sie die ByAgreementType-Methode auf, um die Auflistung nach Microsoft-Kundenvereinbarung zu filtern.
Rufen Sie schließlich die Get- oder GetAsync-Methode auf.

// IAggregatePartner partnerOperations;

string agreementType = "MicrosoftCustomerAgreement";

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

Ein vollständiges Beispiel finden Sie in der GetAgreementDetails-Klasse aus dem Konsolentest-App-Projekt .

REST-Anforderung

So rufen Sie die Vereinbarungsmetadaten für Microsoft-Kundenvereinbarung ab:

Erstellen Sie eine REST-Anforderung zum Abrufen der AgreementMetaData-Auflistung .
Verwenden Sie den agreementType-Abfrageparameter, um das Ergebnis nur auf die Microsoft-Kundenvereinbarung zu beschränken.

Anforderungssyntax

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

URI-Parameter

Verwenden Sie die folgenden URI-Parameter mit Ihrer Anforderung:

Name	Type	Erforderlich	Beschreibung
Vereinbarungstyp	Zeichenfolge	No	Verwenden Sie diesen Parameter, um die Abfrageantwort auf einen bestimmten Vertragstyp festzulegen. Die unterstützten Werte sind: MicrosoftCloudAgreement , das nur Vereinbarungsmetadaten vom Typ "MicrosoftCloudAgreement" enthält MicrosoftCustomerAgreement , das nur Vereinbarungsmetadaten vom Typ "MicrosoftCustomerAgreement" enthält. * die alle Vereinbarungsmetadaten zurückgibt. (Verwenden * Sie diese Option nicht, es sei denn, Ihr Code verfügt über die erforderliche Laufzeitlogik, um unbekannten Vertragstypen zu verarbeiten, da Microsoft jederzeit Vertragsmetadaten mit neuen Vertragstypen einführen kann.) Hinweis: Wenn der URI-Parameter nicht angegeben ist, wird die Abfrage standardmäßig für Die Abwärtskompatibilität auf MicrosoftCloudAgreement festgelegt.

Anforderungsheader

Weitere Informationen finden Sie unter Partner Center-REST-Header.

Anforderungstext

Keine.

Beispiel für eine Anfrage

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: aaaa0000-bb11-2222-33cc-444444dddddd

REST-Antwort

Bei erfolgreicher Ausführung gibt die Methode eine Sammlung von AgreementMetaData-Ressourcen im Antworttext zurück.

Erfolgs- und Fehlercodes der Antwort

Jede Antwort enthält einen HTTP-Statuscode, der Erfolg oder Fehler und andere Debuginformationen angibt.

Verwenden Sie ein Netzwerkablaufverfolgungstool, um diesen Code, fehlertyp und andere Parameter zu lesen. Die vollständige Liste finden Sie unter Partner Center-REST-Fehlercodes.

Beispielantwort

HTTP/1.1 200 OK
Content-Length: 620
Content-Type: application/json
MS-RequestId: 94e4e214-6b06-4fb7-96d1-94d559f9b47f
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
{
    "totalCount": 1,
    "items": [
        {
            "templateId": "aaaabbbb-0000-cccc-1111-dddd2222eeee",
            "agreementType": "MicrosoftCustomerAgreement",
            "agreementLink": "https://aka.ms/customeragreement",
            "versionRank": 0
        }
    ],
    "attributes": {
        "objectType": "Collection"
    }
}

Freigeben über