deviceTemplate: createDeviceFromTemplate

Namespace: microsoft.graph

Wichtig

Die APIs unter der /beta Version in Microsoft Graph können sich ändern. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt. Um festzustellen, ob eine API in v1.0 verfügbar ist, verwenden Sie die Version Selektor.

Erstellen Sie ein neues Gerät aus einem deviceTemplate.

Diese API ist in den folgenden nationalen Cloudbereitstellungen verfügbar.

Weltweiter Service US Government L4 US Government L5 (DOD) China, betrieben von 21Vianet

Berechtigungen

Wählen Sie die Berechtigungen aus, die für diese API als am wenigsten privilegiert markiert sind. Verwenden Sie eine höhere Berechtigung oder Berechtigungen nur, wenn Ihre App dies erfordert. Ausführliche Informationen zu delegierten Berechtigungen und Anwendungsberechtigungen finden Sie unter Berechtigungstypen. Weitere Informationen zu diesen Berechtigungen finden Sie in der Berechtigungsreferenz.

Berechtigungstyp Berechtigungen mit den geringsten Berechtigungen Berechtigungen mit höheren Berechtigungen
Delegiert (Geschäfts-, Schul- oder Unikonto) Device.CreateFromOwnedTemplate Nicht verfügbar.
Delegiert (persönliches Microsoft-Konto) Nicht unterstützt Nicht unterstützt
Application Nicht unterstützt Nicht unterstützt

Wichtig

Für den delegierten Zugriff mit Geschäfts-, Schul- oder Unikonten muss dem angemeldeten Benutzer eine unterstützte Microsoft Entra-Rolle oder eine benutzerdefinierte Rolle zugewiesen werden, die die für diesen Vorgang erforderlichen Berechtigungen gewährt. Dieser Vorgang unterstützt die folgenden integrierten Rollen, die nur die geringstmöglichen Berechtigungen gewähren:

  • Administrator für Cloudgeräte
  • Administrator für IoT-Geräte
  • Benutzer – Besitzer des Gerätevorlagenobjekts

Hinweis: Benutzer müssen Besitzer des Objekts sein.

HTTP-Anforderung

POST /directory/templates/deviceTemplates/{deviceTemplateId}/createDeviceFromTemplate

Anforderungsheader

Name Beschreibung
Authorization Bearer {token}. Erforderlich. Erfahren Sie mehr über Authentifizierung und Autorisierung.
Content-Type application/json. Erforderlich.

Anforderungstext

Geben Sie im Anforderungstext eine JSON-Darstellung der Parameter an.

In der folgenden Tabelle sind die Parameter aufgeführt, die Sie verwenden können, wenn Sie diese Aktion aufrufen.

Parameter Typ Beschreibung
accountEnabled Boolesch true, wenn das Konto aktiviert ist; andernfalls false. Der Standardwert ist true. Ein deaktiviertes Gerät kann sich nicht mit Microsoft Entra ID authentifizieren. Optional.
alternativeNames Zeichenfolgenauflistung Eine Auflistung der dem Gerät zugeordneten ARM-Ressourcen-IDs (falls vorhanden). Optional.
externalDeviceId Zeichenfolge ID des Geräts in der IoT-Registrierung. Muss innerhalb eines Mandanten eindeutig sein. Erforderlich.
externalSourceName Zeichenfolge Identifiziert den Quellnamen des Geräts. Optional.
keyCredential keyCredential Die Schlüsselanmeldeinformationen, wenn Sie selbstsignierte Zertifikate verwenden. Optional.
operatingSystemVersion Zeichenfolge Die Betriebssystemversion des angegebenen Geräts. Optional.

Antwort

Bei erfolgreicher Ausführung gibt diese Aktion einen 200 OK Antwortcode und ein Geräteobjekt im Antworttext zurück.

Weitere Informationen finden Sie unter Microsoft Graph-Fehlerantworten und Ressourcentypen.

Beispiele

Anforderung

Das folgende Beispiel zeigt eine Anfrage.

POST https://graph.microsoft.com/beta/templates/deviceTemplates/2d62b12a-0163-457d-9796-9602e9807e1/createDeviceFromTemplate
Content-Type: application/json

{
  "externalDeviceId": "2fa9424e-7ab0-4a22-8c90-2a20d15d8183",
  "operatingSystemVersion": "Ubuntu 18.04",
  "externalSourceName": "unknown",
  "accountEnabled": false,
  "alternativeNames": [
    "/subscriptions/00001111-aaaa-2222-bbbb-3333cccc4444/resourcegroups/testrg/providers/microsoft.deviceregistry/assets/asset1"
  ]
}

Antwort

Das folgende Beispiel zeigt die Antwort.

Hinweis: Das hier gezeigte Antwortobjekt kann zur besseren Lesbarkeit gekürzt werden.

HTTP/1.1 200 OK
Content-Type: application/json

{
  "id": "06d59f74-dbf3-432a-9971-c5f60374e4f0",
  "accountEnabled": false,
  "alternativeNames": [
    "/subscriptions/00001111-aaaa-2222-bbbb-3333cccc4444/resourcegroups/testrg/providers/microsoft.deviceregistry/assets/asset1"
  ],
  "deviceId": "c6ca2657-8685-4398-9edc-a6a603f177b3",
  "displayName": "2fa9424e-7ab0-4a22-8c90-2a20d15d8183",
  "externalSourceName": "unknown",
  "manufacturer": "IoT Device Template Manufacturer",
  "model": "IoT Device Template Model",
  "operatingSystem": "WindowsIoT",
  "operatingSystemVersion": "Ubuntu 18.04",
  "physicalIds": [
    "[EXTID]:2fa9424e-7ab0-4a22-8c90-2a20d15d8183"
  ],
  "profileType": "IoT",
  "sourceType": "External",
  "alternativeSecurityIds": [
    {
      "type": 2,
      "identityProvider": null,
      "key": "WAA1ADAAOQA6ADwAVQB..."
    }
  ]
}