Azure IoT Central V3 (Vorschau)

Azure IoT Central erleichtert das Verbinden, Überwachen und Verwalten Ihrer IoT-Geräte im großen Maßstab. Mit dem IoT Central V3-Connector können Sie Workflows auslösen, wenn eine Regel ausgelöst wurde, und Aktionen ausführen, indem Sie Befehle ausführen, Eigenschaften aktualisieren, Telemetrie von Geräten abrufen und vieles mehr. Verwenden Sie diesen Connector mit Ihrer Azure IoT Central V3-Anwendung.

Dieser Connector ist in den folgenden Produkten und Regionen verfügbar:

Dienstleistung	Class	Regions
Copilot Studio	Premium	Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD)
Logik-Apps	Norm	Alle Logik-Apps-Regionen mit Ausnahme der folgenden Bereiche: – Azure Government-Regionen - Azure China-Regionen - US Department of Defense (DoD)
Power Apps	Premium	Alle Power Apps-Regionen mit Ausnahme der folgenden: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD)
Power Automate	Premium	Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD)

Kontakt
Name	Technischer Support für Azure IoT
URL	https://aka.ms/iotcentral-create-technical-support-ticket-trial

Connectormetadaten
Herausgeber	Microsoft Corporation
Webseite	https://azure.microsoft.com/services/iot-central/
Datenschutzrichtlinie	https://privacy.microsoft.com
Kategorien	Internet der Dinge

Der Azure IoT Central V3-Connector kann verwendet werden, um Ihre Azure IoT Central V3-Anwendung mit Ihren Workflows zu verbinden. Sie können den Connector verwenden, um Workflows auszuführen, wenn eine Regel ausgelöst wird. Sie können es verwenden, um die neuesten Informationen von Ihren IoT-Geräten wie Telemetriedaten und Eigenschaften abzurufen. Außerdem können Sie sie verwenden, um Ihre IoT-Geräte zu aktualisieren, indem Sie Befehle senden und die Richtigen aktualisieren.

Voraussetzungen

Sie müssen ein Benutzer in einer Azure IoT Central V3 Pay-As-You-Go-Anwendung sein, um diesen Connector zu verwenden.
Sie müssen ein Geschäfts-, Schul- oder Unikonto der Microsoft Entra-ID verwenden.

So erhalten Sie Anmeldeinformationen

Um diesen Connector zu Ihrem Workflow hinzuzufügen, müssen Sie sich zuerst bei dem Geschäfts-, Schul- oder Unikonto von Microsoft Entra anmelden, das ein Benutzer in der Azure IoT Central-Anwendung ist, mit der Sie eine Verbindung herstellen möchten.

Versionshinweise

September 2021

Der Azure IoT Central V3-Connector wurde jetzt aktualisiert, um unsere allgemein verfügbare 1.0-REST-API-Oberfläche auszurichten. Alle Verbinderaktionen unterstützen jetzt unser DTDLv2-Format und die Unterstützung für DTDLv1-basierte Modelle sind veraltet.
Die Aktionen für Run a device command, Get/Update device propertiesund Get device telemetry value wurden aktualisiert, um Unterstützung für die neuesten Gerätevorlagenfeatures in Azure IoT Central hinzuzufügen. Diese Aktionen unterstützen jetzt sowohl die Stamm- als auch die Komponentenfunktionen.
Es wurde eine neue Gruppe von Gerätemodulaktionen hinzugefügt. Diese Aktionen ermöglichen die Erstellung von Workflows, die mit Befehlen, Eigenschaften, Telemetrien von Gerätemodulen und Modulkomponenten interagieren.
Aktionen, die Get/Create/Update/Delete a device aktualisiert wurden, um die neueste Rest-API von Azure IoT Central auszurichten.
Die Aktionen Get device cloud properties und Update device cloud properties sind jetzt Teil Get device properties und Update device properties. Mit den neuen Aktionen können Workflows gleichzeitig mit Geräteeigenschaften und Cloudeigenschaften interagieren.

Veralteter Hinweis: Bis Ende von CY21 sind die aktionen, die in der nachstehenden Liste als veraltet gekennzeichnet sind, nicht mehr verfügbar, wenn sie neue Workflows erstellen. Bestehende Workflows, die auf diese Aktionen verweisen, funktionieren bis März 2022 weiterhin. Wir empfehlen Ihnen, Ihre Workflows zu aktualisieren, um die neu angekündigten Aktionen zu nutzen, die jetzt in Azure IoT Central unterstützt werden.

November 2021

Neue Aktionen wurden zum Auflisten von Geräten und Gerätevorlagen für eine Azure IoT Central-Anwendung hinzugefügt. Diese Aktionen umfassen die Paginierungsunterstützung.
Dem Connector wurde eine neue Gruppe von Benutzerverwaltungsaktionen hinzugefügt, sodass Workflows Benutzer einer Anwendung erstellen, aktualisieren, auflisten und löschen können.
Workflows können jetzt die neueste Ausführung eines Gerätebefehls mithilfe der neuen Get device command response Aktionen abrufen. Diese Gruppe von Aktionen unterstützt Stamm-, Komponenten- und Modulbefehle.

Bekannte Probleme und Einschränkungen

Um diesen Connector in Microsoft Power Automate zu verwenden, müssen Sie mindestens einmal bei der IoT Central-Anwendung angemeldet sein. Andernfalls wird die Anwendung nicht im Dropdownmenü "Anwendung" angezeigt.
Persönliche Microsoft-Konten (z@hotmail.com. B. , @live.com@outlook.com Domänen) werden nicht unterstützt, um sich beim IoT Central-Connector anzumelden. Sie müssen ein Geschäfts-, Schul- oder Unikonto der Microsoft Entra-ID verwenden.

Erstellen einer Verbindung

Der Connector unterstützt die folgenden Authentifizierungstypen:


Credentials	Credentials	Alle Regionen	Nicht teilbar
Standard [VERALTET]	Diese Option ist nur für ältere Verbindungen ohne expliziten Authentifizierungstyp vorgesehen und wird nur aus Gründen der Abwärtskompatibilität bereitgestellt.	Alle Regionen	Nicht teilbar

Credentials

Authentifizierungs-ID: 1stparty

Anwendbar: Alle Regionen

Credentials

Dies ist keine freigabefähige Verbindung. Wenn die Power-App für einen anderen Benutzer freigegeben wird, wird ein anderer Benutzer aufgefordert, eine neue Verbindung explizit zu erstellen.

Standard [VERALTET]

Anwendbar: Alle Regionen

Diese Option ist nur für ältere Verbindungen ohne expliziten Authentifizierungstyp vorgesehen und wird nur aus Gründen der Abwärtskompatibilität bereitgestellt.

Dies ist keine freigabefähige Verbindung. Wenn die Power-App für einen anderen Benutzer freigegeben wird, wird ein anderer Benutzer aufgefordert, eine neue Verbindung explizit zu erstellen.

Drosselungsgrenzwerte

Name	Aufrufe	Verlängerungszeitraum
API-Aufrufe pro Verbindung	100	60 Sekunden

Aktionen

