az dt endpoint create

Note

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

将出口终结点添加到数字孪生实例。

命令

名称	说明	类型	Status
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 create eventgrid

将 EventGrid 主题终结点添加到数字孪生实例。 需要预先创建的资源。

EventGrid 主题终结点不支持基于标识的终结点集成。

az dt endpoint create eventgrid --dt-name --dtn
                                --egt --eventgrid-topic
                                --en --endpoint-name
                                [--deadletter-sas-uri --dsu]
                                [--deadletter-uri --du]
                                [--egg --eventgrid-resource-group]
                                [--egs --eventgrid-subscription]
                                [--no-wait]
                                [--resource-group]

示例

将 EventGrid 主题终结点添加到目标实例。

az dt endpoint create eventgrid --endpoint-name {endpoint_name} --eventgrid-resource-group {eventgrid_resource_group} --eventgrid-topic {eventgrid_topic_name} -n {instance_name}

必需参数

--dt-name --dtn -n

数字孪生实例名称。

--egt --eventgrid-topic

要与之集成的 EventGrid 主题的名称。

属性	值
Parameter group:	Event Grid Topic Arguments

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

--deadletter-sas-uri --dsu

使用 SAS 令牌进行基于密钥的身份验证的死信存储容器 URL。

属性	值
Parameter group:	Dead-letter Endpoint Arguments

--deadletter-uri --du

基于标识的身份验证的死信存储容器 URL。

属性	值
Parameter group:	Dead-letter Endpoint Arguments

--egg --eventgrid-resource-group

EventGrid 主题资源组的名称。 如果未提供，将使用数字孪生实例资源组。

属性	值
Parameter group:	Event Grid Topic Arguments

--egs --eventgrid-subscription

终结点资源所在的订阅的名称或 ID。 如果未提供任何订阅，则使用默认订阅。

属性	值
Parameter group:	Event Grid Topic Arguments

--no-wait

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

属性	值
默认值:	False

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

将 EventHub 终结点添加到数字孪生实例。

需要预先创建的资源。

实例必须具有系统分配的标识才能支持基于系统分配的标识的终结点集成。 该实例必须具有关联的用户分配标识以支持基于用户分配的标识的终结点集成。

az dt endpoint create eventhub --dt-name --dtn
                               --eh --eventhub
                               --ehn --eventhub-namespace
                               --en --endpoint-name
                               [--auth-type {IdentityBased, KeyBased}]
                               [--deadletter-sas-uri --dsu]
                               [--deadletter-uri --du]
                               [--ehg --eventhub-resource-group]
                               [--ehp --eventhub-policy]
                               [--ehs --eventhub-subscription]
                               [--mi-system-assigned --system {false, true}]
                               [--mi-user-assigned --user]
                               [--no-wait]
                               [--resource-group]

示例

使用基于密钥的身份验证将 EventHub 终结点添加到目标实例。

az dt endpoint create eventhub --endpoint-name {endpoint_name} --eventhub-resource-group {eventhub_resource_group} --eventhub-namespace {eventhub_namespace} --eventhub {eventhub_name} --eventhub-policy {eventhub_policy} -n {instance_name}

使用系统分配的标识进行身份验证，将 EventHub 终结点添加到目标实例。

az dt endpoint create eventhub --endpoint-name {endpoint_name} --eventhub-resource-group {eventhub_resource_group} --eventhub-namespace {eventhub_namespace} --eventhub {eventhub_name} --mi-system-assigned -n {instance_name}

使用用户分配的标识向目标实例添加 EventHub 终结点进行身份验证。

az dt endpoint create eventhub --endpoint-name {endpoint_name} --eventhub-resource-group {eventhub_resource_group} --eventhub-namespace {eventhub_namespace} --eventhub {eventhub_name} --mi-user-assigned {resource_id} -n {instance_name}

必需参数

--dt-name --dtn -n

数字孪生实例名称。

--eh --eventhub

要与之集成的 EventHub 的名称。

属性	值
Parameter group:	Event Hub Arguments

--ehn --eventhub-namespace

EventHub 命名空间标识符。

属性	值
Parameter group:	Event Hub Arguments

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

--auth-type

已放弃

参数“auth_type”已被弃用，将在将来的版本中删除。 请改用“identity”。

终结点身份验证类型。

属性	值
默认值:	KeyBased
接受的值:	IdentityBased, KeyBased

--deadletter-sas-uri --dsu

使用 SAS 令牌进行基于密钥的身份验证的死信存储容器 URL。

属性	值
Parameter group:	Dead-letter Endpoint Arguments

--deadletter-uri --du

基于标识的身份验证的死信存储容器 URL。

属性	值
Parameter group:	Dead-letter Endpoint Arguments

--ehg --eventhub-resource-group

