Obtenir la liste des lots d’appareils pour le client spécifié

Article
06/19/2023

S’applique à : Espace partenaires

Comment récupérer une collection de lots d’appareils pour le client spécifié.

Chaque lot d’appareils contient des informations récapitulatives status sur les appareils qui ont été inscrits dans le déploiement sans contact.

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 autonome et d’application+utilisateur.
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).

C#

Pour obtenir la collection de lots d’appareils pour le client spécifié, appelez d’abord la méthode IAggregatePartner.Customers.ById avec l’ID client pour récupérer une interface aux opérations sur le client spécifié. Ensuite, récupérez la valeur de la propriété DeviceBatches pour obtenir une interface aux opérations de collecte par lots d’appareils. Enfin, appelez la méthode Get ou GetAsync pour récupérer la collection.

// IAggregatePartner partnerOperations;
// string selectedCustomerId;

var devicesBatches =
    partnerOperations.Customers.ById(selectedCustomerId).DeviceBatches.Get();

Exemple : application de test console. Projet : Classe d’exemples sdk de l’Espace partenaires : GetDevicesBatches.cs

Demande REST

Syntaxe de la requête

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

Paramètre d’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.

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 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 REST

En cas de réussite, le corps de la réponse contient la collection de ressources DeviceBatch .

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: 339
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": 1,
    "items": [{
            "id": "Test batch",
            "status": "finished",
            "creationDate": "2017-07-25T01:51:00",
            "devicesCount": 5,
            "devicesLink": {
                "uri": "/customers/47021739-3426-40bf-9601-61b4b6d7c793/deviceBatches/Test batch/devices",
                "method": "GET",
                "headers": []
            },
            "attributes": {
                "objectType": "DeviceBatch"
            }
        }
    ],
    "attributes": {
        "objectType": "Collection"
    }
}

Partager via