Obter uma lista de dispositivos para o lote e cliente especificados

Artigo
09/11/2024

Aplica-se a: Centro de Parceiros

Este artigo descreve como obter uma coleção de dispositivos num lote de dispositivo especificado para um cliente especificado. Cada recurso de dispositivo contém detalhes sobre o dispositivo.

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.
Um ID de cliente (customer-tenant-id). Se não souber o ID do cliente, pode procurá-lo no Centro de Parceiros ao selecionar a área de trabalho Clientes e, em seguida, o cliente na lista de clientes e, em seguida, Conta. Na página Conta do cliente, procure o ID Microsoft na secção Informações da Conta de Cliente . O ID da Microsoft é o mesmo que o ID do cliente (customer-tenant-id).
Um identificador de lote de dispositivo.

C#

Para obter uma coleção dos dispositivos num lote de dispositivo especificado para o cliente especificado:

Chame o método IAggregatePartner.Customers.ById com o ID de cliente para obter uma interface para operações no cliente especificado.
Chame o método DeviceBatches.ById para obter uma interface para operações de recolha de lotes de dispositivos para o lote especificado.
Obtenha a propriedade Dispositivos para obter uma interface para operações de recolha de dispositivos para o lote.
Chame o método Get ou GetAsync para obter a coleção de dispositivos.

IAggregatePartner partnerOperations;
string selectedCustomerId;
string selectedDeviceBatchId;

var devices =
    partnerOperations.Customers.ById(selectedCustomerId).DeviceBatches.ById(selectedDeviceBatchId).Devices.Get();

Para obter um exemplo, veja o seguinte:

Exemplo: aplicação de teste da consola
Project: Partner Center SDK Samples (Exemplos do SDK do Centro de Parceiros)
Classe: GetDevices.cs

Pedido REST

Sintaxe do pedido

Método	URI do pedido
GET	{baseURL}/v1/customers/{customer-id}/deviceBatches/{devicebatch-id}/devices HTTP/1.1

Parâmetros do URI

Utilize os seguintes parâmetros de caminho ao criar o pedido.

Nome	Tipo	Necessário	Descrição
customer-id	string	Yes	Uma cadeia formatada por GUID que identifica o cliente.
devicebatch-id	string	Yes	Um identificador de cadeia que identifica o lote do dispositivo.

Cabeçalhos do pedido

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

Corpo do pedido

Nenhuma

Exemplo de pedido

GET https://api.partnercenter.microsoft.com/v1/customers/47021739-3426-40bf-9601-61b4b6d7c793/deviceBatches/testbatch/devices HTTP/1.1
Authorization: Bearer <token>
Accept: application/json
MS-RequestId: e88d014d-ab70-41de-90a0-f7fd1797267d
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
X-Locale: en-US
Host: api.partnercenter.microsoft.com

Resposta do REST

Se for bem-sucedido, o corpo da resposta contém uma coleção paginada de Recursos do dispositivo . A coleção contém 100 dispositivos numa página. Para obter a página seguinte de 100 dispositivos, o continuationToken no corpo da resposta tem de ser incluído no pedido subsequente como um cabeçalho de MS-ContinuationToken.

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 REST do Centro de Parceiros.

Exemplo de resposta

HTTP/1.1 200 OK
Content-Length: 1742
Content-Type: application/json; charset=utf-8
MS-CorrelationId: bbbb1111-cc22-3333-44dd-555555eeeeee
MS-RequestId: 7b3e2e00-b330-4480-9d84-59ace713427f
MS-CV: YrLe3w6BbUSMt1fi.0
MS-ServerId: 030020344
Date: Tue, 25 Jul 2017 17:52:41 GMT

{
    "totalCount": 2,
    "items":
    [{
            "id": "7c141ea9-2816-4e15-a819-53f6856499ff",
            "serialNumber": "2R9-ZNP67",
            "productKey": "00329-00000-0003-AA6069",
            "modelName": "Precision WorkStation T7500",
            "oemManufacturerName":"Dell Inc.",
            "policies":[{
                    "key": "o_o_b_e",
                    "value": null
                }
            ],
            "uploadedDate":"2017-08-09T14:43:26.0092288-07:00",
            " attributes": {
                "objectType": "Device"
            }
        }, {
            "id": "e528a62f-5031-49f4-bea7-5fafe47388fd",
            "serialNumber": "1234567890",
            "productKey": "12345-67890-09876-54321-13579",
            "modelName": "HP Z420 Workstation",
            "oemManufacturerName": "Hewlett-Packard",
            "policies": [{
                    "key": "o_o_b_e",
                    "value": null
                }
            ],
            "uploadedDate": "2017-08-09T14:35:51.3126144-07:00",
            "attributes": {
                "objectType": "Device"
            }
        }
    ],
    "attributes": {
        "objectType": "Collection"
    }
}

Partilhar via