Abrufen der Befehlsantwort für Modulkomponenten	Rufen Sie die letzte Antwort für einen Modulkomponentenbefehl ab.
Abrufen der Gerätebefehlsantwort	Rufen Sie die letzte Antwort für einen Gerätebefehl ab.
Abrufen der Komponentenbefehlsantwort	Rufen Sie die letzte Antwort für einen Gerätekomponentenbefehl ab.
Abrufen der Modulbefehlsantwort	Abrufen der letzten Antwort für einen Gerätemodulbefehl
Abrufen des Gerätetelemetriewerts (veraltet)	Rufen Sie den letzten Telemetriewert von einem Gerät ab (veraltet).
Abrufen des Komponententelemetriewerts	Rufen Sie den letzten Telemetriewert aus einer Komponente ab.
Abrufen des Modul-Telemetriewerts	Rufen Sie den letzten Telemetriewert aus einem Modul ab.
Abrufen des Telemetriewerts der Modulkomponente	Rufen Sie den letzten Telemetriewert aus einer Modulkomponente ab.
Abrufen einer Gerätegruppe	Rufen Sie Details zu einer vorhandenen Gerätegruppe nach ID ab.
Abrufen einer Gerätevorlage nach ID	Rufen Sie Details zu einer vorhandenen Gerätevorlage anhand der ID ab.
Abrufen einer Organisation	Rufen Sie Details zu einer vorhandenen Organisation anhand der ID ab.
Abrufen eines geplanten Auftrags	Rufen Sie Details zu einem vorhandenen geplanten Auftrag anhand der ID ab.
Abrufen eines Geräts nach ID (veraltet)	Abrufen von Details zu einem vorhandenen Gerät nach Geräte-ID (veraltet).
Abrufen von Aufträgen nach geplanter Auftrags-ID	Ruft die Liste der Aufträge für eine geplante Auftragsdefinition ab.
Abrufen von Cloud-Eigenschaften des Geräts (veraltet)	Abrufen aller Cloudeigenschaftenwerte eines Geräts nach Geräte-ID (veraltet).
Abrufen von Geräteeigenschaften	Ruft alle Eigenschaftswerte eines Geräts nach Geräte-ID ab.
Abrufen von Geräteeigenschaften (veraltet)	Ruft alle Eigenschaftswerte eines Geräts nach Geräte-ID ab (veraltet).
Abrufen von Moduleigenschaften	Ruft alle Eigenschaftswerte eines Moduls ab.
Aktualisieren einer Gerätebeziehung	Aktualisieren Sie eine vorhandene Gerätebeziehung zwischen dem angegebenen Gerät und einem neuen Gerät mit einer Geräte-ID und einer Beziehungs-ID.
Aktualisieren eines geplanten Auftrags	Aktualisieren Sie einen vorhandenen geplanten Auftrag anhand der ID.
Aktualisieren von Gerätecloudeigenschaften (veraltet)	Aktualisieren Sie alle Cloudeigenschaftenwerte eines Geräts nach Geräte-ID (veraltet).
Aktualisieren von Geräteeigenschaften	Aktualisieren Sie alle Eigenschaftswerte eines Geräts anhand der Geräte-ID.
Aktualisieren von Geräteeigenschaften (veraltet)	Aktualisieren Sie alle Eigenschaftswerte eines Geräts nach Geräte-ID (veraltet).
Aktualisieren von Moduleigenschaften	Alle Eigenschaftswerte eines Moduls aktualisieren.
Auflisten von Beziehungen	Listet alle Beziehungen auf, die auf der Geräte-ID basieren.
Auflisten von Gerätegruppen	Ruft die Liste der Gerätegruppen in einer Anwendung ab.
Auflisten von Gerätevorlagen	Ruft die Liste der Gerätevorlagen in einer Anwendung ab.
Auftrag abrufen	Rufen Sie Details zu einem vorhandenen Auftrag anhand der ID ab.
Aufträge auflisten	Ruft die Liste der Aufträge in einer Anwendung ab.
Ausführen eines Gerätebefehls	Führen Sie einen Befehl auf einem Gerät aus.
Ausführen eines Gerätebefehls (veraltet)	Führen Sie einen Befehl auf einem Gerät aus (veraltet).
Ausführen eines Komponentenbefehls	Führen Sie einen Befehl für eine Komponente aus.
Ausführen eines Modulbefehls	Führen Sie einen Befehl in einem Modul aus.
Ausführen eines Modulkomponentenbefehls	Führen Sie einen Befehl für eine Modulkomponente aus.
Beenden eines ausgeführten Auftrags	Beenden Sie die Ausführung eines Auftrags, der derzeit ausgeführt wird.
Benutzer abrufen	Abrufen eines Benutzers nach ID
Benutzer aktualisieren	Aktualisieren eines Benutzers in der Anwendung über Patch
Benutzer auflisten	Abrufen der Liste der Benutzer in einer Anwendung
Benutzer erstellen	Erstellen eines Benutzers in der Anwendung
Benutzer löschen	Löschen eines Benutzers
Ein Gerät anhand der ID abrufen	Rufen Sie Details zu einem vorhandenen Gerät anhand der Geräte-ID ab.
Einen Job erstellen	Erstellen und Ausführen eines neuen Auftrags über die Auftragsdefinition
Erstellen einer Gerätebeziehung	Erstellen Sie eine neue Gerätebeziehung zwischen dem angegebenen Gerät und einem neuen Gerät mit einer Geräte-ID und einer Beziehungs-ID.
Erstellen einer Gerätegruppe	Dient zum Erstellen oder Aktualisieren einer Gerätegruppe.
Erstellen einer Organisation	Neue Organisation erstellen.
Erstellen oder Aktualisieren eines Geräts	Erstellen Sie ein neues Gerät, oder aktualisieren Sie ein vorhandenes gerät nach Geräte-ID.
Erstellen oder Aktualisieren eines Geräts (veraltet)	Erstellen Sie ein neues Gerät, oder aktualisieren Sie ein vorhandenes gerät nach Geräte-ID. (veraltet)
Erstellen oder Aktualisieren eines Geräts (veraltet)	Erstellen Sie ein neues Gerät, oder aktualisieren Sie ein vorhandenes gerät nach Geräte-ID (veraltet).
Fortsetzen eines angehaltenen Auftrags	Fortsetzen der Ausführung eines vorhandenen beendeten Auftrags.
Fortsetzen eines Auftrags auf fehlgeschlagenen Geräten	Führen Sie eine erneute Ausführung eines vorhandenen Auftrags auf allen fehlgeschlagenen Geräten aus.
Geplante Aufträge auflisten	Ruft die Liste der geplanten Aufträge in einer Anwendung ab.
Geplanten Auftrag erstellen	Erstellen und Ausführen eines neuen geplanten Auftrags über die Auftragsdefinition.
Gerät löschen	Löschen Eines vorhandenen Geräts nach Geräte-ID.
Geräte auflisten	Ruft die Liste der Geräte in einer Anwendung ab.
Geräte nach Gerätegruppen-ID abrufen	Ruft die Liste der Geräte in einer Gerätegruppe in einer Anwendung ab.
Geräte-Telemetriewert abrufen	Rufen Sie den letzten Telemetriewert von einem Gerät ab.
Gerätebeziehung abrufen	Rufen Sie Details zu einer vorhandenen Gerätebeziehung nach Geräte-ID und nach Beziehungs-ID ab.
Gerätegruppe löschen	Löschen einer vorhandenen Gerätegruppe nach ID
Gerätestatus abrufen	Rufen Sie die Liste der einzelnen Gerätestatus nach Auftrags-ID ab.
Löschen der Organisation	Löschen einer vorhandenen Organisation nach ID
Löschen einer Gerätebeziehung	Löschen Sie eine vorhandene Gerätebeziehung nach Geräte-ID und Beziehungs-ID.
Löschen einer Gerätevorlage	Löschen Sie eine vorhandene Gerätevorlage nach ID.
Löschen eines geplanten Auftrags	Löschen Sie einen vorhandenen geplanten Auftrag nach ID.
Löschen eines Geräts (veraltet)	Löschen eines vorhandenen Geräts nach Geräte-ID (veraltet).
Organisationen auflisten	Ruft die Liste der Organisationen in einer Anwendung ab.
Rolle abrufen	Abrufen einer Rolle nach ID.
Rollen auflisten	Ruft die Liste der Rollen in einer Anwendung ab.

Abrufen der Befehlsantwort für Modulkomponenten

Vorgangs-ID:: Devices_GetModuleComponentCommandResponse_V1

Rufen Sie die letzte Antwort für einen Modulkomponentenbefehl ab.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Application	application	True	string	Eindeutige ID der Anwendung.
Geräte-ID	device_id	True	string	Eindeutige ID des Geräts.
Gerätemodul	module	True	string	Name des Gerätemoduls.
Gerätekomponente	component_name	True	string	Name der Gerätekomponente.
Gerätebefehl	command_name	True	string	Name dieses Gerätebefehls.
Gerätevorlage	template		string	Die Gerätevorlagendefinition für das Gerät.

Gibt zurück

Die Ausgaben dieses Vorgangs sind dynamisch.

Abrufen der Gerätebefehlsantwort

Vorgangs-ID:: Devices_GetCommandResponse_V1

