az dt endpoint

Note

This reference is part of the azure-iot extension for the Azure CLI (version 2.59.0 or higher). 该扩展将在首次运行 az dt endpoint 命令时自动安装。 Learn more about extensions.

管理和配置数字孪生实例终结点。

命令

名称	说明	类型	Status
az dt endpoint create	将出口终结点添加到数字孪生实例。	Extension	GA
az dt endpoint create eventgrid	将 EventGrid 主题终结点添加到数字孪生实例。 需要预先创建的资源。	Extension	GA
az dt endpoint create eventhub	将 EventHub 终结点添加到数字孪生实例。	Extension	GA
az dt endpoint create servicebus	将 ServiceBus 主题终结点添加到数字孪生实例。	Extension	GA
az dt endpoint delete	从数字孪生实例中删除终结点。	Extension	GA
az dt endpoint list	列出在数字孪生实例上配置的所有出口终结点。	Extension	GA
az dt endpoint show	显示在数字孪生实例上配置的终结点的详细信息。	Extension	GA
az dt endpoint wait	等待终结点作完成。	Extension	GA

az dt endpoint delete

从数字孪生实例中删除终结点。

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

示例

从实例中删除终结点并阻止，直到作完成。

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

在不确认或阻止的情况下从实例中删除终结点。

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

必需参数

--dt-name --dtn -n

数字孪生实例名称。

--en --endpoint-name

Endpoint name.

可选参数

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

--no-wait

不等待长时间运行的操作完成。

属性	值
默认值:	False

--resource-group -g

数字孪生实例资源组。 可以使用 az configure --defaults group={name}配置默认组。

--yes -y

不要提示确认。

属性	值
默认值:	False

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性	值
默认值:	False

az dt endpoint list

列出在数字孪生实例上配置的所有出口终结点。

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

示例

列出在实例上配置的所有出口终结点。

az dt endpoint list -n {instance_name}

必需参数

--dt-name --dtn -n

数字孪生实例名称。

可选参数

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

数字孪生实例资源组。 可以使用 az configure --defaults group={name}配置默认组。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性	值
默认值:	False

az dt endpoint show

显示在数字孪生实例上配置的终结点的详细信息。

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

示例

按实例的名称显示所需的终结点。

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

必需参数

--dt-name --dtn -n

数字孪生实例名称。

--en --endpoint-name

Endpoint name.

可选参数

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

数字孪生实例资源组。 可以使用 az configure --defaults group={name}配置默认组。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性	值
默认值:	False

az dt endpoint wait

等待终结点作完成。

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

示例

等到创建实例的终结点。

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

等到从实例中删除现有终结点。

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

等到现有终结点的 primaryConnectionString 为 null。

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

必需参数

--dt-name --dtn -n

数字孪生实例名称。

--en --endpoint-name

Endpoint name.

可选参数

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

--created

等待在“Succeeded”中使用“provisioningState”创建。

属性	值
Parameter group:	Wait Condition Arguments
默认值:	False

--custom

等待条件满足自定义 JMESPath 查询。 例如 provisioningState！='InProgress'， instanceView.statuses[？code=='PowerState/running']。

属性	值
Parameter group:	Wait Condition Arguments

--deleted

等到删除为止。

属性	值
Parameter group:	Wait Condition Arguments
默认值:	False

--exists

等待资源存在。

属性	值
Parameter group:	Wait Condition Arguments
默认值:	False

--interval

轮询间隔（以秒为单位）。

属性	值
Parameter group:	Wait Condition Arguments
默认值:	30

--resource-group -g

数字孪生实例资源组。 可以使用 az configure --defaults group={name}配置默认组。

--timeout

最大等待（以秒为单位）。

属性	值
Parameter group:	Wait Condition Arguments
默认值:	3600

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性	值
默认值:	False