Obtenir la liste des appareils pour le client et le lot spécifiés

Article
09/11/2024

S’applique à : Espace partenaires

Cet article explique comment récupérer une collection d’appareils dans un lot d’appareils spécifié pour un client spécifié. Chaque ressource d’appareil contient des détails sur l’appareil.

Prérequis

Informations d’identification, comme décrit dans Authentification auprès de l’Espace partenaires. Ce scénario prend en charge l’authentification avec des informations d’identification d’application et d’utilisateur autonomes.
ID du client (customer-tenant-id). Si vous ne connaissez pas l’ID du client, vous pouvez le rechercher dans l’Espace partenaires en sélectionnant l’espace de travail Clients , puis le client dans la liste des clients, puis Compte. Dans la page du compte du client, recherchez l’ID Microsoft dans la section Informations sur le compte client. L’ID Microsoft est le même que l’ID de client (customer-tenant-id).
Identificateur de lot d’appareil.

C#

Pour récupérer une collection d’appareils dans un lot d’appareils spécifié pour le client spécifié :

Appelez la méthode IAggregatePartner.Customers.ById avec l’ID client pour récupérer une interface aux opérations sur le client spécifié.
Appelez la méthode DeviceBatches.ById pour obtenir une interface pour les opérations de collecte de lots d’appareils pour le lot spécifié.
Récupérez la propriété Devices pour obtenir une interface pour les opérations de collecte d’appareils pour le lot.
Appelez la méthode Get ou GetAsync pour récupérer la collection d’appareils.

IAggregatePartner partnerOperations;
string selectedCustomerId;
string selectedDeviceBatchId;

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

Pour obtenir un exemple, consultez les éléments suivants :

Exemple : Application de test de console
Projet : Exemples du SDK de l’Espace partenaires
Classe : GetDevices.cs

Demande REST

Syntaxe de la requête

Méthode	URI de requête
GET	{baseURL}/v1/customers/{customer-id}/deviceBatches/{devicebatch-id}/devices HTTP/1.1

Paramètres URI

Utilisez les paramètres de chemin d’accès suivants lors de la création de la demande.

Nom	Type	Obligatoire	Description
customer-id	string	Oui	Chaîne au format GUID qui identifie le client.
devicebatch-id	string	Oui	Identificateur de chaîne qui identifie le lot d’appareils.

En-têtes de requête

Pour plus d’informations, consultez En-têtes REST de l’Espace Partenaires.

Corps de demande

None

Exemple de requête

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

Réponse REST

En cas de réussite, le corps de la réponse contient une collection paginée de ressources d’appareil . La collection contient 100 appareils dans une page. Pour récupérer la page suivante de 100 appareils, le continuationToken dans le corps de la réponse doit être inclus dans la requête suivante en tant qu’en-tête MS-ContinuationToken.

Codes d’erreur et de réussite de la réponse

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. Utilisez un outil de trace réseau pour lire ce code, le type d’erreur et des paramètres supplémentaires. Pour obtenir la liste complète, consultez Codes d’erreur REST de l’Espace partenaires.

Exemple de réponse

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"
    }
}

Partager via