Configuration - Get Configurations

Dienst:

IoT Hub

API-Version:

2021-04-12

Ruft Konfigurationen auf dem IoT Hub für die automatische Geräte-/Modulverwaltung ab. Paginierung wird nicht unterstützt.

GET https://fully-qualified-iothubname.azure-devices.net/configurations?api-version=2021-04-12

Mit optionalen Parametern:

GET https://fully-qualified-iothubname.azure-devices.net/configurations?top={top}&api-version=2021-04-12

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
api-version	query	True	string	Version der API.
top	query		integer (int32)	Die Anzahl der abzurufenden Konfigurationen. Der Wert wird außer Kraft gesetzt, wenn die maximale Bereitstellungsanzahl für den IoT Hub größer ist.

Antworten

Name	Typ	Beschreibung
200 OK	Configuration[]	OKAY.

Definitionen

Name	Beschreibung
Configuration	Die Konfiguration für Iot Hub-Geräte- und Modul-Twins.
ConfigurationContent	Der Konfigurationsinhalt für Geräte oder Module auf Edgegeräten.
ConfigurationMetrics	Die Konfigurationsmetriken für Iot Hub-Geräte und -Module.

Configuration

Objekt

Die Konfiguration für Iot Hub-Geräte- und Modul-Twins.

Name	Typ	Beschreibung
content	ConfigurationContent	Der Inhalt der Konfiguration.
createdTimeUtc	string (date-time)	Das Erstellungsdatum und die Uhrzeit der Konfiguration.
etag	string	Das ETag der Konfiguration.
id	string	Der eindeutige Bezeichner der Konfiguration.
labels	object	Die Schlüssel-Wert-Paare, die zum Beschreiben der Konfiguration verwendet werden.
lastUpdatedTimeUtc	string (date-time)	Das Aktualisierungsdatum und die Uhrzeit der Konfiguration.
metrics	ConfigurationMetrics	Die vom Entwickler als Abfragen für twin gemeldeten Eigenschaften angegebenen benutzerdefinierten Metriken.
priority	integer (int32)	Die der Konfiguration zugewiesene Prioritätsnummer.
schemaVersion	string	Die Schemaversion der Konfiguration.
systemMetrics	ConfigurationMetrics	Die vom IoT Hub berechneten Systemmetriken, die nicht angepasst werden können.
targetCondition	string	Die Abfrage, die zum Definieren der zielbezogenen Geräte oder Module verwendet wird. Die Abfrage basiert auf Twin-Tags und/oder gemeldeten Eigenschaften.

ConfigurationContent

Objekt

Der Konfigurationsinhalt für Geräte oder Module auf Edgegeräten.

Name	Typ	Beschreibung
deviceContent	object	Der Gerätekonfigurationsinhalt.
moduleContent	object	Der Modulkonfigurationsinhalt.
modulesContent	object	Der Konfigurationsinhalt der Module.

ConfigurationMetrics

Objekt

Die Konfigurationsmetriken für Iot Hub-Geräte und -Module.

Name	Typ	Beschreibung
queries	object	Die Schlüsselwertpaare mit Abfragen und deren Bezeichner.
results	object	Die Ergebnisse der Metriksammlungsabfragen.