Partager via


Créer un deviceTemplate

Espace de noms: microsoft.graph

Importante

Les API sous la version /beta dans Microsoft Graph sont susceptibles d’être modifiées. L’utilisation de ces API dans des applications de production n’est pas prise en charge. Pour déterminer si une API est disponible dans v1.0, utilisez le sélecteur Version .

Créez un deviceTemplate utilisé pour identifier les attributs et gérer un groupe d’appareils ayant des caractéristiques similaires.

Cette API est disponible dans les déploiements de cloud national suivants.

Service global Gouvernement des États-Unis L4 Us Government L5 (DOD) Chine gérée par 21Vianet

Autorisations

Choisissez l’autorisation ou les autorisations marquées comme moins privilégiées pour cette API. Utilisez une autorisation ou des autorisations privilégiées plus élevées uniquement si votre application en a besoin. Pour plus d’informations sur les autorisations déléguées et d’application, consultez Types d’autorisations. Pour en savoir plus sur ces autorisations, consultez les informations de référence sur les autorisations.

Type d’autorisation Autorisations avec privilèges minimum Autorisations privilégiées plus élevées
Déléguée (compte professionnel ou scolaire) DeviceTemplate.Create DeviceTemplate.ReadWrite.All
Déléguée (compte Microsoft personnel) Non prise en charge. Non prise en charge.
Application DeviceTemplate.Create DeviceTemplate.ReadWrite.All

Importante

Dans les scénarios délégués avec des comptes professionnels ou scolaires, l’utilisateur connecté doit se voir attribuer un rôle Microsoft Entra pris en charge ou un rôle personnalisé avec une autorisation de rôle prise en charge. Les rôles les moins privilégiés suivants sont pris en charge pour cette opération :

  • Administrateur d’appareil cloud
  • Administrateur d’appareil IoT
  • Utilisateurs : propriétaires de l’objet modèle d’appareil

Requête HTTP

POST /directory/templates/deviceTemplates

En-têtes de demande

Nom Description
Autorisation Porteur {token}. Obligatoire. En savoir plus sur l’authentification et l’autorisation.
Content-Type application/json. Obligatoire.

Corps de la demande

Dans le corps de la demande, fournissez une représentation JSON de l’objet deviceTemplate .

Vous pouvez spécifier les propriétés suivantes lorsque vous créez un deviceTemplate.

Propriété Type Description
deviceAuthority String Nom défini par le locataire pour la partie responsable de l’approvisionnement et de la gestion des appareils sur le locataire Microsoft Entra. Par exemple, Tailwind Traders (le fabricant) fabrique des caméras de sécurité installées dans les bâtiments des clients et gérées par Lakeshore Retail (l’autorité de l’appareil). Cette valeur est fournie au client par l’autorité de l’appareil (fabricant ou revendeur). Obligatoire.
Fabricant String Nom du fabricant. Obligatoire.
model String Nom du modèle. Obligatoire.
mutualTlsOauthConfigurationId String ID d’objet de mutualTlsOauthConfiguration. Cette valeur n’est pas requise si des certificats auto-signés sont utilisés à la place des certificats racines approuvés. Optional.
mutualTlsOauthConfigurationTenantId String ID (ID de locataire pour l’autorité de l’appareil) du locataire qui contient mutualTlsOauthConfiguration. Cette valeur n’est pas requise si des certificats auto-signés sont utilisés à la place des certificats racines approuvés. Optional.
operatingSystem String Type de système d’exploitation. Optional.
owners@odata.bind String collection Liste des ID que les propriétaires doivent ajouter au modèle d’appareil. Seuls les types directoryObject suivants sont pris en charge en tant que propriétaires : principaux de service, utilisateurs ou applications. Facultatif.

Réponse

Si elle réussit, cette méthode renvoie un 201 Created code de réponse et un objet deviceTemplate dans le corps de la réponse. Si un échec de validation se produit pendant les étapes de validation du certificat, la méthode retourne un 400 Bad Request avec le message « Impossible de valider le certificat d’appareil ».

Pour plus d’informations, consultez Réponses d’erreur microsoft Graph et types de ressources.

Exemples

Exemple 1 : Créer un modèle d’appareil

L’exemple suivant montre comment créer un deviceTemplate.

Demande

L’exemple suivant illustre une demande.

POST https://graph.microsoft.com/beta/directory/templates/deviceTemplates
Content-Type: application/json
Content-length: 106

{
  "mutualTlsOauthConfigurationId": "00001111-aaaa-2222-bbbb-3333cccc4444",
  "mutualTlsOauthConfigurationTenantId": "00001111-aaaa-2222-bbbb-3333cccc4445",
  "deviceAuthority": "Lakeshore Retail",
  "manufacturer": "Tailwind Traders",
  "model": "DeepFreezerModelAB",
  "operatingSystem": "WindowsIoT"
}

Réponse

L’exemple suivant illustre la réponse.

Remarque : l’objet de réponse affiché ci-après peut être raccourci pour plus de lisibilité.

HTTP/1.1 201 Created
Content-Type: application/json

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#directory/templates/deviceTemplates/$entity",
  "id": "c0ff9329-3596-4ece-8aa9-3dd23a925356",
  "mutualTlsOauthConfigurationId": "00001111-aaaa-2222-bbbb-3333cccc4444",
  "mutualTlsOauthConfigurationTenantId": "00001111-aaaa-2222-bbbb-3333cccc4445",
  "deletedDateTime": null,
  "deviceAuthority": "Lakeshore Retail",
  "manufacturer": "Tailwind Traders",
  "model": "DeepFreezerModelAB",
  "operatingSystem": "WindowsIoT"
}

Exemple 2 : Créer un modèle d’appareil avec un propriétaire

L’exemple suivant montre comment créer un deviceTemplate avec un propriétaire.

Demande

L’exemple suivant illustre une demande.

POST https://graph.microsoft.com/beta/directory/templates/deviceTemplates
Content-Type: application/json
Content-length: 106

{
  "mutualTlsOauthConfigurationId": "00001111-aaaa-2222-bbbb-3333cccc4444",
  "mutualTlsOauthConfigurationTenantId": "00001111-aaaa-2222-bbbb-3333cccc4445",
  "deviceAuthority": "Lakeshore Retail",
  "manufacturer": "Tailwind Traders",
  "model": "DeepFreezerModelAB",
  "operatingSystem": "WindowsIoT",
  "owners@odata.bind": [
    "https://graph.microsoft.com/beta/users/aaaaaaaa-bbbb-cccc-1111-222222222222"
  ]
}

Réponse

L’exemple suivant illustre la réponse.

Remarque : l’objet de réponse affiché ci-après peut être raccourci pour plus de lisibilité.

HTTP/1.1 201 Created
Content-Type: application/json

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#directory/templates/deviceTemplates/$entity",
  "id": "c0ff9329-3596-4ece-8aa9-3dd23a925356",
  "mutualTlsOauthConfigurationId": "00001111-aaaa-2222-bbbb-3333cccc4444",
  "mutualTlsOauthConfigurationTenantId": "00001111-aaaa-2222-bbbb-3333cccc4445",
  "deletedDateTime": null,
  "deviceAuthority": "Lakeshore Retail",
  "manufacturer": "Tailwind Traders",
  "model": "DeepFreezerModelAB",
  "operatingSystem": "WindowsIoT"
}