Hämta avtalsmetadata för Microsoft-kundavtalet

Artikel
03/05/2024

Gäller för: Partnercenter

Gäller inte för: Partnercenter som drivs av 21Vianet | Partnercenter för Microsoft Cloud for US Government

Avtalsmetadata för Microsoft-kundavtal stöds för närvarande endast av Partnercenter i Microsofts offentliga moln.

Du måste hämta avtalsmetadata för Microsoft-kundavtal innan du kan:

Förutsättningar

Om du använder .NET SDK för Partnercenter krävs version 1.14 eller senare.

Viktigt!

Från och med juni 2023 arkiveras nu den senaste Partner Center .NET SDK-versionen 3.4.0. Du kan ladda ned SDK-versionen från GitHub tillsammans med en readme-fil som innehåller användbar information.

Partner uppmanas att fortsätta att använda REST-API:er för Partnercenter.
Autentiseringsuppgifter enligt beskrivningen i Partnercenter-autentisering. Det här scenariot stöder endast App+User-autentisering.

.NET (version 1.14 eller senare)

Så här hämtar du avtalsmetadata för Microsoft-kundavtal:

Hämta först samlingen IAggregatePartner.AgreementDetails.
Anropa ByAgreementType-metoden för att filtrera samlingen till Microsoft-kundavtal.
Anropa slutligen metoden Get eller GetAsync.

// IAggregatePartner partnerOperations;

string agreementType = "MicrosoftCustomerAgreement";

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

Ett fullständigt exempel finns i klassen GetAgreementDetails från konsoltestappprojektet .

REST-begäran

Så här hämtar du avtalsmetadata för Microsoft-kundavtal:

Skapa en REST-begäran för att hämta samlingen AgreementMetaData .
Använd frågeparametern agreementType för att begränsa resultatet till endast Microsoft-kundavtal.

Syntax för begäran

Metod	URI för förfrågan
GET	{baseURL}/v1/agreements?agreementType={agreement-type} HTTP/1.1

URI-parametrar

Använd följande URI-parametrar med din begäran:

Namn	Typ	Obligatoriskt	Beskrivning
avtalstyp	sträng	Nej	Använd den här parametern för att begränsa frågesvaret till en viss avtalstyp. De värden som stöds är: MicrosoftCloudAgreement som endast innehåller avtalsmetadata av typen MicrosoftCloudAgreement MicrosoftCustomerAgreement som endast innehåller avtalsmetadata av typen MicrosoftCustomerAgreement. * som returnerar alla avtalsmetadata. (Använd * inte om inte koden har nödvändig körningslogik för att hantera okända avtalstyper eftersom Microsoft kan introducera avtalsmetadata med nya avtalstyper när som helst.) Obs! Om URI-parametern inte har angetts, är frågan standard för MicrosoftCloudAgreement för bakåtkompatibilitet.

Begärandehuvuden

Mer information finns i REST-huvuden för Partnercenter.

Begärandetext

Inga.

Exempel på begäran

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-svar

Om det lyckas returnerar den här metoden en samling AgreementMetaData-resurser i svarstexten.

Svarsframgång och felkoder

Varje svar levereras med en HTTP-statuskod som anger lyckad eller misslyckad och annan felsökningsinformation.

Använd ett verktyg för nätverksspårning för att läsa den här koden, feltypen och andra parametrar. Den fullständiga listan finns i Rest-felkoder för Partnercenter.

Svarsexempel

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

Dela via