Obtener los metadatos del acuerdo del Contrato de Microsoft Cloud

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 AgreementMetaData solo es compatible con el Centro de partners en la nube pública de Microsoft.

El Contrato de cliente de Microsoft reemplazó el Contrato de Microsoft Cloud, a partir de 2021. Si el cliente firmó previamente un contrato de Microsoft Cloud, su último historial de contratos conocido estará disponible, además de Contrato de cliente de Microsoft historial..

Requisitos previos

  • Si usa el SDK de .NET del Centro de partners, se requiere la versión 1.9 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.

  • Si usa el SDK de Java del Centro de partners, se requiere la versión 1.8 o posterior.

  • Credenciales tal como se describen en el artículo Autenticación del Centro de partners. Este escenario admite la autenticación de aplicaciones y usuarios.

.NET (versión 1.14 o posterior)

Para recuperar los metadatos del contrato para el Contrato de Microsoft Cloud:

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

  2. Llame al método ByAgreementType para filtrar la colección a Microsoft Cloud Agreement.++++++++++++++++++++++++

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

// IAggregatePartner partnerOperations;

string agreementType = "MicrosoftCloudAgreement";

var microsoftCloudAgreementDetails = 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.

.NET (versión 1.9 - 1.13)

Para recuperar los metadatos del contrato para el Contrato de Microsoft Cloud:

Primero recupere la colección IAggregatePartner.AgreementDetails y, a continuación, llame a los métodos Get o GetAsync . A continuación, busque el elemento dentro de la colección, que corresponde al Contrato de Microsoft Cloud:

// IAggregatePartner partnerOperations;

var agreements = partnerOperations.AgreementDetails.Get();

AgreementMetaData microsoftCloudAgreement = agreements.Items.FirstOrDefault (agr => agr.AgreementType == AgreementType.MicrosoftCloudAgreement);

Java

El SDK de Java del Centro de partners se puede usar para administrar los recursos del Centro de partners. Es un proyecto de código abierto mantenido por la comunidad de partners y no es compatible oficialmente con Microsoft. Puedes obtener ayuda de la comunidad o abrir una incidencia en GitHub si se produce un problema.

Para recuperar los metadatos del contrato para el Contrato de Microsoft Cloud:

En primer lugar, llame a la función IAggregatePartner.getAgreementDetails y, a continuación, llame a la función get . A continuación, busque el elemento dentro de la colección, que corresponde al Contrato de Microsoft Cloud:

// IAggregatePartner partnerOperations;

ResourceCollection<AgreementMetaData> agreements = partnerOperations.getAgreements().get();

AgreementMetaData microsoftCloudAgreement;

for (AgreementMetaData metadata : agreements)
{
    if(metadata.getAgreementType() == AgreementType.MicrosoftCloudAgreement)
    {
        microsoftCloudAgreement = metadata;
    }
}

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

PowerShell

El módulo de PowerShell del Centro de partners se puede usar para administrar los recursos del Centro de partners. Es un proyecto de código abierto mantenido por la comunidad de partners y no es compatible oficialmente con Microsoft. Puedes obtener ayuda de la comunidad o abrir una incidencia en GitHub si se produce un problema.

Para recuperar los metadatos del contrato para el Contrato de Microsoft Cloud:

Use el comando Get-PartnerAgreementDetail. A continuación, busque el elemento dentro de la colección, que corresponde al Contrato de Microsoft Cloud:

Get-PartnerAgreementDetail | Where-Object {$_.AgreementType -eq 'MicrosoftCloudAgreement'} | Select-Object -First 1

Solicitud REST

Para recuperar los metadatos del contrato de Microsoft Cloud Agreement, cree primero una solicitud REST para recuperar la colección AgreementMetaData . A continuación, busque el elemento de la colección que corresponde al Contrato de Microsoft Cloud.

Sintaxis de la solicitud

Método URI de solicitud
GET {baseURL}/v1/agreements 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 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": "998b88de-aa99-4388-a42c-1b3517d49490",
            "agreementType": "MicrosoftCloudAgreement",
            "agreementLink": "https://learn.microsoft.com/partner-center/agreements",
            "versionRank": 0
        }
    ],
    "links": {
        "self": {
            "uri": "/agreements",
            "method": "GET",
            "headers": []
        }
    },
    "attributes": {
        "objectType": "Collection"
    }
}

Para identificar el recurso en la respuesta que corresponde al Contrato de Microsoft Cloud, busque el recurso cuya propiedad agreementType tiene el valor "MicrosoftCloudAgreement".