az dt endpoint

  • 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-Endpunktbefehl zum ersten Mal ausführen. Weitere Informationen zu Erweiterungen

Verwalten und Konfigurieren von Endpunkten für Digital Twins-Instanzen.

Befehle

Name Beschreibung Typ Status
az dt endpoint create

Fügen Sie Endpunkte zu einer Digital Twins-Instanz hinzu.

 Durchwahl Allgemein verfügbar
az dt endpoint create eventgrid

Fügt einer Digital Twins-Instanz einen EventGrid-Themenendpunkt hinzu. Erfordert eine zuvor erstellte Ressource.

 Durchwahl Allgemein verfügbar
az dt endpoint create eventhub

Fügt einen EventHub-Endpunkt zu einer Digital Twins-Instanz hinzu.

 Durchwahl Allgemein verfügbar
az dt endpoint create servicebus

Fügt einer Digital Twins-Instanz einen ServiceBus Topic-Endpunkt hinzu.

 Durchwahl Allgemein verfügbar
az dt endpoint delete

Entfernen Sie einen Endpunkt aus einer Digital Twins-Instanz.

 Durchwahl Allgemein verfügbar
az dt endpoint list

Listet alle Endpunkte auf, die auf einer Digital Twins-Instanz konfiguriert sind.

 Durchwahl Allgemein verfügbar
az dt endpoint show

Zeigen Sie Details eines Endpunkts an, der auf einer Digital Twins-Instanz konfiguriert ist.

 Durchwahl Allgemein verfügbar
az dt endpoint wait

Warten Sie, bis ein Endpunktvorgang abgeschlossen ist.

 Durchwahl Allgemein verfügbar

az dt endpoint delete

Entfernen Sie einen Endpunkt aus einer Digital Twins-Instanz.

az dt endpoint delete --dt-name
                      --en
                      [--no-wait]
                      [--resource-group]
                      [--yes]

Beispiele

Entfernen Sie einen Endpunkt aus einer Instanz, und blockieren Sie den Vorgang, bis der Vorgang abgeschlossen ist.

az dt endpoint delete -n {instance_name} --endpoint-name {endpoint_name}

Entfernen Sie einen Endpunkt aus einer Instanz ohne Bestätigung oder Blockierung.

az dt endpoint delete -n {instance_name} --endpoint-name {endpoint_name} -y --no-wait

Erforderliche Parameter

--dt-name --dtn -n

Name der Digital Twins-Instanz.

--en --endpoint-name

Endpunktname

Optionale Parameter

--no-wait

Nicht auf den Abschluss lang andauernder Vorgänge warten

Standardwert: False
--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 endpoint list

Listet alle Endpunkte auf, die auf einer Digital Twins-Instanz konfiguriert sind.

az dt endpoint list --dt-name
                    [--resource-group]

Beispiele

Auflisten aller Endpunkte, die für eine Instanz konfiguriert sind.

az dt endpoint list -n {instance_name}

Erforderliche Parameter

--dt-name --dtn -n

Name der Digital Twins-Instanz.

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 endpoint show

Zeigen Sie Details eines Endpunkts an, der auf einer Digital Twins-Instanz konfiguriert ist.

az dt endpoint show --dt-name
                    --en
                    [--resource-group]

Beispiele

Zeigen Sie einen gewünschten Endpunkt anhand des Namens einer Instanz an.

az dt endpoint show -n {instance_name} --endpoint-name {endpoint_name}

Erforderliche Parameter

--dt-name --dtn -n

Name der Digital Twins-Instanz.

--en --endpoint-name

Endpunktname

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 endpoint wait

Warten Sie, bis ein Endpunktvorgang abgeschlossen ist.

az dt endpoint wait --dt-name
                    --en
                    [--created]
                    [--custom]
                    [--deleted]
                    [--exists]
                    [--interval]
                    [--resource-group]
                    [--timeout]

Beispiele

Warten Sie, bis ein Endpunkt für eine Instanz erstellt wird.

az dt endpoint wait -n {instance_name} --endpoint-name {endpoint_name} --created

Warten Sie, bis ein vorhandener Endpunkt aus einer Instanz gelöscht wird.

az dt endpoint wait -n {instance_name} --endpoint-name {endpoint_name} --deleted

Warten Sie, bis die primäre Verbinden ionString eines vorhandenen Endpunkts null ist.

az dt endpoint wait -n {instance_name} --endpoint-name {endpoint_name} --custom "properties.primaryConnectionString==null"

Erforderliche Parameter

--dt-name --dtn -n

Name der Digital Twins-Instanz.

--en --endpoint-name

Endpunktname

Optionale Parameter

--created

Warten Sie, bis sie mit 'provisioningState' unter 'Succeeded' erstellt wurde.

Standardwert: False
--custom

Warten Sie, bis die Bedingung eine benutzerdefinierte JMESPath-Abfrage erfüllt. Beispiel: provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Warten Sie, bis sie gelöscht wurde.

Standardwert: False
--exists

Warten Sie, bis die Ressource vorhanden ist.

Standardwert: False
--interval

Abrufintervall in Sekunden.

Standardwert: 30
--resource-group -g

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

--timeout

Maximale Wartezeit in Sekunden.

Standardwert: 3600
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.