Obter metadados do Contrato de Cliente da Microsoft

Artigo
03/05/2024

Aplica-se a: Partner Center

Não se aplica a: Partner Center operado pela 21Vianet | Partner Center para o Microsoft Cloud for US Government

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

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

Pré-requisitos

Se você estiver usando o SDK do Partner Center .NET, 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 Partner Center .NET foi arquivada. Você pode baixar a versão do SDK no GitHub, juntamente com um arquivo leiame que contém informações úteis.

Os parceiros são incentivados a continuar a usar as APIs REST do Partner Center.
Credenciais, conforme descrito em Autenticação do Partner Center. Esse cenário oferece suporte somente à autenticação App+User.

.NET (versão 1.14 ou mais recente)

Para recuperar os metadados do contrato do Contrato de Cliente da Microsoft:

Primeiro, recupere a coleção IAggregatePartner.AgreementDetails .
Chame o método ByAgreementType para filtrar a coleção para o Contrato do Cliente Microsoft.
Finalmente, chame Get ou GetAsync método.

// 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 de aplicativo de teste de console.

Solicitação REST

Para recuperar os metadados do contrato do Contrato de Cliente da 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 da Microsoft.

Sintaxe da solicitação

Método	URI da solicitação
GET	{baseURL}/v1/agreements?agreementType={tipo de acordo} HTTP/1.1

Parâmetros do URI

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

Nome	Digitar	Obrigatória	Descrição
tipo de acordo	string	Não	Use esse parâmetro para definir o escopo da resposta da consulta para um tipo de contrato específico. Os valores suportados são: MicrosoftCloudAgreement que inclui metadados de contrato somente do tipo MicrosoftCloudAgreement MicrosoftCustomerAgreement que inclui metadados de contrato somente 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 da solicitação

Para obter mais informações, confira Cabeçalhos REST do Partner Center.

Corpo da solicitação

Nenhum.

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 bem-sucedido, esse método retorna uma coleção de recursos AgreementMetaData no corpo da resposta.

Códigos de êxito e de 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 obter a lista completa, confira Códigos de erro REST do 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"
    }
}

Compartilhar via