az horizondb private-endpoint-connection

Note

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

Manage HorizonDB private endpoint connections.

Commands

Name	Description	Type	Status
az horizondb private-endpoint-connection approve	Approve a HorizonDB private endpoint connection.	Extension	GA
az horizondb private-endpoint-connection delete	Delete a HorizonDB private endpoint connection.	Extension	GA
az horizondb private-endpoint-connection list	List private endpoint connections for a HorizonDB cluster.	Extension	GA
az horizondb private-endpoint-connection reject	Reject a HorizonDB private endpoint connection.	Extension	GA
az horizondb private-endpoint-connection show	Show details of a HorizonDB private endpoint connection.	Extension	GA

az horizondb private-endpoint-connection approve

Approve a HorizonDB private endpoint connection.

az horizondb private-endpoint-connection approve --description
                                                 [--acquire-policy-token]
                                                 [--change-reference]
                                                 [--cluster-name]
                                                 [--id]
                                                 [--name]
                                                 [--resource-group]

Examples

Approve a private endpoint connection by cluster and connection name.

az horizondb private-endpoint-connection approve --resource-group exampleresourcegroup --cluster-name examplecluster --name exampleconnection --description "Approved"

Approve a private endpoint connection by resource ID.

az horizondb private-endpoint-connection approve --id /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.HorizonDb/clusters/{clusterName}/privateEndpointConnections/{connectionName} --description "Approved"

Required Parameters

--description -d

Comments for the approval or rejection.

Optional Parameters

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--cluster-name -c

Name of the cluster. The name can contain only lowercase letters, numbers, and the hyphen (-) character. Minimum 3 characters and maximum 63 characters.

--id

The resource ID of the private endpoint connection associated with the HorizonDB cluster. If specified --cluster-name/-c and --name/-n, this should be omitted.

--name -n

The name of the private endpoint connection associated with the HorizonDB cluster. Required if --id is not specified.

--resource-group -g

Name of 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 horizondb private-endpoint-connection delete

Delete a HorizonDB private endpoint connection.

az horizondb private-endpoint-connection delete [--acquire-policy-token]
                                                [--change-reference]
                                                [--cluster-name]
                                                [--id]
                                                [--name]
                                                [--resource-group]

Examples

Delete a private endpoint connection by cluster and connection name.

az horizondb private-endpoint-connection delete --resource-group exampleresourcegroup --cluster-name examplecluster --name exampleconnection

Delete a private endpoint connection by resource ID.

az horizondb private-endpoint-connection delete --id /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.HorizonDb/clusters/{clusterName}/privateEndpointConnections/{connectionName}

Optional Parameters

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--cluster-name -c

Name of the cluster. The name can contain only lowercase letters, numbers, and the hyphen (-) character. Minimum 3 characters and maximum 63 characters.

--id

The resource ID of the private endpoint connection associated with the HorizonDB cluster. If specified --cluster-name/-c and --name/-n, this should be omitted.

--name -n

The name of the private endpoint connection associated with the HorizonDB cluster. Required if --id is not specified.

--resource-group -g

Name of 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 horizondb private-endpoint-connection list

List private endpoint connections for a HorizonDB cluster.

az horizondb private-endpoint-connection list --cluster-name
                                              --resource-group

Examples

List private endpoint connections for a HorizonDB cluster.

az horizondb private-endpoint-connection list --resource-group exampleresourcegroup --cluster-name examplecluster

Required Parameters

--cluster-name -c

Name of the cluster. The name can contain only lowercase letters, numbers, and the hyphen (-) character. Minimum 3 characters and maximum 63 characters.

--resource-group -g

Name of 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 horizondb private-endpoint-connection reject

Reject a HorizonDB private endpoint connection.

az horizondb private-endpoint-connection reject --description
                                                [--acquire-policy-token]
                                                [--change-reference]
                                                [--cluster-name]
                                                [--id]
                                                [--name]
                                                [--resource-group]

Examples

Reject a private endpoint connection by cluster and connection name.

az horizondb private-endpoint-connection reject --resource-group exampleresourcegroup --cluster-name examplecluster --name exampleconnection --description "Rejected"

Reject a private endpoint connection by resource ID.

az horizondb private-endpoint-connection reject --id /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.HorizonDb/clusters/{clusterName}/privateEndpointConnections/{connectionName} --description "Rejected"

Required Parameters

--description -d

Comments for the approval or rejection.

Optional Parameters

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--cluster-name -c

Name of the cluster. The name can contain only lowercase letters, numbers, and the hyphen (-) character. Minimum 3 characters and maximum 63 characters.

--id

The resource ID of the private endpoint connection associated with the HorizonDB cluster. If specified --cluster-name/-c and --name/-n, this should be omitted.

--name -n

The name of the private endpoint connection associated with the HorizonDB cluster. Required if --id is not specified.

--resource-group -g

Name of 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 horizondb private-endpoint-connection show

Show details of a HorizonDB private endpoint connection.

az horizondb private-endpoint-connection show [--cluster-name]
                                              [--id]
                                              [--name]
                                              [--resource-group]

Examples

Show a private endpoint connection by cluster and connection name.

az horizondb private-endpoint-connection show --resource-group exampleresourcegroup --cluster-name examplecluster --name exampleconnection

Show a private endpoint connection by resource ID.

az horizondb private-endpoint-connection show --id /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.HorizonDb/clusters/{clusterName}/privateEndpointConnections/{connectionName}

Optional Parameters

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

--cluster-name -c

Name of the cluster. The name can contain only lowercase letters, numbers, and the hyphen (-) character. Minimum 3 characters and maximum 63 characters.

--id

The resource ID of the private endpoint connection associated with the HorizonDB cluster. If specified --cluster-name/-c and --name/-n, this should be omitted.

--name -n

The name of the private endpoint connection associated with the HorizonDB cluster. Required if --id is not specified.

--resource-group -g

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