Rufen Sie die letzte Antwort für einen Gerätebefehl ab.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Application	application	True	string	Eindeutige ID der Anwendung.
Geräte-ID	device_id	True	string	Eindeutige ID des Geräts.
Gerätebefehl	command_name	True	string	Name dieses Gerätebefehls.
Gerätevorlage	template		string	Die Gerätevorlagendefinition für das Gerät.

Gibt zurück

Die Ausgaben dieses Vorgangs sind dynamisch.

Abrufen der Komponentenbefehlsantwort

Vorgangs-ID:: Devices_GetComponentCommandResponse_V1

Rufen Sie die letzte Antwort für einen Gerätekomponentenbefehl ab.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Application	application	True	string	Eindeutige ID der Anwendung.
Geräte-ID	device_id	True	string	Eindeutige ID des Geräts.
Gerätekomponente	component_name	True	string	Name der Gerätekomponente.
Gerätebefehl	command_name	True	string	Name dieses Gerätebefehls.
Gerätevorlage	template		string	Die Gerätevorlagendefinition für das Gerät.

Gibt zurück

Die Ausgaben dieses Vorgangs sind dynamisch.

Abrufen der Modulbefehlsantwort

Vorgangs-ID:: Devices_GetModuleCommandResponse_V1

Abrufen der letzten Antwort für einen Gerätemodulbefehl

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Application	application	True	string	Eindeutige ID der Anwendung.
Geräte-ID	device_id	True	string	Eindeutige ID des Geräts.
Gerätemodul	module	True	string	Name des Gerätemoduls.
Gerätebefehl	command_name	True	string	Name dieses Gerätebefehls.
Gerätevorlage	template		string	Die Gerätevorlagendefinition für das Gerät.

Gibt zurück

Die Ausgaben dieses Vorgangs sind dynamisch.

Abrufen des Gerätetelemetriewerts (veraltet)

Vorgangs-ID:: Devices_GetComponentTelemetryValue

Rufen Sie den letzten Telemetriewert von einem Gerät ab (veraltet).

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Application	application	True	string	Eindeutige ID der Anwendung.
Geräte-ID	device_id	True	string	Eindeutige ID des Geräts.
Gerätekomponente	component_name	True	string	Name der Gerätekomponente.
Gerätetelemetrie	telemetry_name	True	string	Name dieser Gerätetelemetrie.
Gerätevorlagen-ID	instanceOf		string	Die Gerätevorlagendefinition für das Gerät.

Gibt zurück

Die Ausgaben dieses Vorgangs sind dynamisch.

Abrufen des Komponententelemetriewerts

Vorgangs-ID:: Devices_GetComponentTelemetryValue_V1

Rufen Sie den letzten Telemetriewert aus einer Komponente ab.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Application	application	True	string	Eindeutige ID der Anwendung.
Geräte-ID	device_id	True	string	Eindeutige ID des Geräts.
Gerätekomponente	component_name	True	string	Name der Gerätekomponente.
Gerätetelemetrie	telemetry_name	True	string	Name dieser Gerätetelemetrie.
Gerätevorlage	template		string	Die Gerätevorlagendefinition für das Gerät.

Gibt zurück

Die Ausgaben dieses Vorgangs sind dynamisch.

Abrufen des Modul-Telemetriewerts

Vorgangs-ID:: Devices_GetModuleTelemetryValue_V1

Rufen Sie den letzten Telemetriewert aus einem Modul ab.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Application	application	True	string	Eindeutige ID der Anwendung.
Geräte-ID	device_id	True	string	Eindeutige ID des Geräts.
Gerätemodul	module	True	string	Name des Gerätemoduls.
Gerätetelemetrie	telemetry_name	True	string	Name dieser Gerätetelemetrie.
Gerätevorlage	template		string	Die Gerätevorlagendefinition für das Gerät.

Gibt zurück

Die Ausgaben dieses Vorgangs sind dynamisch.

Abrufen des Telemetriewerts der Modulkomponente

Vorgangs-ID:: Devices_GetModuleComponentTelemetryValue_V1

Rufen Sie den letzten Telemetriewert aus einer Modulkomponente ab.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Application	application	True	string	Eindeutige ID der Anwendung.
Geräte-ID	device_id	True	string	Eindeutige ID des Geräts.
Gerätemodul	module	True	string	Name des Gerätemoduls.
Gerätekomponente	component_name	True	string	Name der Gerätekomponente.
Gerätetelemetrie	telemetry_name	True	string	Name dieser Gerätetelemetrie.
Gerätevorlage	template		string	Die Gerätevorlagendefinition für das Gerät.

Gibt zurück

Die Ausgaben dieses Vorgangs sind dynamisch.

Abrufen einer Gerätegruppe

Vorgangs-ID:: DeviceGroups_Get

Rufen Sie Details zu einer vorhandenen Gerätegruppe nach ID ab.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Application	application	True	string	Eindeutige ID der Anwendung.
Gerätegruppen-ID	device_group_id	True	string	Eindeutige ID der Gerätegruppe.

Gibt zurück

Die Gerätegruppendefinition.

Body: DeviceGroup

Abrufen einer Gerätevorlage nach ID

Vorgangs-ID:: DeviceTemplates_Get_V1

Rufen Sie Details zu einer vorhandenen Gerätevorlage anhand der ID ab.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Application	application	True	string	Eindeutige ID der Anwendung.
Template	template_id	True	string	Eindeutige ID der Vorlage.

Gibt zurück

Body: DeviceTemplateV1

Abrufen einer Organisation

Vorgangs-ID:: Organizations_Get

Rufen Sie Details zu einer vorhandenen Organisation anhand der ID ab.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Application	application	True	string	Eindeutige ID der Anwendung.
Organisations-ID	organization_id	True	string	Eindeutige ID der Organisation.

Gibt zurück

Body: Organization

Abrufen eines geplanten Auftrags

Vorgangs-ID:: ScheduledJobs_Get

Rufen Sie Details zu einem vorhandenen geplanten Auftrag anhand der ID ab.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Application	application	True	string	Eindeutige ID der Anwendung.
Geplante Auftrags-ID	scheduled_job_id	True	string	Eindeutige ID des geplanten Auftrags.

Gibt zurück

Die Ausgaben dieses Vorgangs sind dynamisch.

Abrufen eines Geräts nach ID (veraltet)

Vorgangs-ID:: Devices_Get

Abrufen von Details zu einem vorhandenen Gerät nach Geräte-ID (veraltet).

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Application	application	True	string	Eindeutige ID der Anwendung.
Geräte-ID	device_id	True	string	Eindeutige ID des Geräts.

Gibt zurück

Body: Device

Abrufen von Aufträgen nach geplanter Auftrags-ID

Vorgangs-ID:: ScheduledJobs_ListJobs

Ruft die Liste der Aufträge für eine geplante Auftragsdefinition ab.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Application	application	True	string	Eindeutige ID der Anwendung.
Geplante Auftrags-ID	scheduled_job_id	True	string	Eindeutige ID des geplanten Auftrags.

Gibt zurück

Die seitenseitigen Ergebnisse von Auftragsdefinitionen, die zu einem geplanten Auftrag gehören.

Body: ScheduledJobJobCollection

Abrufen von Cloud-Eigenschaften des Geräts (veraltet)

Vorgangs-ID:: Devices_GetCloudProperties

Abrufen aller Cloudeigenschaftenwerte eines Geräts nach Geräte-ID (veraltet).

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Application	application	True	string	Eindeutige ID der Anwendung.
Geräte-ID	device_id	True	string	Eindeutige ID des Geräts.
Gerätevorlagen-ID	instanceOf		string	Die Gerätevorlagendefinition für das Gerät.

Gibt zurück

Die Ausgaben dieses Vorgangs sind dynamisch.

Abrufen von Geräteeigenschaften

Vorgangs-ID:: Devices_GetProperties_V1

Ruft alle Eigenschaftswerte eines Geräts nach Geräte-ID ab.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Application	application	True	string	Eindeutige ID der Anwendung.
Geräte-ID	device_id	True	string	Eindeutige ID des Geräts.
Gerätevorlage	template		string	Die Gerätevorlagendefinition für das Gerät.

Gibt zurück

Die Ausgaben dieses Vorgangs sind dynamisch.

