Obter metadados de contrato para o Contrato de Cliente Microsoft

Artigo
03/07/2025

Aplica-se a: Partner Center

Não se aplica a: Centro de Parceiros operado pela 21Vianet | Centro de Parceiros da Nuvem Microsoft para o Governo dos Estados Unidos

Atualmente, os metadados do contrato para o Contrato de Cliente Microsoft são suportados pelo Partner Center apenas na nuvem pública da Microsoft.

Você deve recuperar os metadados do Contrato de Cliente da Microsoft antes de poder:

Pré-requisitos

Se você estiver usando o SDK .NET do Partner Center, a versão 1.14 ou mais recente será necessária.

Importante

A partir de junho de 2023, a versão 3.4.0 mais recente do SDK do .NET do Partner Center foi arquivada. Você pode baixar o release do SDK do GitHub, juntamente com um ficheiro README que contém informações úteis.

Os parceiros são incentivados a continuar a usar as APIs REST do Partner Center.
Credenciais conforme descrito na autenticação do Partner Center. Este cenário suporta apenas a autenticação App+User.

.NET (versão 1.14 ou mais recente)

Para recuperar os metadados do Contrato de Cliente Microsoft:

Primeiro, recupere a coleção IAggregatePartner.AgreementDetails.
Utilize o método ByAgreementType para filtrar a coleção para o Contrato de Cliente da Microsoft.
Por fim, chame o método Get ou GetAsync.

// IAggregatePartner partnerOperations;

string agreementType = "MicrosoftCustomerAgreement";

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

Um exemplo completo pode ser encontrado na classe GetAgreementDetails do projeto aplicativo de teste de console.

Pedido REST

Para recuperar os metadados do Contrato de Cliente Microsoft:

Crie uma solicitação REST para recuperar a coleção AgreementMetaData.
Use o parâmetro de consulta agreementType para definir o escopo do resultado somente para o Contrato de Cliente Microsoft.

Sintaxe da solicitação

Método	Solicitar URI
OBTER	{baseURL}/v1/agreements?agreementType={agreement-type} HTTP/1.1

Parâmetros de URI

Use os seguintes parâmetros de URI com sua solicitação:

Nome	Tipo	Necessário	Descrição
tipo de acordo	cadeia de caracteres	Não	Use esse parâmetro para definir o escopo da resposta de consulta para um tipo de contrato específico. Os valores suportados são: MicrosoftCloudAgreement que inclui metadados de contrato apenas do tipo MicrosoftCloudAgreement MicrosoftCustomerAgreement que inclui metadados de contrato apenas do tipo MicrosoftCustomerAgreement. * que retorna todos os metadados do contrato. (Não use * a menos que seu código tenha a lógica de tempo de execução necessária para lidar com tipos de contrato desconhecidos, pois a Microsoft pode introduzir metadados de contrato com novos tipos de contrato a qualquer momento.) Nota: Se o parâmetro URI não for especificado, o padrão da consulta será MicrosoftCloudAgreement para compatibilidade com versões anteriores.

Cabeçalhos de solicitação

Para mais informações, consulte os cabeçalhos REST do Partner Center.

Corpo do pedido

Nenhuma.

Exemplo de solicitação

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: aaaa0000-bb11-2222-33cc-444444dddddd

Resposta REST

Se for bem-sucedido, este método retornará uma coleção de AgreementMetaData recursos no corpo da resposta.

Códigos de sucesso e erro de resposta

Cada resposta vem com um código de status HTTP que indica sucesso ou falha e outras informações de depuração.

Use uma ferramenta de rastreamento de rede para ler esse código, tipo de erro e outros parâmetros. Para a lista completa, consulte os códigos de erro REST de Partner Center.

Exemplo de resposta

HTTP/1.1 200 OK
Content-Length: 620
Content-Type: application/json
MS-RequestId: 94e4e214-6b06-4fb7-96d1-94d559f9b47f
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
{
    "totalCount": 1,
    "items": [
        {
            "templateId": "aaaabbbb-0000-cccc-1111-dddd2222eeee",
            "agreementType": "MicrosoftCustomerAgreement",
            "agreementLink": "https://aka.ms/customeragreement",
            "versionRank": 0
        }
    ],
    "attributes": {
        "objectType": "Collection"
    }
}

Partilhar via