Freigeben über

az dt model

Note

Diese Referenz ist Teil der Azure-iot-Erweiterung für die Azure CLI (Version 2.67.0 oder höher). Die Erweiterung wird automatisch installiert, wenn Sie ein az dt-Modell Befehl zum ersten Mal ausführen. Erfahren Sie mehr über 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.

 Extension GA
az dt model delete

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

 Extension GA
az dt model delete-all

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

 Extension GA
az dt model list

Listenmodellmetadaten, Definitionen und Abhängigkeiten.

 Extension GA
az dt model show

Dient zum Abrufen eines Zielmodells oder einer Modelldefinition.

 Extension GA
az dt model update

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

 Extension GA

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 --dtn
                   [--failure-policy --fp {None, Rollback}]
                   [--fd --from-directory]
                   [--max-models-per-batch --mmpb]
                   [--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

Die folgenden Parameter sind optional, aber je nach Kontext kann mindestens ein Parameter erforderlich sein, damit der Befehl erfolgreich ausgeführt werden kann.

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

Eigenschaft Wert
Parametergruppe: Models Input Arguments
Standardwert: Rollback
Zulässige Werte: None, 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 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.

Eigenschaft Wert
Parametergruppe: Models Input Arguments
--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.

Eigenschaft Wert
Parametergruppe: Models Input Arguments
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 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.

Eigenschaft Wert
Parametergruppe: Models Input Arguments
--resource-group -g

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

Globale Parameter
--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft Wert
Standardwert: False
--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft Wert
Standardwert: False
--output -o

Ausgabeformat.

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

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

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft Wert
Standardwert: False

az dt model delete

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

az dt model delete --dt-name --dtn
                   --dtmi --model-id
                   [--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

Die folgenden Parameter sind optional, aber je nach Kontext kann mindestens ein Parameter erforderlich sein, damit der Befehl erfolgreich ausgeführt werden kann.

--resource-group -g

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

Globale Parameter
--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft Wert
Standardwert: False
--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft Wert
Standardwert: False
--output -o

Ausgabeformat.

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

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

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft Wert
Standardwert: False

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 --dtn
                       [--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

Die folgenden Parameter sind optional, aber je nach Kontext kann mindestens ein Parameter erforderlich sein, damit der Befehl erfolgreich ausgeführt werden kann.

--resource-group -g

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

--yes -y

Zur Bestätigung nicht auffordern.

Eigenschaft Wert
Standardwert: False
Globale Parameter
--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft Wert
Standardwert: False
--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft Wert
Standardwert: False
--output -o

Ausgabeformat.

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

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

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft Wert
Standardwert: False

az dt model list

Listenmodellmetadaten, Definitionen und Abhängigkeiten.

az dt model list --dt-name --dtn
                 [--def --definition {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

Die folgenden Parameter sind optional, aber je nach Kontext kann mindestens ein Parameter erforderlich sein, damit der Befehl erfolgreich ausgeführt werden kann.

--def --definition

Der Vorgang ruft die Modelldefinition ab.

Eigenschaft Wert
Standardwert: False
Zulässige Werte: false, true
--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

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft Wert
Standardwert: False
--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft Wert
Standardwert: False
--output -o

Ausgabeformat.

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

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

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft Wert
Standardwert: False

az dt model show

Dient zum Abrufen eines Zielmodells oder einer Modelldefinition.

az dt model show --dt-name --dtn
                 --dtmi --model-id
                 [--def --definition {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

Die folgenden Parameter sind optional, aber je nach Kontext kann mindestens ein Parameter erforderlich sein, damit der Befehl erfolgreich ausgeführt werden kann.

--def --definition

Der Vorgang ruft die Modelldefinition ab.

Eigenschaft Wert
Standardwert: False
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

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft Wert
Standardwert: False
--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft Wert
Standardwert: False
--output -o

Ausgabeformat.

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

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

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft Wert
Standardwert: False

az dt model update

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

az dt model update --dt-name --dtn
                   --dtmi --model-id
                   [--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

Die folgenden Parameter sind optional, aber je nach Kontext kann mindestens ein Parameter erforderlich sein, damit der Befehl erfolgreich ausgeführt werden kann.

--decommission

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

Eigenschaft Wert
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

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft Wert
Standardwert: False
--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft Wert
Standardwert: False
--output -o

Ausgabeformat.

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

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

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft Wert
Standardwert: False