az iot central device-template
Hinweis
Diese Referenz ist Teil der Azure-iot-Erweiterung für die Azure CLI (Version 2.46.0 oder höher). Die Erweiterung wird automatisch installiert, wenn Sie einen az iot zentralen Gerätevorlagenbefehl zum ersten Mal ausführen. Weitere Informationen zu Erweiterungen
Verwalten und Konfigurieren von IoT Central-Gerätevorlagen.
Befehle
Name | Beschreibung | Typ | Status |
---|---|---|---|
az iot central device-template create |
Erstellen Sie eine Gerätevorlage in IoT Central. |
Erweiterung | Allgemein verfügbar |
az iot central device-template delete |
Löschen Sie eine Gerätevorlage aus IoT Central. |
Erweiterung | Allgemein verfügbar |
az iot central device-template list |
Rufen Sie die Liste der Gerätevorlagen für eine IoT Central-Anwendung ab. |
Erweiterung | Allgemein verfügbar |
az iot central device-template show |
Rufen Sie eine Gerätevorlage aus IoT Central ab. |
Erweiterung | Allgemein verfügbar |
az iot central device-template update |
Aktualisieren einer Gerätevorlage in IoT Central. |
Erweiterung | Allgemein verfügbar |
az iot central device-template create
Erstellen Sie eine Gerätevorlage in IoT Central.
az iot central device-template create --app-id
--content
--device-template-id
[--api-version {2022-06-30-preview, 2022-07-31}]
[--central-api-uri]
[--token]
Beispiele
Erstellen einer Gerätevorlage mit Leselast aus einer Datei
az iot central device-template create --app-id {appid} --content {pathtofile} --device-template-id {devicetemplateid}
Erstellen einer Gerätevorlage mit Nutzlast, die aus unformatiertem JSON gelesen wird
az iot central device-template create --app-id {appid} --content {json} --device-template-id {devicetemplateid}
Erforderliche Parameter
Die App-ID der IoT Central-App, die Sie verwalten möchten. Sie finden die App-ID auf der Seite "Info" für Ihre Anwendung im Hilfemenü.
Die Gerätevorlagendefinition. Geben Sie Pfad zu JSON-Datei oder unformatierter JSON-Datei an. [Dateipfadbeispiel: ./path/to/file.json] [Beispiel für stringified JSON: {}]. Der Anforderungstext muss CapabilityModel enthalten.
Digital Twin Model Identifier der Gerätevorlage. Weitere Informationen finden Sie unter https://aka.ms/iotcentraldtmi.
Optionale Parameter
Das Argument "api_version" ist veraltet und wird in einer zukünftigen Version entfernt.
Dieser Befehlsparameter ist veraltet und wird ignoriert. In der zukünftigen Version werden wir nur IoT Central APIs von der neuesten GA-Version unterstützen. Wenn eine API noch nicht GA ist, rufen wir die neueste Vorschauversion auf.
Das IoT Central DNS-Suffix, das Ihrer Anwendung zugeordnet ist.
Wenn Sie Ihre Anforderung lieber übermitteln möchten, ohne sich für die Azure CLI zu authentifizieren, können Sie ein gültiges Benutzertoken angeben, um Ihre Anforderung zu authentifizieren. Sie müssen den Schlüsseltyp als Teil der Anforderung angeben. Weitere Informationen finden Sie unter https://aka.ms/iotcentraldocsapi.
Globale Parameter
Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.
Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.
Nur Fehler anzeigen und Warnungen unterdrücken.
Ausgabeformat.
JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.
Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID
konfigurieren.
Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.
az iot central device-template delete
Löschen Sie eine Gerätevorlage aus IoT Central.
Hinweis: Dies wird erwartet, dass ein Fehler auftritt, wenn alle Geräte dieser Vorlage noch zugeordnet sind.
az iot central device-template delete --app-id
--device-template-id
[--api-version {2022-06-30-preview, 2022-07-31}]
[--central-api-uri]
[--token]
Beispiele
Löschen einer Gerätevorlage aus IoT Central
az iot central device-template delete --app-id {appid} --device-template-id {devicetemplateid}
Erforderliche Parameter
Die App-ID der IoT Central-App, die Sie verwalten möchten. Sie finden die App-ID auf der Seite "Info" für Ihre Anwendung im Hilfemenü.
Die ID der Zielgerätevorlage. Beispiel: somedevicetemplate.
Optionale Parameter
Das Argument "api_version" ist veraltet und wird in einer zukünftigen Version entfernt.
Dieser Befehlsparameter ist veraltet und wird ignoriert. In der zukünftigen Version werden wir nur IoT Central APIs von der neuesten GA-Version unterstützen. Wenn eine API noch nicht GA ist, rufen wir die neueste Vorschauversion auf.
Das IoT Central DNS-Suffix, das Ihrer Anwendung zugeordnet ist.
Wenn Sie Ihre Anforderung lieber übermitteln möchten, ohne sich für die Azure CLI zu authentifizieren, können Sie ein gültiges Benutzertoken angeben, um Ihre Anforderung zu authentifizieren. Sie müssen den Schlüsseltyp als Teil der Anforderung angeben. Weitere Informationen finden Sie unter https://aka.ms/iotcentraldocsapi.
Globale Parameter
Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.
Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.
Nur Fehler anzeigen und Warnungen unterdrücken.
Ausgabeformat.
JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.
Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID
konfigurieren.
Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.
az iot central device-template list
Rufen Sie die Liste der Gerätevorlagen für eine IoT Central-Anwendung ab.
az iot central device-template list --app-id
[--api-version {2022-06-30-preview, 2022-07-31}]
[--central-api-uri]
[--compact]
[--token]
Beispiele
Auflisten aller Gerätevorlagen in einer Anwendung, sortiert nach Vorlagen-ID (Standard)
az iot central device-template list --app-id {appid}
Erforderliche Parameter
Die App-ID der IoT Central-App, die Sie verwalten möchten. Sie finden die App-ID auf der Seite "Info" für Ihre Anwendung im Hilfemenü.
Optionale Parameter
Das Argument "api_version" ist veraltet und wird in einer zukünftigen Version entfernt.
Dieser Befehlsparameter ist veraltet und wird ignoriert. In der zukünftigen Version werden wir nur IoT Central APIs von der neuesten GA-Version unterstützen. Wenn eine API noch nicht GA ist, rufen wir die neueste Vorschauversion auf.
Das IoT Central DNS-Suffix, das Ihrer Anwendung zugeordnet ist.
Vorlagen im Kompaktmodus anzeigen. Für jede Vorlage werden nur ID, Name und Modelltypen angezeigt.
Wenn Sie Ihre Anforderung lieber übermitteln möchten, ohne sich für die Azure CLI zu authentifizieren, können Sie ein gültiges Benutzertoken angeben, um Ihre Anforderung zu authentifizieren. Sie müssen den Schlüsseltyp als Teil der Anforderung angeben. Weitere Informationen finden Sie unter https://aka.ms/iotcentraldocsapi.
Globale Parameter
Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.
Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.
Nur Fehler anzeigen und Warnungen unterdrücken.
Ausgabeformat.
JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.
Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID
konfigurieren.
Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.
az iot central device-template show
Rufen Sie eine Gerätevorlage aus IoT Central ab.
az iot central device-template show --app-id
--device-template-id
[--api-version {2022-06-30-preview, 2022-07-31}]
[--central-api-uri]
[--token]
Beispiele
Abrufen einer Gerätevorlage
az iot central device-template show --app-id {appid} --device-template-id {devicetemplateid}
Erforderliche Parameter
Die App-ID der IoT Central-App, die Sie verwalten möchten. Sie finden die App-ID auf der Seite "Info" für Ihre Anwendung im Hilfemenü.
Die ID der Zielgerätevorlage. Beispiel: somedevicetemplate.
Optionale Parameter
Das Argument "api_version" ist veraltet und wird in einer zukünftigen Version entfernt.
Dieser Befehlsparameter ist veraltet und wird ignoriert. In der zukünftigen Version werden wir nur IoT Central APIs von der neuesten GA-Version unterstützen. Wenn eine API noch nicht GA ist, rufen wir die neueste Vorschauversion auf.
Das IoT Central DNS-Suffix, das Ihrer Anwendung zugeordnet ist.
Wenn Sie Ihre Anforderung lieber übermitteln möchten, ohne sich für die Azure CLI zu authentifizieren, können Sie ein gültiges Benutzertoken angeben, um Ihre Anforderung zu authentifizieren. Sie müssen den Schlüsseltyp als Teil der Anforderung angeben. Weitere Informationen finden Sie unter https://aka.ms/iotcentraldocsapi.
Globale Parameter
Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.
Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.
Nur Fehler anzeigen und Warnungen unterdrücken.
Ausgabeformat.
JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.
Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID
konfigurieren.
Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.
az iot central device-template update
Aktualisieren einer Gerätevorlage in IoT Central.
az iot central device-template update --app-id
--content
--device-template-id
[--api-version {2022-06-30-preview, 2022-07-31}]
[--central-api-uri]
[--token]
Beispiele
Aktualisieren einer Gerätevorlage mit Leselast aus einer Datei
az iot central device-template update --app-id {appid} --content {pathtofile} --device-template-id {devicetemplateid}
Aktualisieren einer Gerätevorlage mit Nutzlast, die aus unformatiertem JSON gelesen wird
az iot central device-template update --app-id {appid} --content {json} --device-template-id {devicetemplateid}
Erforderliche Parameter
Die App-ID der IoT Central-App, die Sie verwalten möchten. Sie finden die App-ID auf der Seite "Info" für Ihre Anwendung im Hilfemenü.
Die Gerätevorlagendefinition. Geben Sie Pfad zu JSON-Datei oder unformatierter JSON-Datei an. [Dateipfadbeispiel: ./path/to/file.json] [Beispiel für stringified JSON: {}]. Der Anforderungstext muss CapabilityModel enthalten.
Die ID der Zielgerätevorlage. Beispiel: somedevicetemplate.
Optionale Parameter
Das Argument "api_version" ist veraltet und wird in einer zukünftigen Version entfernt.
Dieser Befehlsparameter ist veraltet und wird ignoriert. In der zukünftigen Version werden wir nur IoT Central APIs von der neuesten GA-Version unterstützen. Wenn eine API noch nicht GA ist, rufen wir die neueste Vorschauversion auf.
Das IoT Central DNS-Suffix, das Ihrer Anwendung zugeordnet ist.
Wenn Sie Ihre Anforderung lieber übermitteln möchten, ohne sich für die Azure CLI zu authentifizieren, können Sie ein gültiges Benutzertoken angeben, um Ihre Anforderung zu authentifizieren. Sie müssen den Schlüsseltyp als Teil der Anforderung angeben. Weitere Informationen finden Sie unter https://aka.ms/iotcentraldocsapi.
Globale Parameter
Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.
Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.
Nur Fehler anzeigen und Warnungen unterdrücken.
Ausgabeformat.
JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.
Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID
konfigurieren.
Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.