Abrufen von Geräteeigenschaften (veraltet)

Vorgangs-ID:: Devices_GetProperties

Ruft alle Eigenschaftswerte eines Geräts nach Geräte-ID ab (veraltet).

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Application	application	True	string	Eindeutige ID der Anwendung.
Geräte-ID	device_id	True	string	Eindeutige ID des Geräts.
Gerätevorlagen-ID	instanceOf		string	Die Gerätevorlagendefinition für das Gerät.

Gibt zurück

Die Ausgaben dieses Vorgangs sind dynamisch.

Abrufen von Moduleigenschaften

Vorgangs-ID:: Devices_GetModuleProperties_V1

Ruft alle Eigenschaftswerte eines Moduls ab.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Application	application	True	string	Eindeutige ID der Anwendung.
Geräte-ID	device_id	True	string	Eindeutige ID des Geräts.
Gerätemodul	module	True	string	Name des Gerätemoduls.
Gerätevorlage	template		string	Die Gerätevorlagendefinition für das Gerät.

Gibt zurück

Die Ausgaben dieses Vorgangs sind dynamisch.

Aktualisieren einer Gerätebeziehung

Vorgangs-ID:: DeviceRelationships_Update

Aktualisieren Sie eine vorhandene Gerätebeziehung zwischen dem angegebenen Gerät und einem neuen Gerät mit einer Geräte-ID und einer Beziehungs-ID.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Application	application	True	string	Eindeutige ID der Anwendung.
Geräte-ID	device_id	True	string	Eindeutige ID des Geräts.
Beziehungs-ID	relationship_id	True	string	Eindeutige ID der Gerätebeziehung.
Gerätebeziehungs-ID	id		string	Eindeutige ID der Gerätebeziehung.
Ziel-ID für Gerätebeziehung	target	True	string	Die Geräte-ID des Quellgeräts (untergeordnetes Gerät).

Gibt zurück

Body: DeviceRelationshipStatic

Aktualisieren eines geplanten Auftrags

Vorgangs-ID:: ScheduledJobs_Update

Aktualisieren Sie einen vorhandenen geplanten Auftrag anhand der ID.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Application	application	True	string	Eindeutige ID der Anwendung.
Geplante Auftrags-ID	scheduled_job_id	True	string	Eindeutige ID des geplanten Auftrags.
Zeitplan-Endtyp	scheduled_job_end_type		string	Wie der geplante Auftrag enden soll (nicht auf Gerätevorlagenmigrationen angewendet).
Body	body	True	dynamic	Geplanter Auftragserstellungstext.

Gibt zurück

Die Definition des geplanten Auftrags.

Body: ScheduledJobStatic

Aktualisieren von Gerätecloudeigenschaften (veraltet)

Vorgangs-ID:: Devices_UpdateCloudProperties

Aktualisieren Sie alle Cloudeigenschaftenwerte eines Geräts nach Geräte-ID (veraltet).

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Application	application	True	string	Eindeutige ID der Anwendung.
Geräte-ID	device_id	True	string	Eindeutige ID des Geräts.
Gerätevorlagen-ID	instanceOf		string	Die Gerätevorlagendefinition für das Gerät.
body	body	True	dynamic	Geräteeigenschaften.

Gibt zurück

Die Ausgaben dieses Vorgangs sind dynamisch.

Aktualisieren von Geräteeigenschaften

Vorgangs-ID:: Devices_UpdateProperties_V1

Aktualisieren Sie alle Eigenschaftswerte eines Geräts anhand der Geräte-ID.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Application	application	True	string	Eindeutige ID der Anwendung.
Geräte-ID	device_id	True	string	Eindeutige ID des Geräts.
Gerätevorlage	template		string	Die Gerätevorlagendefinition für das Gerät.
body	body	True	dynamic	Geräteeigenschaften.

Gibt zurück

Die Ausgaben dieses Vorgangs sind dynamisch.

Aktualisieren von Geräteeigenschaften (veraltet)

Vorgangs-ID:: Devices_UpdateProperties

Aktualisieren Sie alle Eigenschaftswerte eines Geräts nach Geräte-ID (veraltet).

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Application	application	True	string	Eindeutige ID der Anwendung.
Geräte-ID	device_id	True	string	Eindeutige ID des Geräts.
Gerätevorlagen-ID	instanceOf		string	Die Gerätevorlagendefinition für das Gerät.
body	body	True	dynamic	Geräteeigenschaften.

Gibt zurück

Die Ausgaben dieses Vorgangs sind dynamisch.

Aktualisieren von Moduleigenschaften

Vorgangs-ID:: Devices_UpdateModuleProperties_V1

Alle Eigenschaftswerte eines Moduls aktualisieren.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Application	application	True	string	Eindeutige ID der Anwendung.
Geräte-ID	device_id	True	string	Eindeutige ID des Geräts.
Gerätemodul	module	True	string	Name des Gerätemoduls.
Gerätevorlage	template		string	Die Gerätevorlagendefinition für das Gerät.
body	body	True	dynamic	Geräteeigenschaften.

Gibt zurück

Die Ausgaben dieses Vorgangs sind dynamisch.

Auflisten von Beziehungen

Vorgangs-ID:: DeviceRelationships_List

Listet alle Beziehungen auf, die auf der Geräte-ID basieren.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Application	application	True	string	Eindeutige ID der Anwendung.
Geräte-ID	device_id	True	string	Eindeutige ID des Geräts.

Gibt zurück

Body: DeviceRelationshipCollection

Auflisten von Gerätegruppen

Vorgangs-ID:: DeviceGroups_List

Ruft die Liste der Gerätegruppen in einer Anwendung ab.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Application	application	True	string	Eindeutige ID der Anwendung.

Gibt zurück

Die seitenseitigen Ergebnisse von Gerätegruppen.

Body: DeviceGroupCollection

Auflisten von Gerätevorlagen

Vorgangs-ID:: DeviceTemplates_List_V1

Ruft die Liste der Gerätevorlagen in einer Anwendung ab.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Application	application	True	string	Eindeutige ID der Anwendung.

Gibt zurück

Body: DeviceTemplateCollectionV1

Auftrag abrufen

Vorgangs-ID:: Jobs_Get

Rufen Sie Details zu einem vorhandenen Auftrag anhand der ID ab.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Application	application	True	string	Eindeutige ID der Anwendung.
Auftrags-ID	job_id	True	string	Eindeutige ID des Auftrags.

Gibt zurück

Die Auftragsdefinition.

Body: JobStatic

Aufträge auflisten

Vorgangs-ID:: Jobs_List

Ruft die Liste der Aufträge in einer Anwendung ab.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Application	application	True	string	Eindeutige ID der Anwendung.

Gibt zurück

Die seitenseitigen Ergebnisse von Aufträgen.

Body: JobCollection

Ausführen eines Gerätebefehls

Vorgangs-ID:: Devices_RunCommand_V1

Führen Sie einen Befehl auf einem Gerät aus.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Application	application	True	string	Eindeutige ID der Anwendung.
Geräte-ID	device_id	True	string	Eindeutige ID des Geräts.
Gerätebefehl	command_name	True	string	Name dieses Gerätebefehls.
Gerätevorlage	template		string	Die Gerätevorlagendefinition für das Gerät.
body	body	True	dynamic	Gerätebefehlstext.

Gibt zurück

Die Ausgaben dieses Vorgangs sind dynamisch.

Ausführen eines Gerätebefehls (veraltet)

Vorgangs-ID:: Devices_ExecuteComponentCommand

Führen Sie einen Befehl auf einem Gerät aus (veraltet).

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Application	application	True	string	Eindeutige ID der Anwendung.
Geräte-ID	device_id	True	string	Eindeutige ID des Geräts.
Gerätekomponente	component_name	True	string	Name der Gerätekomponente.
Gerätebefehl	command_name	True	string	Name dieses Gerätebefehls.
Gerätevorlagen-ID	instanceOf		string	Die Gerätevorlagendefinition für das Gerät.
body	body	True	dynamic	Gerätebefehlstext.

Gibt zurück

Die Ausgaben dieses Vorgangs sind dynamisch.

Ausführen eines Komponentenbefehls

