Ottenere i metadati per il contratto del cliente Microsoft

Articolo
03/05/2024

Si applica a: Centro per i partner

Non si applica a: Centro per i partner gestito da 21Vianet | Centro per i partner per Microsoft Cloud per il governo degli Stati Uniti

I metadati del contratto per Contratto del cliente Microsoft sono attualmente supportati dal Centro per i partner solo nel cloud pubblico Microsoft.

È necessario recuperare i metadati del contratto per il Contratto del cliente Microsoft prima di poter:

Prerequisiti

Se si usa .NET SDK del Centro per i partner, è necessaria la versione 1.14 o successiva.

Importante

A partire da giugno 2023, la versione più recente di .NET SDK del Centro per i partner 3.4.0 è ora archiviata. È possibile scaricare la versione dell'SDK da GitHub, insieme a un file leggimi che contiene informazioni utili.

I partner sono invitati a continuare a usare le API REST del Centro per i partner.
Credenziali descritte in Autenticazione del Centro per i partner. Questo scenario supporta solo l'autenticazione app+utente.

.NET (versione 1.14 o successiva)

Per recuperare i metadati del contratto per Contratto del cliente Microsoft:

Recuperare prima di tutto l'insieme IAggregatePartner.AgreementDetails .
Chiamare il metodo ByAgreementType per filtrare la raccolta in modo da Contratto del cliente Microsoft.
Infine, chiamare il metodo Get o GetAsync .

// IAggregatePartner partnerOperations;

string agreementType = "MicrosoftCustomerAgreement";

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

Un esempio completo è disponibile nella classe GetAgreementDetails del progetto di app di test della console.

Richiesta REST

Per recuperare i metadati del contratto per Contratto del cliente Microsoft:

Creare una richiesta REST per recuperare la raccolta AgreementMetaData .
Usare il parametro di query agreementType per definire l'ambito del risultato solo per il Contratto del cliente Microsoft.

Sintassi della richiesta

metodo	URI della richiesta
GET	{baseURL}/v1/agreements?agreementType={agreement-type} HTTP/1.1

Parametri URI

Usare i parametri URI seguenti con la richiesta:

Nome	Digita	Obbligatorio	Descrizione
tipo di contratto	string	No	Usare questo parametro per definire l'ambito della risposta di query a un tipo di contratto specifico. I valori supportati sono: MicrosoftCloudAgreement che include solo i metadati del contratto del tipo MicrosoftCloudAgreement MicrosoftCustomerAgreement che include i metadati del contratto solo del tipo MicrosoftCustomerAgreement. * che restituisce tutti i metadati del contratto. Non usare * a meno che il codice non abbia la logica di runtime necessaria per gestire i tipi di contratto sconosciuti perché Microsoft potrebbe introdurre metadati di contratto con nuovi tipi di contratto in qualsiasi momento. Nota: se il parametro URI non è specificato, per impostazione predefinita la query è MicrosoftCloudAgreement per la compatibilità con le versioni precedenti.

Intestazioni delle richieste

Per altre informazioni, vedi Intestazioni REST del Centro per i partner.

Corpo della richiesta

Nessuno.

Esempio di richiesta

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

Risposta REST

In caso di esito positivo, questo metodo restituisce una raccolta di risorse AgreementMetaData nel corpo della risposta.

Codici di errore e di esito della risposta

Ogni risposta viene fornita con un codice di stato HTTP che indica l'esito positivo o negativo e altre informazioni di debug.

Usare uno strumento di traccia di rete per leggere questo codice, il tipo di errore e altri parametri. Per l'elenco completo, vedi Codici di errore REST del Centro per i partner.

Risposta di esempio

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": "117a77b0-9360-443b-8795-c6dedc750cf9",
            "agreementType": "MicrosoftCustomerAgreement",
            "agreementLink": "https://aka.ms/customeragreement",
            "versionRank": 0
        }
    ],
    "attributes": {
        "objectType": "Collection"
    }
}

Condividi tramite