az dt model

  • Referenz

Hinweis

Diese Referenz ist Teil der Azure-iot-Erweiterung für die Azure CLI (Version 2.37.0 oder höher). Die Erweiterung wird automatisch installiert, wenn Sie einen az dt-Modellbefehl zum ersten Mal ausführen. Weitere Informationen zu Erweiterungen

Verwalten Sie DTDL-Modelle und Definitionen für eine Digital Twins-Instanz.

Befehle

Name Beschreibung Typ Status
az dt model create

Lädt mindestens ein Modell hoch.

 Erweiterung Allgemein verfügbar
az dt model delete

Löschen eines Modells Ein Modell kann nur gelöscht werden, wenn keine anderen Modelle darauf verweisen.

 Erweiterung Allgemein verfügbar
az dt model delete-all

Löschen Sie alle Modelle in einer Digital Twins-Instanz.

 Erweiterung Allgemein verfügbar
az dt model list

Listenmodellmetadaten, Definitionen und Abhängigkeiten.

 Erweiterung Allgemein verfügbar
az dt model show

Dient zum Abrufen eines Zielmodells oder einer Modelldefinition.

 Erweiterung Allgemein verfügbar
az dt model update

Aktualisiert die Metadaten für ein Modell. Derzeit kann ein Modell nur dekommisiert werden.

 Erweiterung Allgemein verfügbar

az dt model create

Lädt mindestens ein Modell hoch.

--Models können inline json oder Dateipfad sein. Die Größe des Eingabemodellsatzes (Ontology) wird durch die maximale Anzahl von Modellen eingeschränkt, die von der DT-Instanz gespeichert werden können (Standardwert ist 10000 Modelle).

az dt model create --dt-name
                   [--failure-policy {None, Rollback}]
                   [--fd]
                   [--max-models-per-batch]
                   [--models]
                   [--resource-group]

Beispiele

Massenupload aller JSON- oder DTDL-Modelldateien aus einem Zielverzeichnis. Die Modellverarbeitung ist rekursiv.

az dt model create -n {instance_or_hostname} --from-directory {directory_path}

Laden Sie "json"-Modell inline oder aus dem Dateipfad hoch.

az dt model create -n {instance_or_hostname} --models {file_path_or_inline_json}

Erforderliche Parameter

--dt-name --dtn -n

Name oder Hostname der Digital Twins-Instanz. Wenn ein Instanzname angegeben wird, wird das Benutzerabonnement zuerst für die Zielinstanz abgefragt, um den Hostnamen abzurufen. Wenn ein Hostname angegeben wird, wird die Abonnementabfrage übersprungen und der bereitgestellte Wert für nachfolgende Interaktionen verwendet.

Optionale Parameter

--failure-policy --fp

Gibt die Fehlerrichtlinie an, wenn beim Verarbeiten eines Modellbatches ein Fehler auftritt. Im Modus "Rollback" werden alle modelle, die in früheren Batches erstellt wurden, einzeln gelöscht. Wenn sie als "Keine" ausgewählt ist, werden die in früheren Batches erstellten Modelle nicht aus der DT-Instanz gelöscht.

Zulässige Werte: None, Rollback
Standardwert: Rollback
--fd --from-directory

Die JSON-Verzeichnismodelldateien werden analysiert. Hinweis: Modelle werden atomisch erstellt, wenn das Verzeichnis 250 oder weniger Modelle enthält, daher wird bei einem Fehler keines der Modelle erstellt. Der Eingabemodellsatz wird in Batches unterteilt und erstellt, wenn das Verzeichnis mehr als 250 Modelle (API-Grenzwert) aufweist. Bei einer Fehlerverarbeitung eines Batches wird das Verhalten durch den Parameter "--failure-policy" bestimmt.

--max-models-per-batch --mmpb
Experimentell

Die maximale Modellgröße pro Batch beim Erstellen von mehr als 250 Modellen. Verringern Sie diese Zahl, um einen DTDLParser-Fehler zu verhindern.

Standardwert: 30
--models

Inlinemodell JSON oder Dateipfad zum Modell JSON. Hinweis: Modelle werden atomisch erstellt, wenn modell JSON 250 oder weniger Modelle enthält, daher bei einem Fehler, dass keines der Modelle erstellt wird. Der Eingabemodellsatz wird in Batches unterteilt und erstellt, wenn modell JSON mehr als 250 Modelle (API-Grenzwert) aufweist. Bei einer Fehlerverarbeitung eines Batches wird das Verhalten durch den Parameter "--failure-policy" bestimmt.

--resource-group -g

Ressourcengruppe der Digital Twins-Instanz. Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.

Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
Standardwert: json
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az dt model delete

Löschen eines Modells Ein Modell kann nur gelöscht werden, wenn keine anderen Modelle darauf verweisen.

az dt model delete --dt-name
                   --dtmi
                   [--resource-group]

Beispiele

Löschen eines Zielmodells.

az dt model delete -n {instance_or_hostname} --dtmi "dtmi:com:example:Floor;1"

Erforderliche Parameter

--dt-name --dtn -n

Name oder Hostname der Digital Twins-Instanz. Wenn ein Instanzname angegeben wird, wird das Benutzerabonnement zuerst für die Zielinstanz abgefragt, um den Hostnamen abzurufen. Wenn ein Hostname angegeben wird, wird die Abonnementabfrage übersprungen und der bereitgestellte Wert für nachfolgende Interaktionen verwendet.

