Charger la liste des appareils afin de créer un lot pour le client spécifié

Article
09/11/2024

S’applique à : Espace partenaires

Comment charger une liste d’informations sur les appareils afin de créer un lot pour le client spécifié. Cela crée un lot d’appareils pour l’inscription dans le déploiement sans contact et associe les appareils et le lot d’appareils au client spécifié.

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 les informations d’identification de l’application et de l’utilisateur. Suivez le modèle d’application sécurisé lors de l’utilisation de l’authentification App+Utilisateur avec les API de l’Espace partenaires.
ID du client (customer-tenant-id). Si vous ne connaissez pas l’ID du client, vous pouvez le rechercher dans l’Espace de partenaires en sélectionnant l’espace de travail Clients, puis le client dans la liste des clients, puis compte. Dans la page 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).
Liste des ressources d’appareil qui fournissent les informations sur les appareils individuels.

C#

Pour charger une liste d’appareils pour créer un lot d’appareils :

Instanciez un nouveau [List/dotnet/api/system.collections.generic.list-1) de type Appareil et remplissez la liste avec les appareils. Les combinaisons suivantes de propriétés remplies sont requises au minimum pour identifier chaque appareil :
- HardwareHash + ProductKey.
- HardwareHash + SerialNumber.
- HardwareHash + ProductKey + SerialNumber.
- HardwareHash uniquement.
- ProductKey uniquement.
- SerialNumber + OemManufacturerName + ModelName.
Instanciez un objet DeviceBatchCreationRequest et définissez la propriété BatchId sur un nom unique de votre choix, et la propriété Devices sur la liste des appareils à charger.
Traitez la demande de création de lot d’appareils en appelant la méthode IAggregatePartner.Customers.ById avec l’identificateur du client pour récupérer une interface aux opérations sur le client spécifié.
Appelez la méthode DeviceBatches.Create ou CreateAsync avec la demande de création de lot d’appareils pour créer le lot.

IAggregatePartner partnerOperations;
string selectedCustomerId;

List<Device> devicesToBeUploaded = new List<Device>
{
    new Device
    {
        HardwareHash = "DummyHash123",
        ProductKey = "00329-00000-0003-AA606",
        SerialNumber = "1R9-ZNP67"
    }
};

DeviceBatchCreationRequest
    newDeviceBatch = new DeviceBatchCreationRequest
{
    BatchId = "SDKTestDeviceBatch",
    Devices = devicesToBeUploaded
};

var trackingLocation =
    partnerOperations.Customers.ById(selectedCustomerId).DeviceBatches.Create(newDeviceBatch);

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

Demande REST

Syntaxe de la requête

Méthode	URI de demande
POST	{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 requête.

Nom	Type	Requise	Description
id-client	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 la demande

Le corps de la requête doit contenir une ressource DeviceBatchCreationRequest .

Exemple de requête

POST https://api.partnercenter.microsoft.com/v1/customers/c7f3c849-129f-4b85-a96d-4f8e88b315a3/deviceBatches HTTP/1.1
Authorization: Bearer <token>
Accept: application/json
MS-RequestId: c245d5f2-1de3-4ae0-9e42-95e38e3cb8ff
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
X-Locale: en-US
MS-PartnerCenter-Application: Partner Center .NET SDK Samples
Content-Type: application/json
Host: api.partnercenter.microsoft.com
Content-Length: 340
Expect: 100-continue
Connection: Keep-Alive
{
    "BatchId": "SDKTestDeviceBatch",
    "Devices": [{
            "Id": null,
            "SerialNumber": "1R9-ZNP67",
            "ProductKey": "00329-00000-0003-AA606",
            "HardwareHash": "DummyHash123",
            "Policies": null,
            "CreatedBy": null,
            "UploadedDate": "0001-01-01T00:00:00",
            "AllowedOperations": null,
            "Attributes": {
                "ObjectType": "Device"
            }
        }
    ],
    "Attributes": {
        "ObjectType": "DeviceBatchCreationRequest"
    }
}

Important

Depuis juin 2023, la dernière version du Kit de développement logiciel (SDK) .NET de l’Espace partenaires version 3.4.0 est désormais archivée. Vous pouvez télécharger la version du SDK à partir de GitHub, ainsi qu’un fichier lisezmoi contenant des informations utiles.

Les partenaires sont encouragés à continuer à utiliser les API REST de l’Espace partenaires.

Réponse REST

Si elle réussit, la réponse contient un en-tête Location qui a un URI qui peut être utilisé pour récupérer l’état du chargement de l’appareil. Enregistrez cet URI à utiliser avec d’autres API REST associées.

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 202 Accepted
Content-Length: 0
Location: /customers/c7f3c849-129f-4b85-a96d-4f8e88b315a3/batchJobStatus/beba2053-5401-46ff-9223-7e841ed78fbf
MS-CorrelationId: bbbb1111-cc22-3333-44dd-555555eeeeee
MS-RequestId: cb82f7d6-f0d9-44d4-82f9-f6eee6e68390
MS-CV: iqOqN0FnaE2y0HcD.0
MS-ServerId: 030020525
Date: Thu, 28 Sep 2017 20:35:35 GMT

Partager via