Share via

az iot central app private-endpoint-connection

  • Reference

Manage private endpoint connection of IoT Central application.

Commands

Name Description Type Status
az iot central app private-endpoint-connection approve

Approve a private endpoint connection request for an IoT Central application.

 Core GA
az iot central app private-endpoint-connection delete

Delete a private endpoint connection for an IoT Central application.

 Core GA
az iot central app private-endpoint-connection list

List all of the private endpoint connections for an IoT Central application.

 Core GA
az iot central app private-endpoint-connection reject

Reject a private endpoint connection request for an IoT Central application.

 Core GA
az iot central app private-endpoint-connection show

Show details of a private endpoint connection request for an IoT Central application.

 Core GA

az iot central app private-endpoint-connection approve

Edit

Approve a private endpoint connection request for an IoT Central application.

az iot central app private-endpoint-connection approve [--account-name]
                                                       [--description]
                                                       [--id]
                                                       [--name]
                                                       [--resource-group]

Examples

Approve a private endpoint connection request for an IoT Central application by ID.

az iot central app private-endpoint-connection approve --id "/subscriptions/0000-0000-0000-0000/resourceGroups/MyResourceGroup/providers/Microsoft.IoTCentral/IoTApps/my-iotc-app/privateEndpointConnections/my-iotc-app.b56b5a95-0588-4f8b-b348-15db61590a6c"

Approve a private endpoint connection request for an IoT Central application by ID.

id = (az iot central app show -n my-iotc-app --query "privateEndpointConnections[0].id")
az iot central app private-endpoint-connection approve --id $id

Approve a private endpoint connection request for an IoT Central application using account name and connection name.

az iot central app private-endpoint-connection approve -g myRg --account-name my-iotc-app --name myconnection

Approve a private endpoint connection request for an IoT Central application using account name and connection name.

name = (az iot central app show -n my-iotc-app --query "privateEndpointConnections[0].name")
az iot central app private-endpoint-connection approve -g myRg --account-name my-iotc-app --name $name

Optional Parameters

--account-name

Name of the IoT Central application. Required if --id is not specified.

--description

Comments for the approve operation.

--id

The ID of the private endpoint connection associated with the IoT Central application. If --account-name --resource-group/-g and --name/-n are specified, this should be omitted.

--name -n

The name of the private endpoint connection associated with IoT Central application. Required if --id is not specified.

--resource-group -g

The resource group name of specified IoT Central application. Required if --id is not specified.

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 iot central app private-endpoint-connection delete

Edit

Delete a private endpoint connection for an IoT Central application.

az iot central app private-endpoint-connection delete [--account-name]
                                                      [--id]
                                                      [--name]
                                                      [--resource-group]
                                                      [--yes]

Examples

Delete a private endpoint connection for an IoT Central application by ID.

az iot central app private-endpoint-connection delete --id "/subscriptions/0000-0000-0000-0000/resourceGroups/MyResourceGroup/providers/Microsoft.IoTCentral/IoTApps/my-iotc-app/privateEndpointConnections/my-iotc-app.b56b5a95-0588-4f8b-b348-15db61590a6c"

Delete a private endpoint connection for an IoT Central application by ID.

id = (az iot central app show -n my-iotc-app --query "privateEndpointConnections[0].id")
az iot central app private-endpoint-connection delete --id $id

Delete a private endpoint connection for an IoT Central application using account name and connection name.

az iot central app private-endpoint-connection delete -g myRg --account-name my-iotc-app --name myconnection

Delete a private endpoint connection for an IoT Central application using account name and connection name.

name = (az iot central app show -n my-iotc-app --query "privateEndpointConnections[0].name")
az iot central app private-endpoint-connection delete -g myRg --account-name my-iotc-app --name $name

Optional Parameters

--account-name

Name of the IoT Central application. Required if --id is not specified.

--id

The ID of the private endpoint connection associated with the IoT Central application. If --account-name --resource-group/-g and --name/-n are specified, this should be omitted.

--name -n

The name of the private endpoint connection associated with IoT Central application. Required if --id is not specified.

--resource-group -g

The resource group name of specified IoT Central application. Required if --id is not specified.

--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 iot central app private-endpoint-connection list

Edit

List all of the private endpoint connections for an IoT Central application.