--dtmi --model-id -m

Digital Twins Modell ID. Beispiel: dtmi:com:example:Room;2.

Optionale Parameter

--resource-group -g

Ressourcengruppe der Digital Twins-Instanz. Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.

Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
Standardwert: json
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az dt model delete-all

Löschen Sie alle Modelle in einer Digital Twins-Instanz.

Zwillingskonfigurationen sind nicht betroffen, können aber ohne Modelldefinitionen unterbrochen werden.

az dt model delete-all --dt-name
                       [--resource-group]
                       [--yes]

Beispiele

Alle Modelle löschen.

az dt model delete-all -n {instance_or_hostname}

Erforderliche Parameter

--dt-name --dtn -n

Name oder Hostname der Digital Twins-Instanz. Wenn ein Instanzname angegeben wird, wird das Benutzerabonnement zuerst für die Zielinstanz abgefragt, um den Hostnamen abzurufen. Wenn ein Hostname angegeben wird, wird die Abonnementabfrage übersprungen und der bereitgestellte Wert für nachfolgende Interaktionen verwendet.

Optionale Parameter

--resource-group -g

Ressourcengruppe der Digital Twins-Instanz. Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.

--yes -y

Nicht zur Bestätigung auffordern

Standardwert: False
Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
Standardwert: json
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az dt model list

Listenmodellmetadaten, Definitionen und Abhängigkeiten.

az dt model list --dt-name
                 [--def {false, true}]
                 [--dependencies-for]
                 [--resource-group]

Beispiele

Listenmodellmetadaten

az dt model list -n {instance_or_hostname}

Listenmodelldefinitionen

az dt model list -n {instance_or_hostname} --definition

Listet Abhängigkeiten bestimmter bereits vorhandener Modelle auf. Leerzeichen trennen dtmi-Werte.

az dt model list -n {instance_or_hostname} --dependencies-for {model_id0} {model_id1}

Erforderliche Parameter

--dt-name --dtn -n

Name oder Hostname der Digital Twins-Instanz. Wenn ein Instanzname angegeben wird, wird das Benutzerabonnement zuerst für die Zielinstanz abgefragt, um den Hostnamen abzurufen. Wenn ein Hostname angegeben wird, wird die Abonnementabfrage übersprungen und der bereitgestellte Wert für nachfolgende Interaktionen verwendet.

Optionale Parameter

--def --definition

Der Vorgang ruft die Modelldefinition ab.

Zulässige Werte: false, true
Standardwert: False
--dependencies-for

Die Gruppe von Modellen, die ihre Abhängigkeiten abrufen. Wenn nicht angegeben, werden alle Modelle abgerufen. Das Format ist eine durch Leerzeichen getrennte Liste.

--resource-group -g

Ressourcengruppe der Digital Twins-Instanz. Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.

Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
Standardwert: json
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az dt model show

Dient zum Abrufen eines Zielmodells oder einer Modelldefinition.

az dt model show --dt-name
                 --dtmi
                 [--def {false, true}]
                 [--resource-group]

Beispiele

Modellmetadaten anzeigen

az dt model show -n {instance_or_hostname} --dtmi "dtmi:com:example:Floor;1"

Modellmetadaten und -definition anzeigen

az dt model show -n {instance_or_hostname} --dtmi "dtmi:com:example:Floor;1" --definition

Erforderliche Parameter

--dt-name --dtn -n

Name oder Hostname der Digital Twins-Instanz. Wenn ein Instanzname angegeben wird, wird das Benutzerabonnement zuerst für die Zielinstanz abgefragt, um den Hostnamen abzurufen. Wenn ein Hostname angegeben wird, wird die Abonnementabfrage übersprungen und der bereitgestellte Wert für nachfolgende Interaktionen verwendet.

--dtmi --model-id -m

Digital Twins Modell ID. Beispiel: dtmi:com:example:Room;2.

Optionale Parameter

--def --definition

Der Vorgang ruft die Modelldefinition ab.

Zulässige Werte: false, true
Standardwert: False
--resource-group -g

Ressourcengruppe der Digital Twins-Instanz. Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.

Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
Standardwert: json
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az dt model update

Aktualisiert die Metadaten für ein Modell. Derzeit kann ein Modell nur dekommisiert werden.

az dt model update --dt-name
                   --dtmi
                   [--decommission {false, true}]
                   [--resource-group]

Beispiele

Dekommision eines Zielmodells

az dt model update -n {instance_or_hostname} --dtmi "dtmi:com:example:Floor;1" --decommission

Erforderliche Parameter

--dt-name --dtn -n

Name oder Hostname der Digital Twins-Instanz. Wenn ein Instanzname angegeben wird, wird das Benutzerabonnement zuerst für die Zielinstanz abgefragt, um den Hostnamen abzurufen. Wenn ein Hostname angegeben wird, wird die Abonnementabfrage übersprungen und der bereitgestellte Wert für nachfolgende Interaktionen verwendet.

--dtmi --model-id -m

Digital Twins Modell ID. Beispiel: dtmi:com:example:Room;2.

Optionale Parameter

--decommission

Gibt an, dass ein Zielmodell außer Betrieb genommen werden soll.

Zulässige Werte: false, true
--resource-group -g

Ressourcengruppe der Digital Twins-Instanz. Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.

Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
Standardwert: json
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.