Obtenir la liste des appareils pour le client et le lot spécifiésGet a list of devices for the specified batch and customer

S’applique à :Applies to:

  • Espace partenairesPartner Center
  • Espace partenaires de Microsoft Cloud GermanyPartner Center for Microsoft Cloud Germany

Cet article explique comment récupérer un regroupement d’appareils dans un lot spécifié pour un client spécifié.This article describes how to retrieve a collection of devices in a specified device batch for a specified customer. Chaque ressource d’appareil contient des détails sur l’appareil.Each device resource contains details about the device.

PrérequisPrerequisites

  • Informations d’identification, comme décrit dans Authentification auprès de l’Espace partenaires.Credentials as described in Partner Center authentication. Ce scénario prend en charge l’authentification avec les informations d’identification de l’application autonome et de l’application + utilisateur.This scenario supports authentication with both standalone App and App+User credentials.

  • ID du client (customer-tenant-id).A customer ID (customer-tenant-id). Si vous ne connaissez pas l’ID du client, vous pouvez le rechercher dans le tableau de bord de l’Espace partenaires.If you don't know the customer's ID, you can look it up in the Partner Center dashboard. Sélectionnez CSP dans le menu Espace partenaires, puis Clients.Select CSP from the Partner Center menu, followed by Customers. Sélectionnez le client dans la liste des clients, puis Compte.Select the customer from the customer list, then select Account. Dans la page du compte du client, recherchez l’ID Microsoft dans la section Informations sur le compte client.On the customer’s Account page, look for the Microsoft ID in the Customer Account Info section. L’ID Microsoft est le même que l’ID de client (customer-tenant-id).The Microsoft ID is the same as the customer ID (customer-tenant-id).

  • Identificateur de lot de l’appareil.A device batch identifier.

C#C#

Pour récupérer un regroupement des appareils dans un lot d’appareils spécifié pour le client spécifié :To retrieve a collection of the devices in a specified device batch for the specified customer:

  1. Appelez la méthode collection iaggregatepartner. Customers. méthode BYID avec l’ID client pour récupérer une interface pour les opérations sur le client spécifié.Call the IAggregatePartner.Customers.ById method with the customer ID to retrieve an interface to operations on the specified customer.

  2. Appelez la méthode DeviceBatches. méthode BYID pour obtenir une interface pour les opérations de collection de lots de périphériques pour le lot spécifié.Call the DeviceBatches.ById method to get an interface to device batch collection operations for the specified batch.

  3. Récupérez la propriété Devices pour obtenir une interface pour les opérations de collecte d’appareils pour le lot.Retrieve the Devices property to get an interface to device collection operations for the batch.

  4. Appelez la méthode GetAsync pour récupérer la collection d’appareils.Call the Get or 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();

Pour obtenir un exemple, consultez les rubriques suivantes :For an example, see the following:

Demande RESTREST request

Syntaxe de la requêteRequest syntax

MéthodeMethod URI de requêteRequest 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

Paramètres d’URIURI parameters

Utilisez les paramètres de chemin d’accès suivants lors de la création de la demande.Use the following path parameters when creating the request.

NomName TypeType ObligatoireRequired DescriptionDescription
customer-idcustomer-id stringstring OuiYes Chaîne au format GUID qui identifie le client.A GUID-formatted string that identifies the customer.
ID d’devicebatchdevicebatch-id stringstring OuiYes Identificateur de chaîne qui identifie le lot de l’appareil.A string identifier that identifies the device batch.

En-têtes de requêteRequest headers

Pour plus d’informations, consultez En-têtes REST de l’Espace Partenaires.For more information, see Partner Center REST headers.

Corps de demandeRequest body

NoneNone

Exemple de requêteRequest 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

Réponse RESTREST response

En cas de réussite, le corps de la réponse contient une collection paginée des ressources de l' appareil .If successful, the response body contains a paged collection of Device resources. La collection contient 100 périphériques dans une page.The collection contains 100 devices in a page. Pour récupérer la page suivante de 100 appareils, continuationToken dans le corps de la réponse doit être inclus dans la requête suivante en tant qu’en-tête de 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.

Codes d’erreur et de réussite de la réponseResponse success and error codes

Chaque réponse est accompagnée d’un code d’état HTTP qui indique la réussite ou l’échec ainsi que des informations de débogage supplémentaires.Each response comes with an HTTP status code that indicates success or failure and additional debugging information. Utilisez un outil de trace réseau pour lire ce code, le type d’erreur et des paramètres supplémentaires.Use a network trace tool to read this code, error type, and additional parameters. Pour obtenir une liste complète, consultez codes d’erreur REST de l’espace partenaires.For a full list, see Partner Center REST error codes.

Exemple de réponseResponse 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"
    }
}