az iot central app private-endpoint-connection list [--account-name]
                                                    [--id]
                                                    [--resource-group]

Examples

List all of the private endpoint connections in the IoT Central application given the resource group and application name.

az iot central app private-endpoint-connection list -g MyResourceGroup --account-name my-iotc-app

List all of the private endpoint connections in the IoT Central application given a connection id

az iot central app private-endpoint-connection list --id "/subscriptions/0000-0000-0000-0000/resourceGroups/MyResourceGroup/providers/Microsoft.IoTCentral/IoTApps/my-iotc-app/privateEndpointConnections/my-iotc-app.b56b5a95-0588-4f8b-b348-15db61590a6c"

Optional Parameters

--account-name

Name of the IoT Central application. Required if --id is not specified.

--id

ID of the resource.

--resource-group -g

Name of resource group. If provided, --name must be provided too.

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 iot central app private-endpoint-connection reject

Edit

Reject a private endpoint connection request for an IoT Central application.

az iot central app private-endpoint-connection reject [--account-name]
                                                      [--description]
                                                      [--id]
                                                      [--name]
                                                      [--resource-group]

Examples

Reject a private endpoint connection request for an IoT Central application by ID.

az iot central app private-endpoint-connection reject --id "/subscriptions/0000-0000-0000-0000/resourceGroups/MyResourceGroup/providers/Microsoft.IoTCentral/IoTApps/my-iotc-app/privateEndpointConnections/my-iotc-app.b56b5a95-0588-4f8b-b348-15db61590a6c"

Reject a private endpoint connection request for an IoT Central application by ID.

id = (az iot central app show -n my-iotc-app --query "privateEndpointConnections[0].id")
az iot central app private-endpoint-connection reject --id $id

Reject a private endpoint connection request for an IoT Central application app using account name and connection name.

az iot central app private-endpoint-connection reject -g myRg --account-name my-iotc-app --name myconnection

Reject a private endpoint connection request for an IoT Central application using account name and connection name.

name = (az iot central app show -n my-iotc-app --query "privateEndpointConnections[0].name")
az iot central app private-endpoint-connection reject -g myRg --account-name my-iotc-app --name $name

Optional Parameters

--account-name

Name of the IoT Central application. Required if --id is not specified.

--description

Comments for the reject operation.

--id

The ID of the private endpoint connection associated with the IoT Central application. If --account-name --resource-group/-g and --name/-n are specified, this should be omitted.

--name -n

The name of the private endpoint connection associated with IoT Central application. Required if --id is not specified.

--resource-group -g

The resource group name of specified IoT Central application. Required if --id is not specified.

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 iot central app private-endpoint-connection show

Edit

Show details of a private endpoint connection request for an IoT Central application.

az iot central app private-endpoint-connection show [--account-name]
                                                    [--id]
                                                    [--name]
                                                    [--resource-group]

Examples

Show details of a private endpoint connection request for an IoT Central application by ID.

az iot central app private-endpoint-connection show --id "/subscriptions/0000-0000-0000-0000/resourceGroups/MyResourceGroup/providers/Microsoft.IoTCentral/IoTApps/my-iotc-app/privateEndpointConnections/my-iotc-app.b56b5a95-0588-4f8b-b348-15db61590a6c"

Show details of a private endpoint connection request for an IoT Central application by ID.

id = (az iot central app show -n my-iotc-app --query "privateEndpointConnections[0].id")
az iot central app private-endpoint-connection show --id $id

Show details of a private endpoint connection request for an IoT Central application using account name and connection name.

az iot central app private-endpoint-connection show -g myRg --account-name my-iotc-app --name myconnection

Show details of a private endpoint connection request for an IoT Central application using account name and connection name.

name = (az iot central app show -n my-iotc-app --query "privateEndpointConnections[0].name")
az iot central app private-endpoint-connection show -g myRg --account-name my-iotc-app --name $name

Optional Parameters

--account-name

Name of the IoT Central application. Required if --id is not specified.

--id

The ID of the private endpoint connection associated with the IoT Central application. If --account-name --resource-group/-g and --name/-n are specified, this should be omitted.

--name -n

The name of the private endpoint connection associated with IoT Central application. Required if --id is not specified.

--resource-group -g

The resource group name of specified IoT Central application. Required if --id is not specified.

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.