Obtener los metadatos del acuerdo del Contrato de Microsoft CloudGet agreement metadata for Microsoft Cloud Agreement

Se aplica aApplies To

  • Centro de partnersPartner Center

Nota

Actualmente, el recurso AgreementMetaData solo es compatible con el centro de Partners en la nube pública de Microsoft.The AgreementMetaData resource is currently supported by Partner Center in the Microsoft public cloud only. No es aplicable a:It isn't applicable to:

  • Centro de partners operado por 21VianetPartner Center operated by 21Vianet
  • Centro de partners para Microsoft Cloud AlemaniaPartner Center for Microsoft Cloud Germany
  • Centro de partners para Microsoft Cloud for US GovernmentPartner Center for Microsoft Cloud for US Government

Requisitos previosPrerequisites

  • Si usa el SDK de .NET del centro de Partners, se requiere la versión 1,9 o posterior.If you are using the Partner Center .NET SDK, version 1.9 or newer is required.

  • Si usa el SDK de Java del centro de Partners, se requiere la versión 1,8 o posterior.If you are using the Partner Center Java SDK, version 1.8 or newer is required.

  • Credenciales tal como se describen en el artículo Autenticación del Centro de partners.Credentials as described in Partner Center authentication. Este escenario es compatible con la autenticación de usuario y aplicación.This scenario supports app + user authentication..

.NET (versión 1,14 o posterior).NET (version 1.14 or newer)

Para recuperar los metadatos del contrato para Microsoft Cloud acuerdo:To retrieve the agreement metadata for Microsoft Cloud Agreement:

  1. En primer lugar, recupere la colección colección iaggregatepartner. AgreementDetails .First, retrieve the IAggregatePartner.AgreementDetails collection.

  2. Llame al método ByAgreementType para filtrar la colección para Microsoft Cloud acuerdo.Call ByAgreementType method to filter the collection to Microsoft Cloud Agreement.

  3. Por último, llame al método Get o GetAsync .Finally, call Get or GetAsync method.

// 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 .A complete sample can be found in the GetAgreementDetails class from the console test app project.

.NET (versión 1,9-1,13).NET (version 1.9 - 1.13)

Para recuperar los metadatos del acuerdo Microsoft Cloud:To retrieve agreement metadata for the Microsoft Cloud Agreement:

En primer lugar, recupere la colección colección iaggregatepartner. AgreementDetails y, a continuación, llame a los métodos Get o GetAsync .First retrieve the IAggregatePartner.AgreementDetails collection and then call the Get or GetAsync methods. A continuación, busque el elemento dentro de la colección, que corresponde al acuerdo de Microsoft Cloud:Then search for the item within the collection, which corresponds to the Microsoft Cloud Agreement:

// IAggregatePartner partnerOperations;

var agreements = partnerOperations.AgreementDetails.Get();

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

JavaJava

Los partners suelen usar el SDK de Java del Centro de partners para administrar los recursos del Centro de partners.The Partner Center Java SDK is commonly used by partners to manage their Partner Center resources. Se trata de un proyecto de código abierto que mantiene la comunidad de partners.It's an open-source project maintained by the partner community. Dado que este módulo lo mantiene la comunidad de partners, Microsoft no lo admite oficialmente.Since this module is maintained by the partner community, it isn't officially supported by Microsoft. Puedes obtener ayuda de la comunidad o abrir una incidencia en GitHub si se produce un problema.You can get help from the community or open an issue on GitHub if you experience a problem.

Para recuperar los metadatos del acuerdo Microsoft Cloud:To retrieve agreement metadata for the Microsoft Cloud Agreement:

En primer lugar, llame a la función colección iaggregatepartner. getAgreementDetails y, a continuación, llame a la función Get .First call the IAggregatePartner.getAgreementDetails function and then call the get function. A continuación, busque el elemento dentro de la colección, que corresponde al acuerdo de Microsoft Cloud:Then search for the item within the collection, which corresponds to the Microsoft Cloud Agreement:

// 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 .A complete sample can be found in the GetAgreementDetails class from the console test app project.

PowerShellPowerShell

Los partners suelen usar el módulo de PowerShell del Centro de partners para administrar los recursos del Centro de partners.The Partner Center PowerShell module is commonly used by partners to manage their Partner Center resources. Se trata de un proyecto de código abierto que mantiene la comunidad de partners.It's an open-source project maintained by the partner community. Dado que este módulo lo mantiene la comunidad de partners, Microsoft no lo admite oficialmente.Since this module is maintained by the partner community, it isn't officially supported by Microsoft. Puedes obtener ayuda de la comunidad o abrir una incidencia en GitHub si se produce un problema.You can get help from the community or open an issue on GitHub if you experience a problem.

Para recuperar los metadatos del acuerdo Microsoft Cloud:To retrieve agreement metadata for the Microsoft Cloud Agreement:

Use el comando Get-PartnerAgreementDetail .Use the Get-PartnerAgreementDetail command. A continuación, busque el elemento dentro de la colección, que corresponde al acuerdo de Microsoft Cloud:Then search for the item within the collection, which corresponds to the Microsoft Cloud Agreement:

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

Solicitud RESTREST request

Para recuperar los metadatos del acuerdo Microsoft Cloud acuerdo, primero cree una solicitud REST para recuperar la colección AgreementMetaData .To retrieve agreement metadata for Microsoft Cloud Agreement, first create a REST Request to retrieve the AgreementMetaData collection. A continuación, busque el elemento de la colección que corresponde al acuerdo de Microsoft Cloud.Then search for the item in the collection which corresponds to the Microsoft Cloud Agreement.

Sintaxis de la solicitudRequest syntax

MétodoMethod URI de solicitudRequest URI
GETGET * { BASEURL } */v1/Agreements http/1.1{baseURL}/v1/agreements HTTP/1.1

Encabezados de solicitudRequest headers

Para obtener más información, consulta Encabezados REST del Centro de partners.For more information, see Partner Center REST headers.

Cuerpo de la solicitudRequest body

Ninguno.None.

Ejemplo de solicitudRequest example

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 RESTREST response

Si es correcto, este método devuelve una colección de recursos AgreementMetaData en el cuerpo de la respuesta.If successful, this method returns a collection of AgreementMetaData resources in the response body.

Códigos de error y de respuesta correctosResponse success and error codes

Cada respuesta incluye un código de estado HTTP que indica si la operación se ha realizado correctamente o con errores y proporciona información de depuración adicional.Each response comes with an HTTP status code that indicates success or failure and additional debugging information. Use una herramienta de seguimiento de red para leer este código, el tipo de error y los parámetros adicionales.Use a network trace tool to read this code, error type, and additional parameters. Para obtener la lista completa, consulta Códigos de error de REST del Centro de partners.For the full list, see Partner Center REST error codes.

Ejemplo de respuestaResponse example

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://docs.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 acuerdo de Microsoft Cloud, busque el recurso cuya propiedad agreementType tenga el valor "MicrosoftCloudAgreement".To identify the resource in the response which corresponds to the Microsoft Cloud Agreement, look for the resource whose agreementType property has value "MicrosoftCloudAgreement".