Freigeben über


az dt endpoint

Note

This reference is part of the azure-iot extension for the Azure CLI (version 2.59.0 or higher). Die Erweiterung wird automatisch installiert, wenn Sie einen az dt-Endpunkt Befehl ausführen. Learn more about extensions.

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.

Extension GA
az dt endpoint create eventgrid

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

Extension GA
az dt endpoint create eventhub

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

Extension GA
az dt endpoint create servicebus

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

Extension GA
az dt endpoint delete

Entfernen Sie einen Endpunkt aus einer Digital Twins-Instanz.

Extension GA
az dt endpoint list

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

Extension GA
az dt endpoint show

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

Extension GA
az dt endpoint wait

Warten Sie, bis ein Endpunktvorgang abgeschlossen ist.

Extension GA

az dt endpoint delete

Entfernen Sie einen Endpunkt aus einer Digital Twins-Instanz.

az dt endpoint delete --dt-name --dtn
                      --en --endpoint-name
                      [--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

Endpoint name.

Optionale Parameter

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--no-wait

Warten Sie nicht, bis der lange ausgeführte Vorgang abgeschlossen ist.

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

Output format.

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

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

az dt endpoint list --dt-name --dtn
                    [--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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Output format.

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

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

az dt endpoint show --dt-name --dtn
                    --en --endpoint-name
                    [--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

Endpoint name.

Optionale Parameter

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Output format.

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

Warten Sie, bis ein Endpunktvorgang abgeschlossen ist.

az dt endpoint wait --dt-name --dtn
                    --en --endpoint-name
                    [--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 primaryConnectionString 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

Endpoint name.

Optionale Parameter

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--created

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

Eigenschaft Wert
Parameter group: Wait Condition Arguments
Standardwert: False
--custom

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

Eigenschaft Wert
Parameter group: Wait Condition Arguments
--deleted

Warten Sie, bis sie gelöscht wurde.

Eigenschaft Wert
Parameter group: Wait Condition Arguments
Standardwert: False
--exists

Warten Sie, bis die Ressource vorhanden ist.

Eigenschaft Wert
Parameter group: Wait Condition Arguments
Standardwert: False
--interval

Abrufintervall in Sekunden.

Eigenschaft Wert
Parameter group: Wait Condition Arguments
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.

Eigenschaft Wert
Parameter group: Wait Condition Arguments
Standardwert: 3600
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

Output format.

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