az iot central device-template

Hinweis

Diese Referenz ist Teil der Azure-iot-Erweiterung für die Azure CLI (Version 2.30.0 oder höher). Die Erweiterung installiert automatisch beim ersten Ausführen eines az iot-zentralen Gerätevorlagenbefehls . Weitere Informationen zu Erweiterungen

Verwalten und Konfigurieren von IoT Central-Gerätevorlagen.

Befehle

az iot central device-template create

Erstellen Sie eine Gerätevorlage in IoT Central.

az iot central device-template delete

Löschen sie eine Gerätevorlage aus IoT Central.

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 show

Rufen Sie eine Gerätevorlage aus IoT Central ab.

az iot central device-template update

Aktualisieren einer Gerätevorlage in IoT Central.

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 {1.0, 1.1-preview, 2022-05-31, preview}]
                                      [--central-api-uri]
                                      [--token]

Beispiele

Erstellen einer Gerätevorlage mit Nutzlastlesevorgang aus einer Datei

az iot central device-template create --app-id {appid} --content {pathtofile} --device-template-id {devicetemplateid}

Erstellen einer Gerätevorlage mit Nutzlastlesevorgang aus unformatiertem JSON

az iot central device-template create --app-id {appid} --content {json} --device-template-id {devicetemplateid}

Erforderliche Parameter

--app-id -n

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ü.

--content -k

Die Gerätevorlagendefinition. Geben Sie Pfad zu JSON-Datei oder unformatiertem JSON an. [Dateipfadbeispiel: ./path/to/file.json] [Beispiel für Zeichenfolgen-JSON: {}]. Der Anforderungstext muss "CapabilityModel" enthalten.

--device-template-id --dtid

Digital Twin Model Identifier der Gerätevorlage. Weitere Informationen finden Sie unter https://aka.ms/iotcentraldtmi.

Optionale Parameter

--api-version --av

Die API-Version für den angeforderten Vorgang.

Zulässige Werte: 1.0, 1.1-preview, 2022-05-31, preview
Standardwert: 2022-05-31
--central-api-uri --central-dns-suffix

Das IoT Central DNS-Suffix, das Ihrer Anwendung zugeordnet ist.

Standardwert: azureiotcentral.com
--token

Wenn Sie Ihre Anforderung lieber übermitteln möchten, ohne sich gegen 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.

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 {1.0, 1.1-preview, 2022-05-31, preview}]
                                      [--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

--app-id -n

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ü.

--device-template-id --dtid

Die ID der Zielgerätevorlage. Beispiel: somedevicetemplate.

Optionale Parameter

--api-version --av

Die API-Version für den angeforderten Vorgang.

Zulässige Werte: 1.0, 1.1-preview, 2022-05-31, preview
Standardwert: 2022-05-31
--central-api-uri --central-dns-suffix

Das IoT Central DNS-Suffix, das Ihrer Anwendung zugeordnet ist.

Standardwert: azureiotcentral.com
--token

Wenn Sie Ihre Anforderung lieber übermitteln möchten, ohne sich gegen 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.

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 {1.0, 1.1-preview, 2022-05-31, preview}]
                                    [--central-api-uri]
                                    [--compact]
                                    [--token]

Beispiele

Alle Gerätevorlagen in einer Anwendung auflisten, sortiert nach Vorlagen-ID (Standard)

az iot central device-template list --app-id {appid}

Erforderliche Parameter

--app-id -n

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

--api-version --av

Die API-Version für den angeforderten Vorgang.

Zulässige Werte: 1.0, 1.1-preview, 2022-05-31, preview
Standardwert: 2022-05-31
--central-api-uri --central-dns-suffix

Das IoT Central DNS-Suffix, das Ihrer Anwendung zugeordnet ist.

Standardwert: azureiotcentral.com
--compact -c

Vorlagen im kompakten Modus anzeigen. Für jede Vorlage werden nur ID-, Name- und Modelltypen angezeigt.

--token

Wenn Sie Ihre Anforderung lieber übermitteln möchten, ohne sich gegen 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.

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 {1.0, 1.1-preview, 2022-05-31, preview}]
                                    [--central-api-uri]
                                    [--token]

Beispiele

Abrufen einer Gerätevorlage

az iot central device-template show --app-id {appid} --device-template-id {devicetemplateid}

Erforderliche Parameter

--app-id -n

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ü.

--device-template-id --dtid

Die ID der Zielgerätevorlage. Beispiel: somedevicetemplate.

Optionale Parameter

--api-version --av

Die API-Version für den angeforderten Vorgang.

Zulässige Werte: 1.0, 1.1-preview, 2022-05-31, preview
Standardwert: 2022-05-31
--central-api-uri --central-dns-suffix

Das IoT Central DNS-Suffix, das Ihrer Anwendung zugeordnet ist.

Standardwert: azureiotcentral.com
--token

Wenn Sie Ihre Anforderung lieber übermitteln möchten, ohne sich gegen 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.

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 {1.0, 1.1-preview, 2022-05-31, preview}]
                                      [--central-api-uri]
                                      [--token]

Beispiele

Aktualisieren einer Gerätevorlage mit Nutzlastlesevorgang aus einer Datei

az iot central device-template update --app-id {appid} --content {pathtofile} --device-template-id {devicetemplateid}

Aktualisieren einer Gerätevorlage mit Nutzlastlesevorgang aus unformatiertem JSON

az iot central device-template update --app-id {appid} --content {json} --device-template-id {devicetemplateid}

Erforderliche Parameter

--app-id -n

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ü.

--content -k

Die Gerätevorlagendefinition. Geben Sie Pfad zu JSON-Datei oder unformatiertem JSON an. [Dateipfadbeispiel: ./path/to/file.json] [Beispiel für Zeichenfolgen-JSON: {}]. Der Anforderungstext muss "CapabilityModel" enthalten.

--device-template-id --dtid

Die ID der Zielgerätevorlage. Beispiel: somedevicetemplate.

Optionale Parameter

--api-version --av

Die API-Version für den angeforderten Vorgang.

Zulässige Werte: 1.0, 1.1-preview, 2022-05-31, preview
Standardwert: 2022-05-31
--central-api-uri --central-dns-suffix

Das IoT Central DNS-Suffix, das Ihrer Anwendung zugeordnet ist.

Standardwert: azureiotcentral.com
--token

Wenn Sie Ihre Anforderung lieber übermitteln möchten, ohne sich gegen 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.