Obtenir les métadonnées du Contrat client Microsoft

Article
03/05/2024

S’applique à : Espace partenaires

Ne s’applique pas à : Espace partenaires géré par 21Vianet | Espace partenaires Microsoft Cloud for US Government

Les métadonnées de contrat pour Contrat client Microsoft sont actuellement prises en charge par l’Espace partenaires uniquement dans le cloud public Microsoft.

Vous devez récupérer les métadonnées du contrat pour le Contrat client Microsoft avant de pouvoir :

Prérequis

Si vous utilisez le Kit de développement logiciel (SDK) .NET de l’Espace partenaires, la version 1.14 ou ultérieure est requise.

Important

Depuis juin 2023, la dernière version du Kit de développement logiciel (SDK) .NET de l’Espace partenaires version 3.4.0 est désormais archivée. Vous pouvez télécharger la version du SDK à partir de GitHub, ainsi qu’un fichier lisezmoi contenant des informations utiles.

Les partenaires sont encouragés à continuer à utiliser les API REST de l’Espace partenaires.
Informations d’identification, comme décrit dans Authentification auprès de l’Espace partenaires. Ce scénario prend uniquement en charge l’authentification App+Utilisateur.

.NET (version 1.14 ou ultérieure)

Pour récupérer les métadonnées du contrat pour Contrat client Microsoft :

Tout d’abord, récupérez la collection IAggregatePartner.AgreementDetails .
Appelez la méthode ByAgreementType pour filtrer la collection sur Contrat client Microsoft.
Enfin, appelez la méthode Get ou GetAsync .

// IAggregatePartner partnerOperations;

string agreementType = "MicrosoftCustomerAgreement";

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

Vous trouverez un exemple complet dans la classe GetAgreementDetails à partir du projet d’application de test console.

Demande REST

Pour récupérer les métadonnées du contrat pour Contrat client Microsoft :

Créez une requête REST pour récupérer la collection AgreementMetaData .
Utilisez le paramètre de requête agreementType pour limiter le résultat au seul Contrat client Microsoft.

Syntaxe de la requête

Méthode	URI de demande
GET	{baseURL}/v1/agreements ?agreementType={agreement-type} HTTP/1.1

Paramètres d’URI

Utilisez les paramètres d’URI suivants avec votre requête :

Nom	Type	Requise	Description
type de contrat	string	Non	Utilisez ce paramètre pour étendre la réponse de requête à un type de contrat spécifique. Les valeurs prises en charge sont les suivantes : MicrosoftCloudAgreement qui inclut les métadonnées de contrat uniquement du type MicrosoftCloudAgreement MicrosoftCustomerAgreement qui inclut les métadonnées de contrat uniquement du type MicrosoftCustomerAgreement. * qui retourne toutes les métadonnées de contrat. (N’utilisez * pas, sauf si votre code a la logique d’exécution nécessaire pour gérer les types de contrat inconnus, car Microsoft peut introduire des métadonnées de contrat avec de nouveaux types de contrats à tout moment.) Remarque : Si le paramètre URI n’est pas spécifié, la requête est définie par défaut sur MicrosoftCloudAgreement pour la compatibilité descendante.

En-têtes de requête

Pour plus d’informations, consultez En-têtes REST de l’Espace Partenaires.

Corps de la demande

Aucune.

Exemple de requête

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

Réponse REST

Si elle réussit, cette méthode retourne une collection de ressources AgreementMetaData dans le corps de la réponse.

Codes d’erreur et de réussite de la réponse

Chaque réponse est fournie avec un code d’état HTTP qui indique la réussite ou l’échec et d’autres informations de débogage.

Utilisez un outil de suivi réseau pour lire ce code, le type d’erreur et d’autres paramètres. Pour obtenir la liste complète, consultez Codes d’erreur REST de l’Espace partenaires.

Exemple de réponse

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

Partager via