Vorgangs-ID:: Devices_RunComponentCommand_V1

Führen Sie einen Befehl für eine Komponente aus.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Application	application	True	string	Eindeutige ID der Anwendung.
Geräte-ID	device_id	True	string	Eindeutige ID des Geräts.
Gerätekomponente	component_name	True	string	Name der Gerätekomponente.
Gerätebefehl	command_name	True	string	Name dieses Gerätebefehls.
Gerätevorlage	template		string	Die Gerätevorlagendefinition für das Gerät.
body	body	True	dynamic	Gerätebefehlstext.

Gibt zurück

Die Ausgaben dieses Vorgangs sind dynamisch.

Ausführen eines Modulbefehls

Vorgangs-ID:: Devices_RunModuleCommand_V1

Führen Sie einen Befehl in einem Modul aus.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Application	application	True	string	Eindeutige ID der Anwendung.
Geräte-ID	device_id	True	string	Eindeutige ID des Geräts.
Gerätemodul	module	True	string	Name des Gerätemoduls.
Gerätebefehl	command_name	True	string	Name dieses Gerätebefehls.
Gerätevorlage	template		string	Die Gerätevorlagendefinition für das Gerät.
body	body	True	dynamic	Gerätebefehlstext.

Gibt zurück

Die Ausgaben dieses Vorgangs sind dynamisch.

Ausführen eines Modulkomponentenbefehls

Vorgangs-ID:: Devices_RunModuleComponentCommand_V1

Führen Sie einen Befehl für eine Modulkomponente aus.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Application	application	True	string	Eindeutige ID der Anwendung.
Geräte-ID	device_id	True	string	Eindeutige ID des Geräts.
Gerätemodul	module	True	string	Name des Gerätemoduls.
Gerätekomponente	component_name	True	string	Name der Gerätekomponente.
Gerätebefehl	command_name	True	string	Name dieses Gerätebefehls.
Gerätevorlage	template		string	Die Gerätevorlagendefinition für das Gerät.
body	body	True	dynamic	Gerätebefehlstext.

Gibt zurück

Die Ausgaben dieses Vorgangs sind dynamisch.

Beenden eines ausgeführten Auftrags

Vorgangs-ID:: Jobs_Stop

Beenden Sie die Ausführung eines Auftrags, der derzeit ausgeführt wird.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Application	application	True	string	Eindeutige ID der Anwendung.
Auftrags-ID	job_id	True	string	Eindeutige ID des Auftrags.

Benutzer abrufen

Vorgangs-ID:: Users_Get_V1

Abrufen eines Benutzers nach ID

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Application	application	True	string	Eindeutige ID der Anwendung.
Benutzer	user_id	True	string	Eindeutige ID des Benutzers.

Gibt zurück

Body: UserStaticV1

Benutzer aktualisieren

Vorgangs-ID:: Users_Update_V1

Aktualisieren eines Benutzers in der Anwendung über Patch

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Application	application	True	string	Eindeutige ID der Anwendung.
Benutzer	user_id	True	string	Eindeutige ID des Benutzers.
Benutzertyp	user_type		string	Typ des Benutzers.
Body	body	True	dynamic	Benutzeraktualisierungstext.

Gibt zurück

Die Ausgaben dieses Vorgangs sind dynamisch.

Benutzer auflisten

Vorgangs-ID:: Users_List_V1

Abrufen der Liste der Benutzer in einer Anwendung

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Application	application	True	string	Eindeutige ID der Anwendung.

Gibt zurück

Body: UserCollectionV1

Benutzer erstellen

Vorgangs-ID:: Users_Create_V1

Erstellen eines Benutzers in der Anwendung

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Application	application	True	string	Eindeutige ID der Anwendung.
Benutzer	user_id	True	string	Eindeutige ID des Benutzers.
Benutzertyp	user_type		string	Typ des Benutzers.
Body	body	True	dynamic	Benutzer erstellen Textkörper.

Gibt zurück

Die Ausgaben dieses Vorgangs sind dynamisch.

Benutzer löschen

Vorgangs-ID:: Users_Remove_V1

Löschen eines Benutzers

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Application	application	True	string	Eindeutige ID der Anwendung.
Benutzer	user_id	True	string	Eindeutige ID des Benutzers.

Ein Gerät anhand der ID abrufen

Vorgangs-ID:: Devices_Get_V1

Rufen Sie Details zu einem vorhandenen Gerät anhand der Geräte-ID ab.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Application	application	True	string	Eindeutige ID der Anwendung.
Geräte-ID	device_id	True	string	Eindeutige ID des Geräts.

Gibt zurück

Body: DeviceV1

Einen Job erstellen

Vorgangs-ID:: Jobs_Set

Erstellen und Ausführen eines neuen Auftrags über die Auftragsdefinition

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Application	application	True	string	Eindeutige ID der Anwendung.
Auftrags-ID	job_id	True	string	Eindeutige ID des Auftrags.
Stellentyp	job_type		string	Typ des Auftrags.
Body	body	True	dynamic	Auftrag erstellt Textkörper.

Gibt zurück

Die Ausgaben dieses Vorgangs sind dynamisch.

Erstellen einer Gerätebeziehung

Vorgangs-ID:: DeviceRelationships_Set

Erstellen Sie eine neue Gerätebeziehung zwischen dem angegebenen Gerät und einem neuen Gerät mit einer Geräte-ID und einer Beziehungs-ID.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Application	application	True	string	Eindeutige ID der Anwendung.
Beziehungs-ID	relationship_id	True	string	Eindeutige ID der Gerätebeziehung.
Geräte-ID	device_id	True	string	Eindeutige ID des Geräts.
Gerätebeziehungs-ID	id		string	Eindeutige ID der Gerätebeziehung.
Ziel-ID für Gerätebeziehung	target	True	string	Die Geräte-ID des Quellgeräts (untergeordnetes Gerät).

Gibt zurück

Body: DeviceRelationshipStatic

Erstellen einer Gerätegruppe

Vorgangs-ID:: DeviceGroups_Set

Dient zum Erstellen oder Aktualisieren einer Gerätegruppe.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Application	application	True	string	Eindeutige ID der Anwendung.
Gerätegruppen-ID	device_group_id	True	string	Eindeutige ID der Gerätegruppe.
Gerätegruppen-ID	id		string	Eindeutige ID der Gerätegruppe.
Anzeigename	displayName	True	string	Anzeigename der Gerätegruppe.
Filter	filter	True	string	Abfrage, die definiert, welche Geräte in dieser Gruppe enthalten sein sollen.
Description	description		string	Kurze Zusammenfassung der Gerätegruppe.
ETag	etag		string	ETag, das verwendet wird, um Konflikte in Gerätegruppenupdates zu verhindern.
Organizations	organizations		array of string	Liste der Organisationen der Gerätegruppe, nur eine Organisation wird heute unterstützt, mehrere Organisationen werden in Kürze unterstützt.

Gibt zurück

Die Gerätegruppendefinition.

Body: DeviceGroup

Erstellen einer Organisation

Vorgangs-ID:: Organizations_Set

Neue Organisation erstellen.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Application	application	True	string	Eindeutige ID der Anwendung.
Organisations-ID	organization_id	True	string	Eindeutige ID der Organisation.
Organisations-ID	id		string	Eindeutige ID der Organisation.
Name der Organisation	displayName		string	Anzeigename der Organisation.
Parent	parent		string	Anzeigename der übergeordneten Organisation.

Gibt zurück

Body: Organization

Erstellen oder Aktualisieren eines Geräts

Vorgangs-ID:: Devices_Set_V2

Erstellen Sie ein neues Gerät, oder aktualisieren Sie ein vorhandenes gerät nach Geräte-ID.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Application	application	True	string	Eindeutige ID der Anwendung.
Geräte-ID	device_id	True	string	Eindeutige ID des Geräts.
Geräte-ID	id		string	Eindeutige ID des Geräts.
Gerätename	displayName		string	Anzeigename des Geräts.
Gerätevorlage	template		string	Die Gerätevorlagendefinition für das Gerät.
Simuliert	simulated		boolean	Gibt an, ob das Gerät simuliert wird.
Enabled	enabled		boolean	Gibt an, ob die Geräteverbindung mit IoT Central aktiviert wurde.
Organizations	organizations		array of string	Liste der Organisationen des Geräts, nur eine Organisation wird heute unterstützt, mehrere Organisationen werden in Kürze unterstützt.
Bereitgestellt	provisioned		boolean	Gibt an, ob dem Gerät Ressourcen zugewiesen wurden.

