az dt network private-link

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

Manage Digital Twins instance private-link operations.

Commands

Name	Description	Type	Status
az dt network private-link list	List private-links associated with the Digital Twins instance.	Extension	GA
az dt network private-link show	Show a private-link associated with the instance.	Extension	GA

az dt network private-link list

List private-links associated with the Digital Twins instance.

az dt network private-link list --dt-name --dtn
                                [--resource-group]

Examples

List all private-links associated with the instance.

az dt network private-link list -n {instance_name}

Required Parameters

--dt-name --dtn -n

Digital Twins instance 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.

--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 network private-link show

Show a private-link associated with the instance.

az dt network private-link show --dt-name --dtn
                                --link-name --ln
                                [--resource-group]

Examples

Show the private-link named "API" associated with the instance.

az dt network private-link show -n {instance_name} --link-name API

Required Parameters

--dt-name --dtn -n

Digital Twins instance name.

--link-name --ln

Private link name.

Property	Value
Parameter group:	Private Connection 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.

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