Share via

az dt network private-endpoint connection

  • 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 network private-endpoint connection command. Learn more about extensions.

Manage Digital Twins instance private-endpoint connections.

Commands

Name Description Type Status
az dt network private-endpoint connection delete

Delete a private-endpoint connection associated with the Digital Twins instance.

 Extension GA
az dt network private-endpoint connection list

List private-endpoint connections associated with the Digital Twins instance.

 Extension GA
az dt network private-endpoint connection set

Set the state of a private-endpoint connection associated with the Digital Twins instance.

 Extension GA
az dt network private-endpoint connection show

Show a private-endpoint connection associated with the Digital Twins instance.

 Extension GA
az dt network private-endpoint connection wait

Wait until an operation on a private-endpoint connection is complete.

 Extension GA

az dt network private-endpoint connection delete

Delete a private-endpoint connection associated with the Digital Twins instance.

az dt network private-endpoint connection delete --cn
                                                 --dt-name
                                                 [--no-wait]
                                                 [--resource-group]
                                                 [--yes]

Examples

Delete the private-endpoint connection named ba8408b6-1372-41b2-aef8-af43afc4729f with confirmation. Block until finished.

az dt network private-endpoint connection delete -n {instance_name} --cn ba8408b6-1372-41b2-aef8-af43afc4729f

Delete the private-endpoint connection named ba8408b6-1372-41b2-aef8-af43afc4729f no confirmation. Return immediately.

az dt network private-endpoint connection delete -n {instance_name} --cn ba8408b6-1372-41b2-aef8-af43afc4729f -y --no-wait

Required Parameters

--cn --conn-name

Private endpoint connection name.

--dt-name --dtn -n

Digital Twins instance 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 network private-endpoint connection list

List private-endpoint connections associated with the Digital Twins instance.

az dt network private-endpoint connection list --dt-name
                                               [--resource-group]

Examples

List all private-endpoint connections associated with the instance.

az dt network private-endpoint connection 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 network private-endpoint connection set

Set the state of a private-endpoint connection associated with the Digital Twins instance.

az dt network private-endpoint connection set --cn
                                              --dt-name
                                              --status {Approved, Disconnected, Pending, Rejected}
                                              [--actions-required]
                                              [--desc]
                                              [--group-ids]
                                              [--no-wait]
                                              [--resource-group]

Examples

Approve a pending private-endpoint connection associated with the instance and add a description.

az dt network private-endpoint connection set -n {instance_name} --cn {connection_name} --status Approved --desc "A description."

Reject a private-endpoint connection associated with the instance and add a description.

az dt network private-endpoint connection set -n {instance_name} --cn {connection_name} --status Rejected --desc "Does not comply."

Required Parameters

--cn --conn-name

Private endpoint connection name.

--dt-name --dtn -n

Digital Twins instance name.

--status

The status of a private endpoint connection.

Accepted values: Approved, Disconnected, Pending, Rejected

Optional Parameters

--actions-required --ar

A message indicating if changes on the service provider require any updates on the consumer.

--desc --description

Description for the private endpoint connection.

--group-ids

Space separated list of group ids that the private endpoint should connect to.

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

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 network private-endpoint connection show

Show a private-endpoint connection associated with the Digital Twins instance.

az dt network private-endpoint connection show --cn
                                               --dt-name
                                               [--resource-group]

Examples

Show details of the private-endpoint connection named ba8408b6-1372-41b2-aef8-af43afc4729f.

az dt network private-endpoint connection show -n {instance_name} --cn ba8408b6-1372-41b2-aef8-af43afc4729f

Required Parameters

--cn --conn-name

Private endpoint connection name.

--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 network private-endpoint connection wait

Wait until an operation on a private-endpoint connection is complete.

az dt network private-endpoint connection wait --cn
                                               --dt-name
                                               [--custom]
                                               [--deleted]
                                               [--interval]
                                               [--resource-group]
                                               [--timeout]
                                               [--updated]

Examples

Wait until the existing private-endpoint connection named ba8408b6-1372-41b2-aef8-af43afc4729f state is updated.

az dt network private-endpoint connection wait -n {instance_name} --cn ba8408b6-1372-41b2-aef8-af43afc4729f --updated

Wait until the existing private-endpoint connection named ba8408b6-1372-41b2-aef8-af43afc4729f is deleted.

az dt network private-endpoint connection wait -n {instance_name} --cn ba8408b6-1372-41b2-aef8-af43afc4729f --deleted

Wait until the existing private-endpoint connection named ba8408b6-1372-41b2-aef8-af43afc4729f has no actions required in the privateLinkServiceConnectionState property.

az dt network private-endpoint connection wait -n {instance_name} --cn ba8408b6-1372-41b2-aef8-af43afc4729f --custom "properties.privateLinkServiceConnectionState.actionsRequired=='None'"

Required Parameters

--cn --conn-name

Private endpoint connection name.

--dt-name --dtn -n

Digital Twins instance name.

Optional Parameters

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

Wait until updated with provisioningState at 'Succeeded'.

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.