Obtener la confirmación de la aceptación por parte del cliente del Contrato de cliente de Microsoft

Artículo
03/05/2024

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

El recurso Agreement solo es compatible actualmente con el Centro de partners en la nube pública de Microsoft.

En este artículo se explica cómo recuperar confirmaciones de la aceptación del cliente de la Contrato de cliente de Microsoft.

Requisitos previos

Si usa el SDK de .NET del Centro de partners, se requiere la versión 1.14 o posterior.

Importante

A partir de junio de 2023, la versión 3.4.0 más reciente del SDK de .NET del Centro de partners ahora está archivada. Puede descargar esta versión del SDK de GitHub, junto con un archivo Léame que contiene información útil.

Se recomienda a los partners seguir usando las API REST del Centro de partners.
Credenciales tal como se describen en el artículo Autenticación del Centro de partners. Este escenario solo es compatible con la autenticación con el usuario y la aplicación.
Un id. de cliente (customer-tenant-id). Si no conoce el identificador del cliente, puede buscarlo en el Centro de partners seleccionando el área de trabajo Clientes , luego el cliente de la lista de clientes y, a continuación , Cuenta. En la página Cuenta del cliente, busque el identificador de Microsoft en la sección Información de la cuenta de cliente. El id. de Microsoft es el mismo que el de cliente (customer-tenant-id).

.NET

Para recuperar confirmaciones de aceptación del cliente proporcionadas anteriormente:

Use la colección IAggregatePartner.Customers y llame al método ById con el identificador de cliente especificado.
Capture la propiedad Agreements y filtre los resultados para Contrato de cliente de Microsoft llamando al método ByAgreementType.
Llame al método Get o GetAsync .

// IAggregatePartner partnerOperations;
// string selectedCustomerId;

string agreementType = "MicrosoftCustomerAgreement";

var customerAgreements = partnerOperations.Customers.ById(selectedCustomerId).Agreements.ByAgreementType(agreementType).Get();

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

Solicitud REST

Para recuperar la confirmación de la aceptación del cliente que se proporcionó anteriormente:

Cree una solicitud REST para recuperar la recopilación de contratos para el cliente.
Use el parámetro de consulta agreementType para limitar el ámbito de los resultados solo a la Contrato de cliente de Microsoft.

Sintaxis de la solicitud

Use la siguiente sintaxis de solicitud:

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

Parámetros de URI

Puede usar los siguientes parámetros de URI con la solicitud:

Nombre	Type	Obligatorio	Descripción
customer-tenant-id	GUID	Sí	El valor es un GUID con formato CustomerTenantId que permite especificar un cliente.
tipo de contrato	string	No	Este parámetro devuelve todos los metadatos del contrato. 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 solo incluye metadatos de contrato del tipo MicrosoftCloudAgreement. MicrosoftCustomerAgreement que solo incluye metadatos de contrato del tipo MicrosoftCustomerAgreement. * que devuelve todos los metadatos del contrato. (No use * a menos que el código tenga la lógica necesaria para controlar tipos de contrato inesperados). Nota: Si no se especifica el parámetro URI, la consulta tiene como valor predeterminado MicrosoftCloudAgreement para la compatibilidad con versiones anteriores. Microsoft podría introducir metadatos de contrato con nuevos tipos de contrato en cualquier momento.

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/customers/14876998-c0dc-46e6-9d0c-65a57a6c32ec/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 de Agreement 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": 2,
    "items":
    [
        {
            "primaryContact":
            {
                "firstName":"Tania",
                "lastName":"Carr",
                "email":"SomeEmail@example.com"
                "phoneNumber":"1234567890"
            },
            "templateId":"117a77b0-9360-443b-8795-c6dedc750cf9",
            "dateAgreed":"2019-08-26T00:00:00",
            "type":"MicrosoftCustomerAgreement",
            "agreementLink":"https://aka.ms/customeragreement"
        },
        {
            "primaryContact":
            {
                "firstName":"Tania",
                "lastName":"Carr",
                "email":"SomeEmail@example.com"
                "phoneNumber:"1234567890"
            },
            "templateId":"117a77b0-9360-443b-8795-c6dedc750cf9",
            "dateAgreed":"2019-08-27T00:00:00",
            "type":"MicrosoftCustomerAgreement",
            "agreementLink":"https://aka.ms/customeragreement"
        }
    ]
}

Compartir a través de