Gibt zurück

Body: DeviceV2

Erstellen oder Aktualisieren eines Geräts (veraltet)

Vorgangs-ID:: Devices_Set_V1

Erstellen Sie ein neues Gerät, oder aktualisieren Sie ein vorhandenes gerät nach Geräte-ID. (veraltet)

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Application	application	True	string	Eindeutige ID der Anwendung.
Geräte-ID	device_id	True	string	Eindeutige ID des Geräts.
Geräte-ID	id		string	Eindeutige ID des Geräts.
Gerätename	displayName		string	Anzeigename des Geräts.
Gerätevorlage	template		string	Die Gerätevorlagendefinition für das Gerät.
Simuliert	simulated		boolean	Gibt an, ob das Gerät simuliert wird.
Enabled	enabled		boolean	Gibt an, ob die Geräteverbindung mit IoT Central aktiviert wurde.
Bereitgestellt	provisioned		boolean	Gibt an, ob dem Gerät Ressourcen zugewiesen wurden.

Gibt zurück

Body: DeviceV1

Erstellen oder Aktualisieren eines Geräts (veraltet)

Vorgangs-ID:: Devices_Set

Erstellen Sie ein neues Gerät, oder aktualisieren Sie ein vorhandenes gerät nach Geräte-ID (veraltet).

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Application	application	True	string	Eindeutige ID der Anwendung.
Geräte-ID	device_id	True	string	Eindeutige ID des Geräts.
Geräte-ID	id		string	Eindeutige ID des Geräts.
Gerätename	displayName		string	Anzeigename des Geräts.
Gerätevorlage	instanceOf		string	Die Gerätevorlagendefinition für das Gerät.
Simuliert	simulated		boolean	Gibt an, ob das Gerät simuliert wird.
genehmigt	approved		boolean	Gibt an, ob das Gerät für die Verbindung mit IoT Central genehmigt wurde.
Bereitgestellt	provisioned		boolean	Gibt an, ob dem Gerät Ressourcen zugewiesen wurden.

Gibt zurück

Body: Device

Fortsetzen eines angehaltenen Auftrags

Vorgangs-ID:: Jobs_Resume

Fortsetzen der Ausführung eines vorhandenen beendeten Auftrags.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Application	application	True	string	Eindeutige ID der Anwendung.
Auftrags-ID	job_id	True	string	Eindeutige ID des Auftrags.

Fortsetzen eines Auftrags auf fehlgeschlagenen Geräten

Vorgangs-ID:: Jobs_Rerun

Führen Sie eine erneute Ausführung eines vorhandenen Auftrags auf allen fehlgeschlagenen Geräten aus.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Application	application	True	string	Eindeutige ID der Anwendung.
Auftrags-ID	job_id	True	string	Eindeutige ID des Auftrags.
ID erneut ausführen	rerun_id	True	string	Eindeutige ID des erneuten Ausführens.

Gibt zurück

Die Auftragsdefinition.

Body: JobStatic

Geplante Aufträge auflisten

Vorgangs-ID:: ScheduledJobs_List

Ruft die Liste der geplanten Aufträge in einer Anwendung ab.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Application	application	True	string	Eindeutige ID der Anwendung.

Gibt zurück

Die Ausgaben dieses Vorgangs sind dynamisch.

Geplanten Auftrag erstellen

Vorgangs-ID:: ScheduledJobs_Set

Erstellen und Ausführen eines neuen geplanten Auftrags über die Auftragsdefinition.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Application	application	True	string	Eindeutige ID der Anwendung.
Geplante Auftrags-ID	scheduled_job_id	True	string	Eindeutige ID des geplanten Auftrags.
Stellentyp	job_type		string	Typ des Auftrags.
Zeitplan-Endtyp	scheduled_job_end_type		string	Wie der geplante Auftrag enden soll (nicht auf Gerätevorlagenmigrationen angewendet).
Body	body	True	dynamic	Geplanter Auftragserstellungstext.

Gibt zurück

Die Ausgaben dieses Vorgangs sind dynamisch.

Gerät löschen

Vorgangs-ID:: Devices_Remove_V1

Löschen Eines vorhandenen Geräts nach Geräte-ID.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Application	application	True	string	Eindeutige ID der Anwendung.
Geräte-ID	device_id	True	string	Eindeutige ID des Geräts.

Geräte auflisten

Vorgangs-ID:: Devices_List_V1

Ruft die Liste der Geräte in einer Anwendung ab.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Application	application	True	string	Eindeutige ID der Anwendung.

Gibt zurück

Body: DeviceCollectionV1

Geräte nach Gerätegruppen-ID abrufen

Vorgangs-ID:: DeviceGroups_GetDevices

Ruft die Liste der Geräte in einer Gerätegruppe in einer Anwendung ab.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Application	application	True	string	Eindeutige ID der Anwendung.
Gerätegruppen-ID	device_group_id	True	string	Eindeutige ID der Gerätegruppe.

Gibt zurück

Die seitenseitigen Ergebnisse von Geräten, die zur Gerätegruppe gehören.

Body: DeviceGroupDeviceCollection

Geräte-Telemetriewert abrufen

Vorgangs-ID:: Devices_GetTelemetryValue_V1

Rufen Sie den letzten Telemetriewert von einem Gerät ab.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Application	application	True	string	Eindeutige ID der Anwendung.
Geräte-ID	device_id	True	string	Eindeutige ID des Geräts.
Gerätetelemetrie	telemetry_name	True	string	Name dieser Gerätetelemetrie.
Gerätevorlage	template		string	Die Gerätevorlagendefinition für das Gerät.

Gibt zurück

Die Ausgaben dieses Vorgangs sind dynamisch.

Gerätebeziehung abrufen

Vorgangs-ID:: DeviceRelationships_Get

Rufen Sie Details zu einer vorhandenen Gerätebeziehung nach Geräte-ID und nach Beziehungs-ID ab.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Application	application	True	string	Eindeutige ID der Anwendung.
Geräte-ID	device_id	True	string	Eindeutige ID des Geräts.
Beziehungs-ID	relationship_id	True	string	Eindeutige ID der Gerätebeziehung.

Gibt zurück

Body: DeviceRelationshipStatic

Gerätegruppe löschen

Vorgangs-ID:: DeviceGroups_Remove

Löschen einer vorhandenen Gerätegruppe nach ID

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Application	application	True	string	Eindeutige ID der Anwendung.
Gerätegruppen-ID	device_group_id	True	string	Eindeutige ID der Gerätegruppe.

Gerätestatus abrufen

Vorgangs-ID:: Jobs_GetDevices

Rufen Sie die Liste der einzelnen Gerätestatus nach Auftrags-ID ab.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Application	application	True	string	Eindeutige ID der Anwendung.
Auftrags-ID	job_id	True	string	Eindeutige ID des Auftrags.

Gibt zurück

Die seitenseitigen Ergebnisse der Auftragsgerätestatus.

Body: JobDeviceStatusCollection

Löschen der Organisation

Vorgangs-ID:: Organizations_Remove

Löschen einer vorhandenen Organisation nach ID

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Application	application	True	string	Eindeutige ID der Anwendung.
Organisations-ID	organization_id	True	string	Eindeutige ID der Organisation.

Löschen einer Gerätebeziehung

Vorgangs-ID:: DeviceRelationships_Remove

Löschen Sie eine vorhandene Gerätebeziehung nach Geräte-ID und Beziehungs-ID.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Application	application	True	string	Eindeutige ID der Anwendung.
Geräte-ID	device_id	True	string	Eindeutige ID des Geräts.
Beziehungs-ID	relationship_id	True	string	Eindeutige ID der Gerätebeziehung.

Löschen einer Gerätevorlage

Vorgangs-ID:: DeviceTemplates_Remove_V1

Löschen Sie eine vorhandene Gerätevorlage nach ID.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Application	application	True	string	Eindeutige ID der Anwendung.
Template	template_id	True	string	Eindeutige ID der Vorlage.

