az horizondb cluster 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 cluster private-endpoint-connection command. Learn more about extensions.

Command group 'az horizondb cluster' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage Private Endpoint Connection.

Commands

Name Description Type Status
az horizondb cluster private-endpoint-connection delete

Delete a private endpoint connection.

Extension Preview
az horizondb cluster private-endpoint-connection list

List private endpoint connections in a HorizonDB cluster.

Extension Preview
az horizondb cluster private-endpoint-connection show

Get a private endpoint connection.

Extension Preview
az horizondb cluster private-endpoint-connection update

Update an existing private endpoint connection.

Extension Preview
az horizondb cluster private-endpoint-connection wait

Place the CLI in a waiting state until a condition is met.

Extension Preview

az horizondb cluster private-endpoint-connection delete

Preview

Command group 'az horizondb cluster private-endpoint-connection' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Delete a private endpoint connection.

az horizondb cluster private-endpoint-connection delete [--acquire-policy-token]
                                                        [--change-reference]
                                                        [--cluster-name]
                                                        [--ids]
                                                        [--name --private-endpoint-connection-name]
                                                        [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                        [--resource-group]
                                                        [--subscription]
                                                        [--yes]

Examples

Delete a private endpoint connection

az horizondb cluster private-endpoint-connection delete --resource-group example-resource-group --cluster-name example-cluster --private-endpoint-connection-name example-private-endpoint-connection

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

The name of the HorizonDB cluster.

Property Value
Parameter group: Resource Id Arguments
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--name --private-endpoint-connection-name -n

The name of the private endpoint connection associated with the Azure resource.

Property Value
Parameter group: Resource Id Arguments
--no-wait

Do not wait for the long-running operation to finish.

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
--yes -y

Do not prompt for confirmation.

Property Value
Default value: False
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.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az horizondb cluster private-endpoint-connection list

Preview

Command group 'az horizondb cluster private-endpoint-connection' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List private endpoint connections in a HorizonDB cluster.

az horizondb cluster private-endpoint-connection list --cluster-name
                                                      --resource-group
                                                      [--max-items]
                                                      [--next-token]

Required Parameters

--cluster-name

The name of the HorizonDB cluster.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<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.

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

Property Value
Parameter group: Pagination Arguments
--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

Property Value
Parameter group: Pagination 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 horizondb cluster private-endpoint-connection show

Preview

Command group 'az horizondb cluster private-endpoint-connection' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Get a private endpoint connection.

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

Examples

Get a private endpoint connection

az horizondb cluster private-endpoint-connection show --resource-group example-resource-group --cluster-name example-cluster --private-endpoint-connection-name example-private-endpoint-connection

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

The name of the HorizonDB cluster.

Property Value
Parameter group: Resource Id Arguments
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--name --private-endpoint-connection-name -n

The name of the private endpoint connection associated with the Azure resource.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id 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.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az horizondb cluster private-endpoint-connection update

Preview

Command group 'az horizondb cluster private-endpoint-connection' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update an existing private endpoint connection.

az horizondb cluster private-endpoint-connection update [--acquire-policy-token]
                                                        [--actions-required]
                                                        [--add]
                                                        [--change-reference]
                                                        [--cluster-name]
                                                        [--description]
                                                        [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                                        [--ids]
                                                        [--name --private-endpoint-connection-name]
                                                        [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                        [--remove]
                                                        [--resource-group]
                                                        [--set]
                                                        [--status {Approved, Pending, Rejected}]
                                                        [--subscription]

Examples

Approve or reject a private endpoint connection

az horizondb cluster private-endpoint-connection update --resource-group example-resource-group --cluster-name example-cluster --private-endpoint-connection-name example-private-endpoint-connection --status Approved --description Approved for the production database network

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

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

Property Value
Parameter group: PrivateLinkServiceConnectionState Arguments
--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

Property Value
Parameter group: Generic Update Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--cluster-name

The name of the HorizonDB cluster.

Property Value
Parameter group: Resource Id Arguments
--description

The reason for approval/rejection of the connection.

Property Value
Parameter group: PrivateLinkServiceConnectionState Arguments
--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Property Value
Parameter group: Generic Update Arguments
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--name --private-endpoint-connection-name -n

The name of the private endpoint connection associated with the Azure resource.

Property Value
Parameter group: Resource Id Arguments
--no-wait

Do not wait for the long-running operation to finish.

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Property Value
Parameter group: Generic Update Arguments
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

Property Value
Parameter group: Generic Update Arguments
--status

Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.

Property Value
Parameter group: PrivateLinkServiceConnectionState Arguments
Accepted values: Approved, Pending, Rejected
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id 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.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az horizondb cluster private-endpoint-connection wait

Preview

Command group 'az horizondb cluster private-endpoint-connection' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Place the CLI in a waiting state until a condition is met.

az horizondb cluster private-endpoint-connection wait [--acquire-policy-token]
                                                      [--change-reference]
                                                      [--cluster-name]
                                                      [--created]
                                                      [--custom]
                                                      [--deleted]
                                                      [--exists]
                                                      [--ids]
                                                      [--interval]
                                                      [--name --private-endpoint-connection-name]
                                                      [--resource-group]
                                                      [--subscription]
                                                      [--timeout]
                                                      [--updated]

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

The name of the HorizonDB cluster.

Property Value
Parameter group: Resource Id Arguments
--created

Wait until created with 'provisioningState' at 'Succeeded'.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Property Value
Parameter group: Wait Condition Arguments
--deleted

Wait until deleted.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--exists

Wait until the resource exists.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--interval

Polling interval in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 30
--name --private-endpoint-connection-name -n

The name of the private endpoint connection associated with the Azure resource.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
--timeout

Maximum wait in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
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.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False