Obter uma lista de clientes

Artigo
07/24/2024

Aplica-se a: Centro de Parceiros | Centro de Parceiros operado pela 21Vianet | Centro de Parceiros para Microsoft Cloud for US Government

Este artigo descreve como obter uma coleção de recursos que representa todos os clientes de um parceiro.

Dica

Também pode efetuar esta operação no Centro de Parceiros. Na Home page, selecione a área de trabalho Clientes e, em seguida, veja os clientes com a lista Clientes no menu.

Pré-requisitos

Credenciais conforme descrito na autenticação do Centro de Parceiros. Este cenário suporta a autenticação com credenciais de Aplicação e Aplicação+Utilizador autónomas.

C#

Para obter uma lista de todos os clientes:

Utilize a coleção IAggregatePartner.Customers para criar um objeto IPartner .
Obtenha a lista de clientes com os métodos Query() ou QueryAsync( ). (Para obter instruções sobre como criar uma consulta, consulte a classe QueryFactory .)

// IAggregatePartner partnerOperations;

// All the operations executed on this partner operation instance will share the same correlation Id but will differ in request Id
IPartner scopedPartnerOperations = partnerOperations.With(RequestContextFactory.Instance.Create(Guid.NewGuid()));

// read customers into chunks of 40s
var customersBatch = scopedPartnerOperations.Customers.Query(QueryFactory.Instance.BuildIndexedQuery(40));
var customersEnumerator = scopedPartnerOperations.Enumerators.Customers.Create(customersBatch);

Para obter um exemplo, veja o seguinte:

Exemplo: aplicação de teste da consola
Projeto: PartnerSDK.FeatureSamples
Classe: CustomerPaging.cs

Java

O SDK Java do Centro de Parceiros pode ser utilizado para gerir recursos do Centro de Parceiros. É um projeto open source mantido pela comunidade de parceiros e não é oficialmente suportado pela Microsoft. Pode obter ajuda da comunidade ou abrir um problema no GitHub se tiver um problema.

Para obter uma lista de todos os clientes:

Utilize a função [IAggregatePartner.getCustomers] para obter uma referência às operações do cliente.
Obtenha a lista de clientes com a função query( ).

// Query the customers, get the first page if a page size was set, otherwise get all customers
SeekBasedResourceCollection<Customer> customersPage = partnerOperations.getCustomers().query(QueryFactory.getInstance().buildIndexedQuery(40));

// Create a customer enumerator which will aid us in traversing the customer pages
IResourceCollectionEnumerator<SeekBasedResourceCollection<Customer>> customersEnumerator =
    partnerOperations.getEnumerators().getCustomers().create( customersPage );

int pageNumber = 1;

while (customersEnumerator.hasValue())
{
    /*
     * Use the customersEnumerator.getCurrent() function to
     * access the current page of customers.
     */

    // Get the next page of customers
    customersEnumerator.next();
}

PowerShell

O módulo do PowerShell do Centro de Parceiros pode ser utilizado para gerir recursos do Centro de Parceiros. É um projeto open source mantido pela comunidade de parceiros e não é oficialmente suportado pela Microsoft. Pode obter ajuda da comunidade ou abrir um problema no GitHub se tiver um problema.

Execute o comando Get-PartnerCustomer sem parâmetros para obter uma lista completa de clientes.

Get-PartnerCustomer

Pedido REST

Sintaxe do pedido

Método	URI do pedido
GET	{baseURL}/v1/customers?size={size} HTTP/1.1

Parâmetro URI

Utilize o seguinte parâmetro de consulta para obter uma lista de clientes.

Nome	Tipo	Necessário	Descrição
tamanho	int	Y	O número de resultados a apresentar de uma só vez.

Cabeçalhos do pedido

Para obter mais informações, veja Cabeçalhos REST do Centro de Parceiros.

Corpo do pedido

Nenhum.

Exemplo de pedido

GET https://api.partnercenter.microsoft.com/v1/customers?size=40 HTTP/1.1
Authorization: Bearer <token>
Accept: application/json
MS-RequestId: 3705fc6d-4127-4a87-bdba-9658f73fe019
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd

Resposta do REST

Se for bem-sucedido, este método devolve uma coleção de recursos do Cliente no corpo da resposta.

Códigos de erro e êxito da resposta

Cada resposta inclui um código de estado HTTP que indica êxito ou falha e informações adicionais de depuração. Utilize uma ferramenta de rastreio de rede para ler este código, tipo de erro e parâmetros adicionais. Para obter uma lista completa, veja Códigos de Erro.

Exemplo de resposta

HTTP/1.1 200 OK
Content-Length: 15650
Content-Type: application/json
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
MS-RequestId: 3705fc6d-4127-4a87-bdba-9658f73fe019
Date: Fri, 20 Nov 2015 01:08:23 GMT

{
    "totalCount": 2,
    "items": [{
        "id": "b44bb1fb-c595-45b0-9e09-d657365580bf",
        "companyProfile": {
            "tenantId": "<guid>",
            "domain": "domain",
            "companyName": "companyName",
            "attributes": {
                "objectType": "CustomerCompanyProfile"
            }
        },
        "relationshipToPartner": "reseller",
        "attributes": {
            "objectType": "Customer"
        }
    },
    {
        "id": "45c44870-ef77-4fdd-b6fe-3dacb075cff2",
        "companyProfile": {
            "tenantId": "<guid>",
            "domain": "domain",
            "companyName": "companyName",
            "attributes": {
                "objectType": "CustomerCompanyProfile"
            }
        },
        "relationshipToPartner": "reseller",
        "attributes": {
            "objectType": "Customer"
        }
    }],
    "links": {
        "self": {
            "uri": "/v1/customers?size=40",
            "method": "GET",
            "headers": []
        }
    },
    "attributes": {
        "objectType": "Collection"
    }
}

Partilhar via