Obter metadados do contrato do Microsoft CloudGet agreement metadata for Microsoft Cloud Agreement

Aplica-se aApplies To

  • Partner CenterPartner Center

Observação

O recurso AgreementMetaData atualmente tem suporte do Partner Center na nuvem pública da Microsoft.The AgreementMetaData resource is currently supported by Partner Center in the Microsoft public cloud only. Não é aplicável a:It isn't applicable to:

  • Partner Center operado pela 21VianetPartner Center operated by 21Vianet
  • Partner Center do Microsoft Cloud GermanyPartner Center for Microsoft Cloud Germany
  • Partner Center do Microsoft Cloud for US GovernmentPartner Center for Microsoft Cloud for US Government

Pré-requisitosPrerequisites

  • Se você estiver usando o SDK do .NET do Partner Center, a versão 1,9 ou mais recente será necessária.If you are using the Partner Center .NET SDK, version 1.9 or newer is required.

  • Se você estiver usando o SDK Java do Partner Center, a versão 1,8 ou mais recente será necessária.If you are using the Partner Center Java SDK, version 1.8 or newer is required.

  • Credenciais, conforme descrito em Autenticação do Partner Center.Credentials as described in Partner Center authentication. Este cenário dá suporte à autenticação de aplicativo + usuário..This scenario supports app + user authentication..

.NET (versão 1,14 ou mais recente).NET (version 1.14 or newer)

Para recuperar os metadados do contrato para Microsoft Cloud contrato:To retrieve the agreement metadata for Microsoft Cloud Agreement:

  1. Primeiro, recupere a coleção IAggregatePartner. AgreementDetails .First, retrieve the IAggregatePartner.AgreementDetails collection.

  2. Chame o método ByAgreementType para filtrar a coleção para Microsoft Cloud contrato.Call ByAgreementType method to filter the collection to Microsoft Cloud Agreement.

  3. Por fim, chame o método Get ou getasync .Finally, call Get or GetAsync method.

// IAggregatePartner partnerOperations;

string agreementType = "MicrosoftCloudAgreement";

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

Um exemplo completo pode ser encontrado na classe GetAgreementDetails do projeto de aplicativo de teste do console .A complete sample can be found in the GetAgreementDetails class from the console test app project.

.NET (versão 1,9-1,13).NET (version 1.9 - 1.13)

Para recuperar os metadados do contrato para o contrato de Microsoft Cloud:To retrieve agreement metadata for the Microsoft Cloud Agreement:

Primeiro, recupere a coleção IAggregatePartner. AgreementDetails e, em seguida, chame os métodos Get ou getasync .First retrieve the IAggregatePartner.AgreementDetails collection and then call the Get or GetAsync methods. Em seguida, pesquise o item na coleção, que corresponde ao contrato 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

O SDK do Java do Partner Center geralmente é usado por parceiros para gerenciar os recursos do Partner Center.The Partner Center Java SDK is commonly used by partners to manage their Partner Center resources. É um projeto de software livre mantido pela comunidade de parceiros.It's an open-source project maintained by the partner community. Esse módulo é mantido pela comunidade de parceiros e, por isso, não tem suporte oficial da Microsoft.Since this module is maintained by the partner community, it isn't officially supported by Microsoft. Caso se depare com um problema, você pode obter ajuda da comunidade ou abrir um problema no GitHub.You can get help from the community or open an issue on GitHub if you experience a problem.

Para recuperar os metadados do contrato para o contrato de Microsoft Cloud:To retrieve agreement metadata for the Microsoft Cloud Agreement:

Primeiro, chame a função IAggregatePartner. getAgreementDetails e, em seguida, chame a função Get .First call the IAggregatePartner.getAgreementDetails function and then call the get function. Em seguida, pesquise o item na coleção, que corresponde ao contrato 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;
    }
}

Um exemplo completo pode ser encontrado na classe GetAgreementDetails do projeto de aplicativo de teste do console .A complete sample can be found in the GetAgreementDetails class from the console test app project.

PowerShellPowerShell

O módulo PowerShell do Partner Center é normalmente usado por parceiros para gerenciar os recursos do Partner Center.The Partner Center PowerShell module is commonly used by partners to manage their Partner Center resources. É um projeto de software livre mantido pela comunidade de parceiros.It's an open-source project maintained by the partner community. Esse módulo é mantido pela comunidade de parceiros e, por isso, não tem suporte oficial da Microsoft.Since this module is maintained by the partner community, it isn't officially supported by Microsoft. Caso se depare com um problema, você pode obter ajuda da comunidade ou abrir um problema no GitHub.You can get help from the community or open an issue on GitHub if you experience a problem.

Para recuperar os metadados do contrato para o contrato de Microsoft Cloud:To retrieve agreement metadata for the Microsoft Cloud Agreement:

Use o comando Get-PartnerAgreementDetail .Use the Get-PartnerAgreementDetail command. Em seguida, pesquise o item na coleção, que corresponde ao contrato 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

Solicitação RESTREST request

Para recuperar os metadados do contrato para Microsoft Cloud contrato, primeiro crie uma solicitação REST para recuperar a coleção AgreementMetaData .To retrieve agreement metadata for Microsoft Cloud Agreement, first create a REST Request to retrieve the AgreementMetaData collection. Em seguida, pesquise o item na coleção que corresponde ao contrato de Microsoft Cloud.Then search for the item in the collection which corresponds to the Microsoft Cloud Agreement.

Sintaxe da solicitaçãoRequest syntax

MétodoMethod URI da solicitaçãoRequest URI
GETGET * { BASEURL } */v1/Agreements http/1.1{baseURL}/v1/agreements HTTP/1.1

Cabeçalhos de solicitaçãoRequest headers

Para obter mais informações, confira Cabeçalhos REST do Partner Center.For more information, see Partner Center REST headers.

Corpo da solicitaçãoRequest body

nenhuma.None.

Exemplo de solicitaçãoRequest 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

Resposta RESTREST response

Se for bem-sucedido, esse método retornará uma coleção de recursos AgreementMetaData no corpo da resposta.If successful, this method returns a collection of AgreementMetaData resources in the response body.

Códigos de êxito e de erro de respostaResponse success and error codes

Cada resposta vem com um código de status HTTP que indica êxito ou falha e informações de depuração adicionais.Each response comes with an HTTP status code that indicates success or failure and additional debugging information. Use uma ferramenta de rastreamento de rede para ler esse código, o tipo de erro e os parâmetros adicionais.Use a network trace tool to read this code, error type, and additional parameters. Para obter a lista completa, confira Códigos de erro REST do Partner Center.For the full list, see Partner Center REST error codes.

Exemplo de respostaResponse 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 o recurso na resposta que corresponde ao contrato de Microsoft Cloud, procure o recurso cuja propriedade agreementtype tenha o 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".