az dt endpoint

Reference

Note

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

Manage and configure Digital Twins instance endpoints.

Commands

Name	Description	Type	Status
az dt endpoint create	Add egress endpoints 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.	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 delete	Remove an endpoint from a Digital Twins instance.	Extension	GA
az dt endpoint list	List all egress endpoints configured on a Digital Twins instance.	Extension	GA
az dt endpoint show	Show details of an endpoint configured on a Digital Twins instance.	Extension	GA
az dt endpoint wait	Wait until an endpoint operation is done.	Extension	GA

az dt endpoint delete

Remove an endpoint from a Digital Twins instance.

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

Examples

Remove an endpoint from an instance and block until the operation is complete.

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

Remove an endpoint from an instance without confirmation or blocking.

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

Required Parameters

--dt-name --dtn -n

Digital Twins instance name.

--en --endpoint-name

Endpoint name.

Optional Parameters

--no-wait

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

Default value: False

--resource-group -g

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

--yes -y

Do not prompt for confirmation.

Default value: False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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

az dt endpoint list

List all egress endpoints configured on a Digital Twins instance.

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

Examples

List all egress endpoints configured on an instance.

az dt endpoint list -n {instance_name}

Required Parameters

--dt-name --dtn -n

Digital Twins instance name.

Optional Parameters

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

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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

az dt endpoint show

Show details of an endpoint configured on a Digital Twins instance.

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

Examples

Show a desired endpoint by name on an instance.

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

Required Parameters

--dt-name --dtn -n

Digital Twins instance name.

--en --endpoint-name

Endpoint name.

Optional Parameters

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

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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

az dt endpoint wait

Wait until an endpoint operation is done.

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

Examples

Wait until an endpoint for an instance is created.

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

Wait until an existing endpoint is deleted from an instance.

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

Wait until an existing endpoint's primaryConnectionString is null.

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

Required Parameters

--dt-name --dtn -n

Digital Twins instance name.

--en --endpoint-name

Endpoint name.

Optional Parameters

--created

Wait until created with 'provisioningState' at 'Succeeded'.

Default value: False

--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Wait until deleted.

Default value: False

--exists

Wait until the resource exists.

Default value: False

--interval

Polling interval in seconds.

Default value: 30

--resource-group -g

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

--timeout

Maximum wait in seconds.

Default value: 3600

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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

Share via

az dt endpoint

Commands

az dt endpoint delete

Examples

Required Parameters

Optional Parameters

az dt endpoint list

Examples

Required Parameters

Optional Parameters

az dt endpoint show

Examples

Required Parameters

Optional Parameters

az dt endpoint wait

Examples

Required Parameters

Optional Parameters

Additional resources