Obter a confirmação da aceitação do Contrato de Cliente da Microsoft pelo clienteGet confirmation of customer acceptance of Microsoft Customer Agreement

Aplica-se a:Applies to:

  • Partner CenterPartner Center

O recurso de contrato atualmente tem suporte do Partner Center somente na nuvem pública da Microsoft.The Agreement resource is currently supported by Partner Center only in the Microsoft public cloud. Este recurso não se aplica a:This resource doesn't apply 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

Este artigo explica como você pode recuperar a (s) confirmação (ões) da aceitação do cliente do contrato do cliente da Microsoft.This article explains how you can retrieve confirmation(s) of a customer's acceptance of the Microsoft Customer Agreement.

Pré-requisitosPrerequisites

  • Se você estiver usando o SDK do .NET do Partner Center, será necessário usar a versão 1.14 posterior.If you are using the Partner Center .NET SDK, version 1.14 or newer is required.

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

  • Uma ID do cliente (customer-tenant-id).A customer ID (customer-tenant-id). Se você não souber a ID do cliente, poderá procurar no painel do Partner Center.If you don't know the customer's ID, you can look it up in the Partner Center dashboard. Selecione CSP no menu do Partner Center e, em seguida, Clientes.Select CSP from the Partner Center menu, followed by Customers. Selecione o cliente na lista de clientes e selecione Conta.Select the customer from the customer list, then select Account. Na página Conta do cliente, procure a ID da Microsoft na seção Informações da Conta do Cliente.On the customer’s Account page, look for the Microsoft ID in the Customer Account Info section. A ID da Microsoft é igual à ID do cliente (customer-tenant-id).The Microsoft ID is the same as the customer ID (customer-tenant-id).

.NET.NET

Para recuperar a (s) confirmação (ões) de aceitação do cliente que foi fornecida anteriormente:To retrieve confirmation(s) of customer acceptance that was previously provided:

  • Use a coleção IAggregatePartner. Customers e chame o método ById com o identificador de cliente especificado.Use the IAggregatePartner.Customers collection and call ById method with the specified customer identifier.

  • Busque a propriedade Agreements e filtre os resultados para o contrato do cliente da Microsoft chamando o método ByAgreementType .Fetch the Agreements property and filter the results to Microsoft Customer Agreement by calling ByAgreementType method.

  • Chame o método Get ou getasync .Call Get or GetAsync method.

// IAggregatePartner partnerOperations;
// string selectedCustomerId;

string agreementType = "MicrosoftCustomerAgreement";

var customerAgreements = partnerOperations.Customers.ById(selectedCustomerId).Agreements.ByAgreementType(agreementType).Get();

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

Solicitação RESTREST request

Para recuperar a confirmação da aceitação do cliente que foi fornecida anteriormente:To retrieve confirmation of customer acceptance that was previously provided:

  1. Crie uma solicitação REST para recuperar a coleção de contratos para o cliente.Create a REST request to retrieve the Agreements collection for the customer.

  2. Use o parâmetro de consulta agreementtype para fazer o escopo dos resultados para apenas o contrato do cliente da Microsoft.Use the agreementType query parameter to scope the results to only the Microsoft Customer Agreement.

Sintaxe da solicitaçãoRequest syntax

Use a seguinte sintaxe de solicitação:Use the following request syntax:

MétodoMethod URI da solicitaçãoRequest URI
GETGET * { baseURL } */v1/Customers/{Customer-Tenant-ID}/Agreements? agreementtype = {tipo de contrato} http/1.1{baseURL}/v1/customers/{customer-tenant-id}/agreements?agreementType={agreement-type} HTTP/1.1

Parâmetros do URIURI parameters

Você pode usar os seguintes parâmetros de URI com sua solicitação:You can use the following URI parameters with your request:

NomeName TipoType ObrigatórioRequired DescriçãoDescription
customer-tenant-idcustomer-tenant-id GUIDGUID SimYes O valor é um CustomerTenantId formatado de GUID que permite que você especifique um cliente.The value is a GUID formatted CustomerTenantId that allows you to specify a customer.
tipo de contratoagreement-type Cadeia de caracteresstring NoNo Esse parâmetro retorna todos os metadados do contrato.This parameter returns all agreement metadata. Use esse parâmetro para fazer o escopo da resposta de consulta para o tipo de contrato específico.Use this parameter to scope the query response to specific agreement type. Os valores com suporte são:The supported values are:

MicrosoftCloudAgreement que inclui apenas metadados de contrato do tipo MicrosoftCloudAgreement.MicrosoftCloudAgreement that only includes agreement metadata of the type MicrosoftCloudAgreement.

MicrosoftCustomerAgreement que inclui apenas metadados de contrato do tipo MicrosoftCustomerAgreement.MicrosoftCustomerAgreement that only includes agreement metadata of the type MicrosoftCustomerAgreement.

* que retorna todos os metadados do contrato.* that returns all agreement metadata. (Não use a * menos que seu código tenha a lógica necessária para lidar com tipos de contrato inesperados.)(Don't use * unless your code has the necessary logic to handle unexpected agreement types.)

Observação: Se o parâmetro URI não for especificado, a consulta será padronizada como MicrosoftCloudAgreement para compatibilidade com versões anteriores.Note: If the URI parameter isn't specified, the query defaults to MicrosoftCloudAgreement for backward compatibility. A Microsoft pode introduzir metadados de contrato com novos tipos de contrato a qualquer momento.Microsoft may introduce agreement metadata with new agreement types at any time.

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

Nenhum.None.

Exemplo de solicitaçãoRequest example

GET https://api.partnercenter.microsoft.com/v1/customers/14876998-c0dc-46e6-9d0c-65a57a6c32ec/agreements?agreementType=MicrosoftCustomerAgreement 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 de contrato no corpo da resposta.If successful, this method returns a collection of Agreement 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": 2,
    "items":
    [
        {
            "primaryContact":
            {
                "firstName":"Tania",
                "lastName":"Carr",
                "email":"SomeEmail@example.com"
                "phoneNumber":"1234567890"
            },
            "templateId":"117a77b0-9360-443b-8795-c6dedc750cf9",
            "dateAgreed":"2019-08-26T00:00:00",
            "type":"MicrosoftCustomerAgreement",
            "agreementLink":"https://aka.ms/customeragreement"
        },
        {
            "primaryContact":
            {
                "firstName":"Tania",
                "lastName":"Carr",
                "email":"SomeEmail@example.com"
                "phoneNumber:"1234567890"
            },
            "templateId":"117a77b0-9360-443b-8795-c6dedc750cf9",
            "dateAgreed":"2019-08-27T00:00:00",
            "type":"MicrosoftCustomerAgreement",
            "agreementLink":"https://aka.ms/customeragreement"
        }
    ]
}