Obtener una lista de dispositivos del lote y del cliente especificadosGet a list of devices for the specified batch and customer

Se aplica a:Applies to:

  • Centro de partnersPartner Center
  • Centro de partners para Microsoft Cloud AlemaniaPartner Center for Microsoft Cloud Germany

En este artículo se describe cómo recuperar una colección de dispositivos en un lote de dispositivos especificado para un cliente especificado.This article describes how to retrieve a collection of devices in a specified device batch for a specified customer. Cada recurso de dispositivo contiene detalles sobre el dispositivo.Each device resource contains details about the device.

Requisitos previosPrerequisites

  • Credenciales tal como se describen en el artículo Autenticación del Centro de partners.Credentials as described in Partner Center authentication. Este escenario admite la autenticación con las credenciales de aplicación y aplicación independientes.This scenario supports authentication with both standalone App and App+User credentials.

  • Un id. de cliente (customer-tenant-id).A customer ID (customer-tenant-id). Si no conoces el identificador del cliente, puedes buscarlo en el panel del Centro de partners.If you don't know the customer's ID, you can look it up in the Partner Center dashboard. Selecciona CSP en el menú del Centro de partners, seguido de Clientes.Select CSP from the Partner Center menu, followed by Customers. En la lista de clientes, selecciona el cliente y, a continuación, elige Cuenta.Select the customer from the customer list, then select Account. En la página Cuenta del cliente, busca el Id. de Microsoft en la sección Información de la cuenta del cliente.On the customer’s Account page, look for the Microsoft ID in the Customer Account Info section. El identificador de Microsoft es el mismo que el de cliente (customer-tenant-id).The Microsoft ID is the same as the customer ID (customer-tenant-id).

  • Identificador de lote de dispositivo.A device batch identifier.

C#C#

Para recuperar una colección de los dispositivos en un lote de dispositivos especificado para el cliente especificado:To retrieve a collection of the devices in a specified device batch for the specified customer:

  1. Llame al método [colección iaggregatepartner. customers. ById/dotnet/API/Microsoft.Store.partnercenter.customers.icustomercollection.byid) con el identificador de cliente para recuperar una interfaz para las operaciones en el cliente especificado.Call the [IAggregatePartner.Customers.ById/dotnet/api/microsoft.store.partnercenter.customers.icustomercollection.byid) method with the customer ID to retrieve an interface to operations on the specified customer.

  2. Llame al método [DeviceBatches. ById/dotnet/API/Microsoft.Store.partnercenter.devicesdeployment.idevicesbatchcollection.byid) para obtener una interfaz para las operaciones de recopilación por lotes del dispositivo para el lote especificado.Call the [DeviceBatches.ById/dotnet/api/microsoft.store.partnercenter.devicesdeployment.idevicesbatchcollection.byid) method to get an interface to device batch collection operations for the specified batch.

  3. Recupere la propiedad [Devices/dotnet/API/Microsoft.Store.partnercenter.devicesdeployment.idevicesbatch.Devices) para obtener una interfaz para las operaciones de recopilación de dispositivos para el lote.Retrieve the [Devices/dotnet/api/microsoft.store.partnercenter.devicesdeployment.idevicesbatch.devices) property to get an interface to device collection operations for the batch.

  4. Llame al método [Get/dotnet/API/Microsoft.Store.partnercenter.devicesdeployment.idevicecollection.Get) o [GetAsync/dotnet/API/Microsoft.Store.partnercenter.devicesdeployment.idevicecollection.GetAsync) para recuperar la colección de dispositivos.Call the [Get/dotnet/api/microsoft.store.partnercenter.devicesdeployment.idevicecollection.get) or [GetAsync/dotnet/api/microsoft.store.partnercenter.devicesdeployment.idevicecollection.getasync) method to retrieve the collection of devices.

IAggregatePartner partnerOperations;
string selectedCustomerId;
string selectedDeviceBatchId;

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

Para obtener un ejemplo, vea lo siguiente:For an example, see the following:

Solicitud RESTREST request

Sintaxis de la solicitudRequest syntax

MétodoMethod URI de la solicitudRequest URI
GETGET {baseurl}/v1/customers/{customer-ID}/deviceBatches/{devicebatch-ID}/Devices http/1.1{baseURL}/v1/customers/{customer-id}/deviceBatches/{devicebatch-id}/devices HTTP/1.1

Parámetros del identificador URIURI parameters

Use los siguientes parámetros de ruta de acceso al crear la solicitud.Use the following path parameters when creating the request.

NombreName TipoType ObligatorioRequired DescripciónDescription
customer-idcustomer-id stringstring Yes Cadena con formato de GUID que identifica al cliente.A GUID-formatted string that identifies the customer.
identificador de devicebatchdevicebatch-id stringstring Yes Identificador de cadena que identifica el lote del dispositivo.A string identifier that identifies the device batch.

Encabezados de solicitudRequest headers

Para obtener más información, consulta Encabezados REST del Centro de partners.For more information, see Partner Center REST headers.

Cuerpo de la solicitudRequest body

NoneNone

Ejemplo de solicitudRequest example

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: de894e18-f027-4ac0-8b5a-34f0c222af0c
X-Locale: en-US
Host: api.partnercenter.microsoft.com

Respuesta RESTREST response

Si se realiza correctamente, el cuerpo de respuesta contiene una colección paginada de recursos de dispositivo .If successful, the response body contains a paged collection of Device resources. La colección contiene 100 dispositivos en una página.The collection contains 100 devices in a page. Para recuperar la siguiente página de los dispositivos 100, el continuationToken en el cuerpo de la respuesta debe incluirse en la solicitud subsiguiente como un encabezado MS-ContinuationToken.To retrieve the next page of 100 devices, the continuationToken in the response body must be included in the subsequent request as an MS-ContinuationToken header.

Códigos de error y de respuesta correctosResponse success and error codes

Cada respuesta incluye un código de estado HTTP que indica si la operación se ha realizado correctamente o con errores y proporciona información de depuración adicional.Each response comes with an HTTP status code that indicates success or failure and additional debugging information. Use una herramienta de seguimiento de red para leer este código, el tipo de error y los parámetros adicionales.Use a network trace tool to read this code, error type, and additional parameters. Para obtener una lista completa, consulte códigos de error de REST del centro de Partners.For a full list, see Partner Center REST error codes.

Ejemplo de respuestaResponse example

HTTP/1.1 200 OK
Content-Length: 1742
Content-Type: application/json; charset=utf-8
MS-CorrelationId: 4a5002a2-0c1b-4e57-b491-dbcf19c0e7b8
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"
    }
}