Obtener los metadatos del acuerdo del Contrato de cliente de Microsoft

  • Artículo

Se aplica a: Centro de partners

No se aplica a: Centro de partners operado por 21Vianet | Centro de partners para Microsoft Cloud for US Government

Actualmente, el Centro de partners solo admite metadatos de contrato para Contrato de cliente de Microsoft en la nube pública de Microsoft.

Debe recuperar los metadatos del contrato para la Contrato de cliente de Microsoft antes de poder:

Requisitos previos

.NET (versión 1.14 o posterior)

Para recuperar los metadatos del contrato para Contrato de cliente de Microsoft:

  1. En primer lugar, recupere la colección IAggregatePartner.AgreementDetails .

  2. Llame al método ByAgreementType para filtrar la colección a Contrato de cliente de Microsoft.

  3. Por último, llame al método Get o GetAsync .

// IAggregatePartner partnerOperations;

string agreementType = "MicrosoftCustomerAgreement";

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

Puede encontrar un ejemplo completo en la clase GetAgreementDetails del proyecto de aplicación de prueba de consola.

Solicitud REST

Para recuperar los metadatos del contrato para Contrato de cliente de Microsoft:

  1. Cree una solicitud REST para recuperar la colección AgreementMetaData .

  2. Use el parámetro de consulta agreementType para limitar el ámbito del resultado solo al Contrato de cliente de Microsoft.

Sintaxis de la solicitud

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

Parámetros de URI

Use los siguientes parámetros de URI con la solicitud:

Nombre Type Obligatorio Descripción
tipo de contrato string No Use este parámetro para definir el ámbito de la respuesta de consulta al tipo de contrato específico. Los valores admitidos son:

MicrosoftCloudAgreement que incluye metadatos de contrato solo del tipo MicrosoftCloudAgreement

MicrosoftCustomerAgreement que incluye metadatos de contrato solo del tipo MicrosoftCustomerAgreement.

* que devuelve todos los metadatos del contrato. (No use * a menos que el código tenga la lógica en tiempo de ejecución necesaria para controlar tipos de contrato desconocidos, ya que Microsoft podría introducir metadatos de contrato con nuevos tipos de contrato en cualquier momento).

Nota: Si no se especifica el parámetro URI, la consulta tiene como valor predeterminado MicrosoftCloudAgreement para la compatibilidad con versiones anteriores.

Encabezados de solicitud

Para obtener más información, consulta Encabezados REST del Centro de partners.

Cuerpo de la solicitud

Ninguno.

Ejemplo de solicitud

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: ab993325-1605-4cf4-bac4-fb584142a31b

Respuesta REST

Si se ejecuta correctamente, este método devuelve una colección de recursos AgreementMetaData en el cuerpo de la respuesta.

Códigos de error y de respuesta correctos

Cada respuesta incluye un código de estado HTTP que indica éxito o error y otra información de depuración.

Use una herramienta de seguimiento de red para leer este código, tipo de error y otros parámetros. Para obtener la lista completa, consulta Códigos de error de REST del Centro de partners.

Ejemplo de respuesta

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