Abrufen von Vertragsmetadaten für den Microsoft Cloud-Vertrag

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

Die AgreementMetaData-Ressource wird derzeit nur vom Partner Center in der öffentlichen Microsoft-Cloud unterstützt.

Die Microsoft-Kundenvereinbarung die Microsoft Cloud Agreement ab 2021 ersetzt. Wenn Ihr Kunde zuvor einen Microsoft Cloud Agreement unterzeichnet hat, ist der letzte bekannte Vertragsverlauf zusätzlich zu Microsoft-Kundenvereinbarung Verlauf verfügbar..

Voraussetzungen

  • Wenn Sie das Partner Center .NET SDK verwenden, ist Version 1.9 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.

  • Wenn Sie das Partner Center Java SDK verwenden, ist Version 1.8 oder höher erforderlich.

  • Anmeldeinformationen, wie unter Partner Center-Authentifizierung beschrieben. Dieses Szenario unterstützt die App+ Benutzerauthentifizierung.

.NET (Version 1.14 oder höher)

So rufen Sie die Vereinbarungsmetadaten für microsoft Cloud Agreement ab:

  1. Rufen Sie zunächst die IAggregatePartner.AgreementDetails-Auflistung ab.

  2. Rufen Sie die ByAgreementType-Methode auf, um die Auflistung nach Microsoft Cloud Agreement.++++++++++++++++++++++++

  3. Rufen Sie schließlich die Get- oder GetAsync-Methode auf.

// IAggregatePartner partnerOperations;

string agreementType = "MicrosoftCloudAgreement";

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

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

.NET (Version 1.9 - 1.13)

So rufen Sie Vereinbarungsmetadaten für den Microsoft-Cloudvertrag ab:

Rufen Sie zuerst die IAggregatePartner.AgreementDetails-Auflistung ab, und rufen Sie dann die Get - oder GetAsync-Methoden auf. Suchen Sie dann nach dem Element in der Sammlung, das dem Microsoft Cloud Agreement entspricht:

// IAggregatePartner partnerOperations;

var agreements = partnerOperations.AgreementDetails.Get();

AgreementMetaData microsoftCloudAgreement = agreements.Items.FirstOrDefault (agr => agr.AgreementType == AgreementType.MicrosoftCloudAgreement);

Java

Das Partner Center Java SDK kann zum Verwalten von Partner Center-Ressourcen verwendet werden. Es handelt sich um ein Open-Source-Projekt, Standard von der Partnercommunity unterstützt und nicht offiziell von Microsoft unterstützt wird. Sie können Hilfe von der Community erhalten oder ein Issue auf GitHub öffnen, wenn ein Problem auftritt.

So rufen Sie Vereinbarungsmetadaten für den Microsoft-Cloudvertrag ab:

Rufen Sie zuerst die Funktion "IAggregatePartner.getAgreementDetails " auf, und rufen Sie dann die Get-Funktion auf. Suchen Sie dann nach dem Element in der Sammlung, das dem Microsoft Cloud Agreement entspricht:

// IAggregatePartner partnerOperations;

ResourceCollection<AgreementMetaData> agreements = partnerOperations.getAgreements().get();

AgreementMetaData microsoftCloudAgreement;

for (AgreementMetaData metadata : agreements)
{
    if(metadata.getAgreementType() == AgreementType.MicrosoftCloudAgreement)
    {
        microsoftCloudAgreement = metadata;
    }
}

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

PowerShell

Das Partner Center PowerShell-Modul kann zum Verwalten von Partner Center-Ressourcen verwendet werden. Es handelt sich um ein Open-Source-Projekt, Standard von der Partnercommunity unterstützt und nicht offiziell von Microsoft unterstützt wird. Sie können Hilfe von der Community erhalten oder ein Issue auf GitHub öffnen, wenn ein Problem auftritt.

So rufen Sie Vereinbarungsmetadaten für den Microsoft-Cloudvertrag ab:

Verwenden Sie den Befehl "Get-PartnerAgreementDetail ". Suchen Sie dann nach dem Element in der Sammlung, das dem Microsoft Cloud Agreement entspricht:

Get-PartnerAgreementDetail | Where-Object {$_.AgreementType -eq 'MicrosoftCloudAgreement'} | Select-Object -First 1

REST-Anforderung

Um Vereinbarungsmetadaten für Microsoft Cloud Agreement abzurufen, erstellen Sie zuerst eine REST-Anforderung zum Abrufen der AgreementMetaData-Auflistung . Suchen Sie dann nach dem Element in der Sammlung, das dem Microsoft Cloud Agreement entspricht.

Anforderungssyntax

Methode Anforderungs-URI
GET {baseURL}/v1/agreements 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 HTTP/1.1
Authorization: Bearer <token>
Accept: application/json
MS-RequestId: 94e4e214-6b06-4fb7-96d1-94d559f9b47f
MS-CorrelationId: ab993325-1605-4cf4-bac4-fb584142a31b

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: ab993325-1605-4cf4-bac4-fb584142a31b
{
    "totalCount": 1,
    "items": [
        {
            "templateId": "998b88de-aa99-4388-a42c-1b3517d49490",
            "agreementType": "MicrosoftCloudAgreement",
            "agreementLink": "https://learn.microsoft.com/partner-center/agreements",
            "versionRank": 0
        }
    ],
    "links": {
        "self": {
            "uri": "/agreements",
            "method": "GET",
            "headers": []
        }
    },
    "attributes": {
        "objectType": "Collection"
    }
}

Um die Ressource in der Antwort zu identifizieren, die dem Microsoft Cloud Agreement entspricht, suchen Sie nach der Ressource, deren agreementType-Eigenschaft den Wert "MicrosoftCloudAgreement" aufweist.