Löschen eines geplanten Auftrags

Vorgangs-ID:: ScheduledJobs_Remove

Löschen Sie einen vorhandenen geplanten Auftrag nach ID.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Application	application	True	string	Eindeutige ID der Anwendung.
Geplante Auftrags-ID	scheduled_job_id	True	string	Eindeutige ID des geplanten Auftrags.

Löschen eines Geräts (veraltet)

Vorgangs-ID:: Devices_Remove

Löschen eines vorhandenen Geräts nach Geräte-ID (veraltet).

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Application	application	True	string	Eindeutige ID der Anwendung.
Geräte-ID	device_id	True	string	Eindeutige ID des Geräts.

Organisationen auflisten

Vorgangs-ID:: Organizations_List

Ruft die Liste der Organisationen in einer Anwendung ab.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Application	application	True	string	Eindeutige ID der Anwendung.

Gibt zurück

Body: OrganizationCollection

Rolle abrufen

Vorgangs-ID:: Roles_Get_V1

Abrufen einer Rolle nach ID.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Application	application	True	string	Eindeutige ID der Anwendung.
Rolle	role_id	True	string	Eindeutige ID für die Rolle.

Gibt zurück

Body: RoleV1

Rollen auflisten

Vorgangs-ID:: Roles_List_V1

Ruft die Liste der Rollen in einer Anwendung ab.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Application	application	True	string	Eindeutige ID der Anwendung.

Gibt zurück

Body: RoleCollectionV1

Auslöser

Wenn eine Regel ausgelöst wird

Erstellen Sie eine Aktion, die ausgelöst wird, wenn eine Regel in IoT Central ausgelöst wird.

Wenn eine Regel ausgelöst wird

Vorgangs-ID:: Workflow_CreateTrigger

Erstellen Sie eine Aktion, die ausgelöst wird, wenn eine Regel in IoT Central ausgelöst wird.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Application	application	True	string	Eindeutige ID der Anwendung.
Workflowtrigger-ID	id		string	Eindeutige ID des Workflowtriggers.
Regel	rule	True	string	Eindeutige ID der Regel, die an den Workflowtrigger gebunden ist.

Gibt zurück

Die Ausgaben dieses Vorgangs sind dynamisch.

Definitionen

Device

Name	Pfad	Typ	Beschreibung
Geräte-ID	id	string	Eindeutige ID des Geräts.
Gerätename	displayName	string	Anzeigename des Geräts.
Gerätevorlage	instanceOf	string	Die Gerätevorlagendefinition für das Gerät.
Simuliert	simulated	boolean	Gibt an, ob das Gerät simuliert wird.
genehmigt	approved	boolean	Gibt an, ob das Gerät für die Verbindung mit IoT Central genehmigt wurde.
Bereitgestellt	provisioned	boolean	Gibt an, ob dem Gerät Ressourcen zugewiesen wurden.

DeviceV1

Name	Pfad	Typ	Beschreibung
Geräte-ID	id	string	Eindeutige ID des Geräts.
Gerätename	displayName	string	Anzeigename des Geräts.
Gerätevorlage	template	string	Die Gerätevorlagendefinition für das Gerät.
Simuliert	simulated	boolean	Gibt an, ob das Gerät simuliert wird.
Enabled	enabled	boolean	Gibt an, ob die Geräteverbindung mit IoT Central aktiviert wurde.
Bereitgestellt	provisioned	boolean	Gibt an, ob dem Gerät Ressourcen zugewiesen wurden.

DeviceV2

Name	Pfad	Typ	Beschreibung
Geräte-ID	id	string	Eindeutige ID des Geräts.
Gerätename	displayName	string	Anzeigename des Geräts.
Gerätevorlage	template	string	Die Gerätevorlagendefinition für das Gerät.
Simuliert	simulated	boolean	Gibt an, ob das Gerät simuliert wird.
Enabled	enabled	boolean	Gibt an, ob die Geräteverbindung mit IoT Central aktiviert wurde.
Organizations	organizations	array of string	Liste der Organisationen des Geräts, nur eine Organisation wird heute unterstützt, mehrere Organisationen werden in Kürze unterstützt.
Bereitgestellt	provisioned	boolean	Gibt an, ob dem Gerät Ressourcen zugewiesen wurden.

DeviceCollectionV1

Name	Pfad	Typ	Beschreibung
value	value	array of DeviceV1	Die Sammlung von Geräten.
nextLink	nextLink	string	URL zum Abrufen der nächsten Seite von Geräten.

DeviceGroup

Die Gerätegruppendefinition.

Name	Pfad	Typ	Beschreibung
Gerätegruppen-ID	id	string	Eindeutige ID der Gerätegruppe.
Anzeigename	displayName	string	Anzeigename der Gerätegruppe.
Filter	filter	string	Abfrage, die definiert, welche Geräte in dieser Gruppe enthalten sein sollen.
Description	description	string	Kurze Zusammenfassung der Gerätegruppe.
ETag	etag	string	ETag, das verwendet wird, um Konflikte in Gerätegruppenupdates zu verhindern.
Organizations	organizations	array of string	Liste der Organisationen der Gerätegruppe, nur eine Organisation wird heute unterstützt, mehrere Organisationen werden in Kürze unterstützt.

DeviceGroupCollection

Die seitenseitigen Ergebnisse von Gerätegruppen.

Name	Pfad	Typ	Beschreibung
Gerätegruppen-ID	value	array of DeviceGroup	Die Sammlung von Gerätegruppen.
nextLink	nextLink	string	URL zum Abrufen der nächsten Seite von Gerätegruppen.

DeviceGroupDeviceCollection

Die seitenseitigen Ergebnisse von Geräten, die zur Gerätegruppe gehören.

Name	Pfad	Typ	Beschreibung
value	value	array of DeviceV1	Die Sammlung von Geräten, die zur Gerätegruppe gehören.
nextLink	nextLink	string	URL zum Abrufen der nächsten Seite von Geräten in der Gruppe.

DeviceRelationshipStatic

Name	Pfad	Typ	Beschreibung
Gerätebeziehungs-ID	id	string	Eindeutige ID der Gerätebeziehung.
Quell-ID der Gerätebeziehung	source	string	Die Geräte-ID des Quellgeräts (übergeordnetes Gerät).
Ziel-ID für Gerätebeziehung	target	string	Die Geräte-ID des Quellgeräts (untergeordnetes Gerät).

DeviceRelationshipCollection

Name	Pfad	Typ	Beschreibung
value	value	array of DeviceRelationshipStatic	Die Sammlung von Gerätebeziehungen.
nextLink	nextLink	string	URL zum Abrufen der nächsten Seite von Gerätebeziehungen.

DeviceTemplateV1

Name	Pfad	Typ	Beschreibung
Gerätevorlagen-ID	@id	string	Eindeutige ID der Gerätevorlage.
Gerätevorlagentypen	@type	array of string	Die JSON-LD Typen dieser Gerätevorlage.
Gerätevorlagenname	displayName	string	Anzeigename der Gerätevorlage.
Beschreibung der Gerätevorlage	description	string	Detaillierte Beschreibung der Gerätevorlage.
Gerätevorlagen-Funktionsmodell	capabilityModel		Das von dieser Gerätevorlage verwendete Funktionsmodell.

DeviceTemplateCollectionV1

Name	Pfad	Typ	Beschreibung
value	value	array of DeviceTemplateV1	Die Sammlung von Gerätevorlagen.
nextLink	nextLink	string	URL zum Abrufen der nächsten Seite von Gerätevorlagen.

JobDeviceStatus

Die Statusdefinition des Auftragsgeräts.

Name	Pfad	Typ	Beschreibung
Geräte-ID	id	string	ID des Geräts, dessen Auftragsstatus bereitgestellt wird.
Gerätestatus	status	string	Gibt an, ob der Auftrag für das angegebene Gerät gestartet, ausgeführt wird usw.

JobDeviceStatusCollection

Die seitenseitigen Ergebnisse der Auftragsgerätestatus.

