az iot du account private-endpoint-connection

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 iot du account private-endpoint-connection command. Learn more about extensions.

Device Update account private endpoint connection management.

Commands

Name	Description	Type	Status
az iot du account private-endpoint-connection delete	Delete a private endpoint connection associated with a Device Update account.	Extension	GA
az iot du account private-endpoint-connection list	List private endpoint connections associated with a Device Update account.	Extension	GA
az iot du account private-endpoint-connection set	Set the state of a private endpoint connection associated with a Device Update account.	Extension	GA
az iot du account private-endpoint-connection show	Show a private endpoint connection associated with a Device Update account.	Extension	GA

az iot du account private-endpoint-connection delete

Delete a private endpoint connection associated with a Device Update account.

az iot du account private-endpoint-connection delete --account
                                                     --cn --conn-name
                                                     [--resource-group]
                                                     [--yes {false, true}]

Examples

Delete a private endpoint connection associated with a target account.

az iot du account private-endpoint-connection delete -n {account_name} --cn {connection_name}

Required Parameters

--account -n

Device Update account name. You can configure the default account name using az config set defaults.adu_account={name}.

Property	Value
Parameter group:	Account Identifier Arguments

--cn --conn-name

Private endpoint connection 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

Device Update account resource group name. You can configure the default group using az config set defaults.adu_group={name}.

Property	Value
Parameter group:	Account Identifier Arguments

--yes -y

Skip user prompts. Indicates acceptance of action. Used primarily for automation scenarios. Default: false.

Property	Value
Accepted values:	false, true

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 iot du account private-endpoint-connection list

List private endpoint connections associated with a Device Update account.

az iot du account private-endpoint-connection list --account
                                                   [--resource-group]

Examples

List all private endpoint connections for a target account.

az iot du account private-endpoint-connection list -n {account_name}

Required Parameters

--account -n

Device Update account name. You can configure the default account name using az config set defaults.adu_account={name}.

Property	Value
Parameter group:	Account Identifier 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

Device Update account resource group name. You can configure the default group using az config set defaults.adu_group={name}.

Property	Value
Parameter group:	Account Identifier 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

az iot du account private-endpoint-connection set

Set the state of a private endpoint connection associated with a Device Update account.

az iot du account private-endpoint-connection set --account
                                                  --cn --conn-name
                                                  --status {Approved, Pending, Rejected}
                                                  [--desc]
                                                  [--resource-group]

Examples

Approve a private endpoint connection request on the target account.

az iot du account private-endpoint-connection set -n {account_name} --cn {connection_name} --status Approved --desc "For reasons."

Required Parameters

--account -n

Device Update account name. You can configure the default account name using az config set defaults.adu_account={name}.

Property	Value
Parameter group:	Account Identifier Arguments

--cn --conn-name

Private endpoint connection name.

--status

The status of the private endpoint connection.

Property	Value
Accepted values:	Approved, Pending, Rejected

Optional Parameters

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

--desc

The reason for approval/rejection of the connection.

--resource-group -g

Device Update account resource group name. You can configure the default group using az config set defaults.adu_group={name}.

Property	Value
Parameter group:	Account Identifier 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

az iot du account private-endpoint-connection show

Show a private endpoint connection associated with a Device Update account.

az iot du account private-endpoint-connection show --account
                                                   --cn --conn-name
                                                   [--resource-group]

Examples

Show a private endpoint connection associated with a target account.

az iot du account private-endpoint-connection show -n {account_name} --cn {connection_name}

Required Parameters

--account -n

Device Update account name. You can configure the default account name using az config set defaults.adu_account={name}.

Property	Value
Parameter group:	Account Identifier Arguments

--cn --conn-name

Private endpoint connection 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

Device Update account resource group name. You can configure the default group using az config set defaults.adu_group={name}.

Property	Value
Parameter group:	Account Identifier 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