EventHub 资源组的名称。 如果未提供，将使用数字孪生实例资源组。

属性	值
Parameter group:	Event Hub Arguments

--ehp --eventhub-policy

用于终结点配置的 EventHub 策略。 当 --auth-type 为 KeyBased 时是必需的。

属性	值
Parameter group:	Event Hub Arguments

--ehs --eventhub-subscription

终结点资源所在的订阅的名称或 ID。 如果未提供任何订阅，则使用默认订阅。

属性	值
Parameter group:	Event Hub Arguments

--mi-system-assigned --system

使用系统分配的托管标识进行终结点身份验证。

属性	值
接受的值:	false, true

--mi-user-assigned --user

使用用户分配的托管标识进行终结点身份验证。 接受标识资源 ID。

--no-wait

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

属性	值
默认值:	False

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

将 ServiceBus 主题终结点添加到数字孪生实例。

需要预先创建的资源。

实例必须具有系统分配的标识才能支持基于系统分配的标识的终结点集成。 该实例必须具有关联的用户分配标识以支持基于用户分配的标识的终结点集成。

az dt endpoint create servicebus --dt-name --dtn
                                 --en --endpoint-name
                                 --sbn --servicebus-namespace
                                 --sbt --servicebus-topic
                                 [--auth-type {IdentityBased, KeyBased}]
                                 [--deadletter-sas-uri --dsu]
                                 [--deadletter-uri --du]
                                 [--mi-system-assigned --system {false, true}]
                                 [--mi-user-assigned --user]
                                 [--no-wait]
                                 [--resource-group]
                                 [--sbg --servicebus-resource-group]
                                 [--sbp --servicebus-policy]
                                 [--sbs --servicebus-subscription]

示例

使用基于密钥的身份验证将 ServiceBus 主题终结点添加到目标实例。

az dt endpoint create servicebus --endpoint-name {endpoint_name} --servicebus-resource-group {servicebus_resource_group} --servicebus-namespace {servicebus_namespace} --servicebus-topic {servicebus_topic_name} --servicebus-policy {servicebus_policy} -n {instance_name}

使用系统分配的标识向目标实例添加 ServiceBus 主题终结点进行身份验证。

az dt endpoint create servicebus --endpoint-name {endpoint_name} --servicebus-resource-group {servicebus_resource_group} --servicebus-namespace {servicebus_namespace} --servicebus-topic {servicebus_topic_name} --mi-system-assigned -n {instance_name}

使用用户分配的标识向目标实例添加 ServiceBus 主题终结点进行身份验证。

az dt endpoint create servicebus --endpoint-name {endpoint_name} --servicebus-resource-group {servicebus_resource_group} --servicebus-namespace {servicebus_namespace} --servicebus-topic {servicebus_topic_name} --mi-user-assigned {resource_id} -n {instance_name}

必需参数

--dt-name --dtn -n

数字孪生实例名称。

--en --endpoint-name

Endpoint name.

--sbn --servicebus-namespace

ServiceBus 命名空间标识符。

属性	值
Parameter group:	Service Bus Topic Arguments

--sbt --servicebus-topic

要与之集成的 ServiceBus 主题的名称。

属性	值
Parameter group:	Service Bus Topic Arguments

可选参数

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

--auth-type

已放弃

参数“auth_type”已被弃用，将在将来的版本中删除。 请改用“identity”。

终结点身份验证类型。

属性	值
默认值:	KeyBased
接受的值:	IdentityBased, KeyBased

--deadletter-sas-uri --dsu

使用 SAS 令牌进行基于密钥的身份验证的死信存储容器 URL。

属性	值
Parameter group:	Dead-letter Endpoint Arguments

--deadletter-uri --du

基于标识的身份验证的死信存储容器 URL。

属性	值
Parameter group:	Dead-letter Endpoint Arguments

--mi-system-assigned --system

使用系统分配的托管标识进行终结点身份验证。

属性	值
接受的值:	false, true

--mi-user-assigned --user

使用用户分配的托管标识进行终结点身份验证。 接受标识资源 ID。

--no-wait

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

属性	值
默认值:	False

--resource-group -g

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

--sbg --servicebus-resource-group

ServiceBus 资源组的名称。 如果未提供，将使用数字孪生实例资源组。

属性	值
Parameter group:	Service Bus Topic Arguments

--sbp --servicebus-policy

用于终结点配置的 ServiceBus 主题策略。 当 --auth-type 为 KeyBased 时是必需的。

属性	值
Parameter group:	Service Bus Topic Arguments

--sbs --servicebus-subscription

终结点资源所在的订阅的名称或 ID。 如果未提供任何订阅，则使用默认订阅。

属性	值
Parameter group:	Service Bus Topic Arguments

全局参数

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