Name	Pfad	Typ	Beschreibung
value	value	array of JobDeviceStatus	Die Sammlung der Auftragsgerätestatus.
nextLink	nextLink	string	URL zum Abrufen der nächsten Seite der Auftragsgerätestatus.

JobBatch

Die Auftragsbatchdefinition.

Name	Pfad	Typ	Beschreibung
Batchtyp	type	string	Gibt an, ob die Batchverarbeitung auf einer bestimmten Anzahl von Geräten oder einem Prozentsatz der Gesamtgeräte erfolgt.
Batchwert	value	number	Die Anzahl oder der Prozentsatz der Geräte, auf denen die Batchverarbeitung erfolgt.

JobCancellationThreshold

Die Definition des Auftragsabbruchschwellenwerts.

Name	Pfad	Typ	Beschreibung
Abbruchschwellentyp	type	string	Gibt an, ob der Abbruchschwellenwert pro angegebene Anzahl von Geräten oder einem Prozentsatz der Gesamtgeräte liegt.
Schwellenwert für den Abbruch	value	number	Die Anzahl oder der Prozentsatz der Geräte, auf denen der Abbruchschwellenwert angewendet wird.
Abbruchschwellenbatch	batch	boolean	Gibt an, ob der Abbruchschwellenwert pro Batch oder auf den Gesamtauftrag angewendet wird.

JobStatic

Die Auftragsdefinition.

Name	Pfad	Typ	Beschreibung
Auftrags-ID	id	string	Eindeutige ID des Auftrags.
Anzeigename	displayName	string	Anzeigename des Auftrags.
Description	description	string	Detaillierte Beschreibung des Auftrags.
Gerätegruppe	group	string	Die ID der Gerätegruppe, auf der der Auftrag ausgeführt werden soll.
batch	batch	JobBatch	Die Auftragsbatchdefinition.
cancellationThreshold	cancellationThreshold	JobCancellationThreshold	Die Definition des Auftragsabbruchschwellenwerts.
Daten	data	array of object	Daten im Zusammenhang mit dem Vorgang, der von diesem Auftrag ausgeführt wird. Alle Einträge müssen denselben Typ aufweisen.
items	data	object
Organizations	organizations	array of string	Liste der Organisationen des Auftrags, nur eine Organisation wird heute unterstützt, mehrere Organisationen werden in Kürze unterstützt.
Geplante Auftrags-ID	scheduledJobId	string	ID der geplanten Auftragsdefinition, die diesen Auftrag erstellt hat.

JobCollection

Die seitenseitigen Ergebnisse von Aufträgen.

Name	Pfad	Typ	Beschreibung
value	value	array of JobStatic	Die Sammlung von Aufträgen.
nextLink	nextLink	string	URL zum Abrufen der nächsten Seite von Aufträgen.

Organization

Name	Pfad	Typ	Beschreibung
Organisations-ID	id	string	Eindeutige ID der Organisation.
Name der Organisation	displayName	string	Anzeigename der Organisation.
Parent	parent	string	Anzeigename der übergeordneten Organisation.

OrganizationCollection

Name	Pfad	Typ	Beschreibung
value	value	array of Organization	Die Sammlung von Organisationen.
nextLink	nextLink	string	URL zum Abrufen der nächsten Seite von Organisationen.

RoleV1

Name	Pfad	Typ	Beschreibung
id	id	string	Eindeutige ID der Rolle.
Anzeigename	displayName	string	Anzeigename der Rolle.

RoleCollectionV1

Name	Pfad	Typ	Beschreibung
value	value	array of RoleV1	Die Sammlung von Rollen.

ScheduledJobStatic

Die Definition des geplanten Auftrags.

Name	Pfad	Typ	Beschreibung
ETag	etag	string	ETag, das verwendet wird, um Konflikte bei geplanten Auftragsaktualisierungen zu verhindern.
Geplante Auftrags-ID	id	string	Eindeutige ID des geplanten Auftrags.
Anzeigename	displayName	string	Anzeigename des geplanten Auftrags.
Description	description	string	Detaillierte Beschreibung des geplanten Auftrags.
Gerätegruppe	group	string	Die ID der Gerätegruppe, auf der der Auftrag ausgeführt werden soll.
batch	batch	JobBatch	Die Auftragsbatchdefinition.
cancellationThreshold	cancellationThreshold	JobCancellationThreshold	Die Definition des Auftragsabbruchschwellenwerts.
Daten	data	array of object	Daten im Zusammenhang mit dem Vorgang, der von diesem Auftrag ausgeführt wird. Alle Einträge müssen denselben Typ aufweisen.
items	data	object
Organizations	organizations	array of string	Liste der Organisationen des Auftrags, nur eine Organisation wird heute unterstützt, mehrere Organisationen werden in Kürze unterstützt.
Zeitplan	schedule	object	Der Zeitplan, zu dem der Auftrag ausgeführt werden soll.
Enabled	enabled	boolean	Gibt an, ob der geplante Auftrag aktiviert ist.
Abgeschlossen	completed	boolean	Gibt an, ob der geplante Auftrag abgeschlossen wurde.

ScheduledJobJobCollection

Die seitenseitigen Ergebnisse von Auftragsdefinitionen, die zu einem geplanten Auftrag gehören.

Name	Pfad	Typ	Beschreibung
value	value	array of JobStatic	Die Sammlung von Aufträgen.
nextLink	nextLink	string	URL zum Abrufen der nächsten Seite von Aufträgen.

UserStaticV1

Name	Pfad	Typ	Beschreibung
Benutzer-ID	id	string	Eindeutige ID des Benutzers.
Benutzertyp	type	string	Typ des Benutzers.
Rollen	roles	array of RoleAssignmentV1	Liste der Rollenzuweisungen, die die Berechtigungen für den Zugriff auf die Anwendung angeben.

UserCollectionV1

Name	Pfad	Typ	Beschreibung
Benutzer	value	array of UserStaticV1	Die Sammlung von Benutzern.

RoleAssignmentV1

Name	Pfad	Typ	Beschreibung
Rolle	role	string	ID der Rolle für diese Rollenzuweisung.

Freigeben über

Azure IoT Central V3 (Vorschau)

Voraussetzungen

So erhalten Sie Anmeldeinformationen

Versionshinweise

September 2021

November 2021

Bekannte Probleme und Einschränkungen

Erstellen einer Verbindung

Credentials

Standard [VERALTET]

Drosselungsgrenzwerte

Aktionen

Abrufen der Befehlsantwort für Modulkomponenten

Parameter

Gibt zurück

Abrufen der Gerätebefehlsantwort

Parameter

Gibt zurück

Abrufen der Komponentenbefehlsantwort

Parameter

Gibt zurück

Abrufen der Modulbefehlsantwort

Parameter

Gibt zurück

Abrufen des Gerätetelemetriewerts (veraltet)

Parameter

Gibt zurück

Abrufen des Komponententelemetriewerts

Parameter

Gibt zurück

Abrufen des Modul-Telemetriewerts

Parameter

Gibt zurück

Abrufen des Telemetriewerts der Modulkomponente

Parameter

Gibt zurück

Abrufen einer Gerätegruppe

Parameter

Gibt zurück

Abrufen einer Gerätevorlage nach ID

Parameter

Gibt zurück

Abrufen einer Organisation

Parameter

Gibt zurück

Abrufen eines geplanten Auftrags

Parameter

Gibt zurück

Abrufen eines Geräts nach ID (veraltet)

Parameter

Gibt zurück

Abrufen von Aufträgen nach geplanter Auftrags-ID

Parameter

Gibt zurück

Abrufen von Cloud-Eigenschaften des Geräts (veraltet)

Parameter

Gibt zurück

Abrufen von Geräteeigenschaften

Parameter

Gibt zurück

Abrufen von Geräteeigenschaften (veraltet)

Parameter

Gibt zurück

Abrufen von Moduleigenschaften

Parameter

Gibt zurück

Aktualisieren einer Gerätebeziehung

Parameter

Gibt zurück

Aktualisieren eines geplanten Auftrags

Parameter

Gibt zurück

Aktualisieren von Gerätecloudeigenschaften (veraltet)

Parameter

Gibt zurück

Aktualisieren von Geräteeigenschaften

Parameter

Gibt zurück

Aktualisieren von Geräteeigenschaften (veraltet)