az dt endpoint create

Note

This reference is part of the azure-iot extension for the Azure CLI (version 2.59.0 or higher). The extension will automatically install the first time you run an az dt endpoint create command. Learn more about extensions.

Add egress endpoints to a Digital Twins instance.

Commands

Name	Description	Type	Status
az dt endpoint create eventgrid	Adds an EventGrid Topic endpoint to a Digital Twins instance. Requires pre-created resource.	Extension	GA
az dt endpoint create eventhub	Adds an EventHub endpoint to a Digital Twins instance.	Extension	GA
az dt endpoint create servicebus	Adds a ServiceBus Topic endpoint to a Digital Twins instance.	Extension	GA

az dt endpoint create eventgrid

Adds an EventGrid Topic endpoint to a Digital Twins instance. Requires pre-created resource.

EventGrid topic endpoints do not support identity based endpoint integration.

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]

Examples

Adds an EventGrid Topic endpoint to a target instance.

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

Required Parameters

--dt-name --dtn -n

Digital Twins instance name.

--egt --eventgrid-topic

Name of EventGrid Topic to integrate with.

Property	Value
Parameter group:	Event Grid Topic Arguments

--en --endpoint-name

Endpoint name.

Optional Parameters

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

Dead-letter storage container URL with SAS token for Key based authentication.

Property	Value
Parameter group:	Dead-letter Endpoint Arguments

--deadletter-uri --du

Dead-letter storage container URL for Identity based authentication.

Property	Value
Parameter group:	Dead-letter Endpoint Arguments

--egg --eventgrid-resource-group

Name of EventGrid Topic resource group. If not provided, the Digital Twin instance resource group will be used.

Property	Value
Parameter group:	Event Grid Topic Arguments

--egs --eventgrid-subscription

Name or id of subscription where the endpoint resource exists. If no subscription is provided the default subscription is used.

Property	Value
Parameter group:	Event Grid Topic Arguments

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Default value:	False

--resource-group -g

Digital Twins instance resource group. You can configure the default group using az configure --defaults group={name}.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az dt endpoint create eventhub

Adds an EventHub endpoint to a Digital Twins instance.

Requires pre-created resource.

The instance must have a system-assigned identity to support system-assigned identity based endpoint integration. The instance must have the user-assigned identity associated to support user-assigned identity based endpoint integration.

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]

Examples

Adds an EventHub endpoint to a target instance using Key based auth.

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}

Adds an EventHub endpoint to a target instance using the system-assigned identity for authentication.

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}

Adds an EventHub endpoint to a target instance using an user-assigned identity for authentication.

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}

Required Parameters

--dt-name --dtn -n

Digital Twins instance name.

--eh --eventhub

Name of EventHub to integrate with.

Property	Value
Parameter group:	Event Hub Arguments

--ehn --eventhub-namespace

EventHub Namespace identifier.

Property	Value
Parameter group:	Event Hub Arguments

--en --endpoint-name

Endpoint name.

Optional Parameters

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

--auth-type

Deprecated

Argument 'auth_type' has been deprecated and will be removed in a future release. Use 'identity' instead.

Endpoint authentication type.

Property	Value
Default value:	KeyBased
Accepted values:	IdentityBased, KeyBased

--deadletter-sas-uri --dsu

Dead-letter storage container URL with SAS token for Key based authentication.

Property	Value
Parameter group:	Dead-letter Endpoint Arguments

--deadletter-uri --du

Dead-letter storage container URL for Identity based authentication.

Property	Value
Parameter group:	Dead-letter Endpoint Arguments

--ehg --eventhub-resource-group

Name of EventHub resource group. If not provided, the Digital Twin instance resource group will be used.

Property	Value
Parameter group:	Event Hub Arguments

--ehp --eventhub-policy

EventHub policy to use for endpoint configuration. Required when --auth-type is KeyBased.

Property	Value
Parameter group:	Event Hub Arguments

--ehs --eventhub-subscription

Name or id of subscription where the endpoint resource exists. If no subscription is provided the default subscription is used.

Property	Value
Parameter group:	Event Hub Arguments

--mi-system-assigned --system

Use the system-assigned managed identity for endpoint authentication.

Property	Value
Accepted values:	false, true

--mi-user-assigned --user

Use an user-assigned managed identity for endpoint authentication. Accepts the identity resource id.

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Default value:	False

--resource-group -g

Digital Twins instance resource group. You can configure the default group using az configure --defaults group={name}.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az dt endpoint create servicebus

Adds a ServiceBus Topic endpoint to a Digital Twins instance.

Requires pre-created resource.

The instance must have a system-assigned identity to support system-assigned identity based endpoint integration. The instance must have the user-assigned identity associated to support user-assigned identity based endpoint integration.

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]

Examples

Adds a ServiceBus Topic endpoint to a target instance using Key based auth.

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}

Adds a ServiceBus Topic endpoint to a target instance using the system-assigned identity for authentication.

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}

Adds a ServiceBus Topic endpoint to a target instance using an user-assigned identity for authentication.

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}

Required Parameters

--dt-name --dtn -n

Digital Twins instance name.

--en --endpoint-name

Endpoint name.

--sbn --servicebus-namespace

ServiceBus Namespace identifier.

Property	Value
Parameter group:	Service Bus Topic Arguments

--sbt --servicebus-topic

Name of ServiceBus Topic to integrate with.

Property	Value
Parameter group:	Service Bus Topic Arguments

Optional Parameters

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

--auth-type

Deprecated

Argument 'auth_type' has been deprecated and will be removed in a future release. Use 'identity' instead.

Endpoint authentication type.

Property	Value
Default value:	KeyBased
Accepted values:	IdentityBased, KeyBased

--deadletter-sas-uri --dsu

Dead-letter storage container URL with SAS token for Key based authentication.

Property	Value
Parameter group:	Dead-letter Endpoint Arguments

--deadletter-uri --du

Dead-letter storage container URL for Identity based authentication.

Property	Value
Parameter group:	Dead-letter Endpoint Arguments

--mi-system-assigned --system

Use the system-assigned managed identity for endpoint authentication.

Property	Value
Accepted values:	false, true

--mi-user-assigned --user

Use an user-assigned managed identity for endpoint authentication. Accepts the identity resource id.

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Default value:	False

--resource-group -g

Digital Twins instance resource group. You can configure the default group using az configure --defaults group={name}.

--sbg --servicebus-resource-group

Name of ServiceBus resource group. If not provided, the Digital Twin instance resource group will be used.

Property	Value
Parameter group:	Service Bus Topic Arguments

--sbp --servicebus-policy

ServiceBus Topic policy to use for endpoint configuration. Required when --auth-type is KeyBased.

Property	Value
Parameter group:	Service Bus Topic Arguments

--sbs --servicebus-subscription

Name or id of subscription where the endpoint resource exists. If no subscription is provided the default subscription is used.

Property	Value
Parameter group:	Service Bus Topic Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False