az dt endpoint create

Note

This reference is part of the azure-iot extension for the Azure CLI (version 2.30.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

az dt endpoint create eventgrid

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

az dt endpoint create eventhub

Adds an EventHub endpoint to a Digital Twins instance. Requires pre-created resource. The instance must be created with a managed identity to support identity based endpoint integration.

az dt endpoint create servicebus

Adds a ServiceBus Topic endpoint to a Digital Twins instance. Requires pre-created resource. The instance must be created with a managed identity to support identity based endpoint integration.

az dt endpoint create eventgrid

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

az dt endpoint create eventgrid --dt-name
                                --egg
                                --egt
                                --en
                                [--auth-type {IdentityBased, KeyBased}]
                                [--deadletter-sas-uri]
                                [--deadletter-uri]
                                [--egs]
                                [--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.

--egg --eventgrid-resource-group

Name of EventGrid Topic resource group.

--egt --eventgrid-topic

Name of EventGrid Topic to integrate with.

--en --endpoint-name

Endpoint name.

Optional Parameters

--auth-type

Endpoint authentication type.

accepted values: IdentityBased, KeyBased
default value: KeyBased
--deadletter-sas-uri --dsu

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

--deadletter-uri --du

Dead-letter storage container URL for Identity based authentication.

--egs --eventgrid-subscription

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

--no-wait

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

--resource-group -g

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

az dt endpoint create eventhub

Adds an EventHub endpoint to a Digital Twins instance. Requires pre-created resource. The instance must be created with a managed identity to support identity based endpoint integration.

az dt endpoint create eventhub --dt-name
                               --eh
                               --ehg
                               --ehn
                               --en
                               [--auth-type {IdentityBased, KeyBased}]
                               [--deadletter-sas-uri]
                               [--deadletter-uri]
                               [--ehp]
                               [--ehs]
                               [--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 Identity based auth.

az dt endpoint create eventhub --endpoint-name {endpoint_name} --eventhub-resource-group {eventhub_resource_group} --eventhub-namespace {eventhub_namespace} --eventhub {eventhub_name} --auth-type IdentityBased -n {instance_name}

Required Parameters

--dt-name --dtn -n

Digital Twins instance name.

--eh --eventhub

Name of EventHub to integrate with.

--ehg --eventhub-resource-group

Name of EventHub resource group.

--ehn --eventhub-namespace

EventHub Namespace identifier.

--en --endpoint-name

Endpoint name.

Optional Parameters

--auth-type

Endpoint authentication type.

accepted values: IdentityBased, KeyBased
default value: KeyBased
--deadletter-sas-uri --dsu

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

--deadletter-uri --du

Dead-letter storage container URL for Identity based authentication.

--ehp --eventhub-policy

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

--ehs --eventhub-subscription

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

--no-wait

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

--resource-group -g

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

az dt endpoint create servicebus

Adds a ServiceBus Topic endpoint to a Digital Twins instance. Requires pre-created resource. The instance must be created with a managed identity to support identity based endpoint integration.

az dt endpoint create servicebus --dt-name
                                 --en
                                 --sbg
                                 --sbn
                                 --sbt
                                 [--auth-type {IdentityBased, KeyBased}]
                                 [--deadletter-sas-uri]
                                 [--deadletter-uri]
                                 [--no-wait]
                                 [--resource-group]
                                 [--sbp]
                                 [--sbs]

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 Identity 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} -n {instance_name}

Required Parameters

--dt-name --dtn -n

Digital Twins instance name.

--en --endpoint-name

Endpoint name.

--sbg --servicebus-resource-group

Name of ServiceBus resource group.

--sbn --servicebus-namespace

ServiceBus Namespace identifier.

--sbt --servicebus-topic

Name of ServiceBus Topic to integrate with.

Optional Parameters

--auth-type

Endpoint authentication type.

accepted values: IdentityBased, KeyBased
default value: KeyBased
--deadletter-sas-uri --dsu

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

--deadletter-uri --du

Dead-letter storage container URL for Identity based authentication.

--no-wait

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

--resource-group -g

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

--sbp --servicebus-policy

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

--sbs --servicebus-subscription

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