az horizondb cluster
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 command. Learn more about extensions.
Command group 'az horizondb' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Manage HorizonDB Cluster.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| az horizondb cluster create |
Create a HorizonDB cluster. |
Extension | Preview |
| az horizondb cluster delete |
Delete a HorizonDB cluster. |
Extension | Preview |
| az horizondb cluster list |
List HorizonDB clusters. |
Extension | Preview |
| az horizondb cluster pool |
Manage HorizonDB Pool. |
Extension | Preview |
| az horizondb cluster pool create |
Create a new HorizonDB pool. |
Extension | Preview |
| az horizondb cluster pool delete |
Delete a HorizonDB pool. |
Extension | Preview |
| az horizondb cluster pool firewall-rule |
Manage Firewall Rule. |
Extension | Preview |
| az horizondb cluster pool firewall-rule create |
Create a HorizonDB pool firewall rule. |
Extension | Preview |
| az horizondb cluster pool firewall-rule delete |
Delete a HorizonDB pool firewall rule. |
Extension | Preview |
| az horizondb cluster pool firewall-rule list |
List all HorizonDB firewall rules in a pool. |
Extension | Preview |
| az horizondb cluster pool firewall-rule show |
Get information about a HorizonDB pool firewall rule. |
Extension | Preview |
| az horizondb cluster pool firewall-rule update |
Update a HorizonDB pool firewall rule. |
Extension | Preview |
| az horizondb cluster pool firewall-rule wait |
Place the CLI in a waiting state until a condition is met. |
Extension | Preview |
| az horizondb cluster pool list |
List all HorizonDB pools in a cluster. |
Extension | Preview |
| az horizondb cluster pool show |
Get information about a HorizonDB pool. |
Extension | Preview |
| az horizondb cluster pool update |
Update an existing HorizonDB pool. |
Extension | Preview |
| az horizondb cluster pool wait |
Place the CLI in a waiting state until a condition is met. |
Extension | Preview |
| az horizondb cluster private-endpoint-connection |
Manage Private Endpoint Connection. |
Extension | Preview |
| 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-link-resource |
Manage Private Link Resource. |
Extension | Preview |
| az horizondb cluster private-link-resource list |
List private link resources in a HorizonDB cluster. |
Extension | Preview |
| az horizondb cluster private-link-resource show |
Get a private link resource. |
Extension | Preview |
| az horizondb cluster restore |
Restore a HorizonDB cluster to a point in time. |
Extension | Preview |
| az horizondb cluster show |
Get information about a HorizonDB cluster. |
Extension | Preview |
| az horizondb cluster update |
Update an existing HorizonDB cluster. |
Extension | Preview |
| az horizondb cluster wait |
Place the CLI in a waiting state until a condition is met. |
Extension | Preview |
az horizondb cluster create
Command group 'az horizondb cluster' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Create a HorizonDB cluster.
Waits for cluster provisioning and retrieves the cluster to return its current state.
az horizondb cluster create --cluster-name --name
--resource-group
[--acquire-policy-token]
[--backup-retention-days --retention-days]
[--change-reference]
[--geo-redundancy {Disabled, Enabled}]
[--location]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--primary-key-uri]
[--primary-user-assigned-identity-id --primary-user-id]
[--public-access {Disabled, Enabled}]
[--tags]
[--version {17, 18}]
Examples
Create a HorizonDB cluster
az horizondb cluster create --resource-group example-resource-group --cluster-name example-cluster --location eastus2 --version 17 --geo-redundancy Enabled
Required Parameters
The name of the HorizonDB cluster.
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.
Acquiring an Azure Policy token automatically for this resource operation.
| Property | Value |
|---|---|
| Parameter group: | Global Policy Arguments |
The number of days that automatic backups are retained. The service defaults to 7 days when this property is omitted.
| Property | Value |
|---|---|
| Parameter group: | Backup Arguments |
| Default value: | 7 |
The related change reference ID for this resource operation.
| Property | Value |
|---|---|
| Parameter group: | Global Policy Arguments |
The geo-redundancy state. When creationMode is PointInTimeRestore, the service ignores the requested value during cluster creation and configures the new cluster with the same geo-redundancy setting as the source cluster, for both same-location and cross-location restores. The response reports the inherited setting. Geo-redundant backup is not supported when dataEncryption.type is AzureKeyVault.
| Property | Value |
|---|---|
| Parameter group: | Backup Arguments |
| Accepted values: | Disabled, Enabled |
The geo-location where the resource lives When not specified, the location of the resource group will be used.
| Property | Value |
|---|---|
| Parameter group: | Resource Arguments |
Do not wait for the long-running operation to finish.
| Property | Value |
|---|---|
| Accepted values: | 0, 1, f, false, n, no, t, true, y, yes |
Versionless Azure Key Vault key URI. Must be supplied together with --primary-user-assigned-identity-id to enable data encryption.
| Property | Value |
|---|---|
| Parameter group: | DataEncryption Arguments |
Resource ID of the user-assigned managed identity used to access the encryption key. Must be supplied together with --primary-key-uri.
| Property | Value |
|---|---|
| Parameter group: | DataEncryption Arguments |
Specifies whether public access is enabled for the cluster. The service defaults to Disabled when this property is omitted.
| Property | Value |
|---|---|
| Parameter group: | Network Arguments |
| Default value: | Disabled |
| Accepted values: | Disabled, Enabled |
Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
| Property | Value |
|---|---|
| Parameter group: | Resource Arguments |
The PostgreSQL major version used by the HorizonDB cluster. API version 2026-10-01-preview supports versions 17 and 18. For ordinary cluster creation, the version is supplied in the request and is immutable after creation. For point-in-time restore, the service obtains the version from the source backup metadata and the request must omit this property. This API version does not support in-place PostgreSQL major-version upgrades.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
| Accepted values: | 17, 18 |
Global Parameters
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |
az horizondb cluster delete
Command group 'az horizondb cluster' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Delete a HorizonDB cluster.
az horizondb cluster delete [--acquire-policy-token]
[--change-reference]
[--cluster-name --name]
[--ids]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]
[--yes]
Examples
Delete a HorizonDB cluster
az horizon-db cluster delete --resource-group example-resource-group --cluster-name example-cluster
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Acquiring an Azure Policy token automatically for this resource operation.
| Property | Value |
|---|---|
| Parameter group: | Global Policy Arguments |
The related change reference ID for this resource operation.
| Property | Value |
|---|---|
| Parameter group: | Global Policy Arguments |
The name of the HorizonDB cluster.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
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 |
Do not wait for the long-running operation to finish.
| Property | Value |
|---|---|
| Accepted values: | 0, 1, f, false, n, no, t, true, y, yes |
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
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 |
Do not prompt for confirmation.
| Property | Value |
|---|---|
| Default value: | False |
Global Parameters
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |
az horizondb cluster list
Command group 'az horizondb cluster' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
List HorizonDB clusters.
az horizondb cluster list [--max-items]
[--next-token]
[--resource-group]
Examples
List HorizonDB clusters in a resource group
az horizondb cluster list --resource-group example-resource-group
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
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 |
Token to specify where to start paginating. This is the token value from a previously truncated response.
| Property | Value |
|---|---|
| Parameter group: | Pagination Arguments |
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Global Parameters
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |
az horizondb cluster restore
Command group 'az horizondb cluster' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Restore a HorizonDB cluster to a point in time.
Inherits unspecified cluster settings from the source cluster, waits for provisioning, and retrieves the restored cluster.
az horizondb cluster restore --cluster-name --name
--creation-source-cluster-resource-id --source-cluster-id
--resource-group
[--acquire-policy-token]
[--change-reference]
[--location]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--point-in-time-utc]
[--primary-key-uri]
[--primary-user-assigned-identity-id --primary-user-id]
[--public-access {Disabled, Enabled}]
[--tags]
Examples
Restore a HorizonDB cluster to a specified UTC time
az horizondb cluster restore --resource-group example-resource-group --cluster-name restored-cluster --source-cluster-id /subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/source-resource-group/providers/Microsoft.HorizonDb/clusters/source-cluster --point-in-time-utc 2026-07-27T12:00:00Z
Required Parameters
The name of the HorizonDB cluster.
Resource ID of the source HorizonDB cluster.
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.
Acquiring an Azure Policy token automatically for this resource operation.
| Property | Value |
|---|---|
| Parameter group: | Global Policy Arguments |
The related change reference ID for this resource operation.
| Property | Value |
|---|---|
| Parameter group: | Global Policy Arguments |
Location of the restored cluster. Can only be specified for a geo-redundant restore when the source cluster has geo-redundancy enabled. Defaults to the source cluster location.
| Property | Value |
|---|---|
| Parameter group: | Resource Arguments |
Do not wait for the long-running operation to finish.
| Property | Value |
|---|---|
| Accepted values: | 0, 1, f, false, n, no, t, true, y, yes |
UTC restore time, for example 2026-07-27T12:00:00Z. Defaults to five minutes before the current UTC time.
Versionless Azure Key Vault key URI. Must be supplied together with --primary-user-assigned-identity-id to enable data encryption.
| Property | Value |
|---|---|
| Parameter group: | DataEncryption Arguments |
Resource ID of the user-assigned managed identity used to access the encryption key. Must be supplied together with --primary-key-uri.
| Property | Value |
|---|---|
| Parameter group: | DataEncryption Arguments |
Specifies whether public access is enabled for the cluster. The service defaults to Disabled when this property is omitted.
| Property | Value |
|---|---|
| Parameter group: | Network Arguments |
| Accepted values: | Disabled, Enabled |
Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
| Property | Value |
|---|---|
| Parameter group: | Resource Arguments |
Global Parameters
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |
az horizondb cluster show
Command group 'az horizondb cluster' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Get information about a HorizonDB cluster.
az horizondb cluster show [--cluster-name --name]
[--ids]
[--resource-group]
[--subscription]
Examples
Get a HorizonDB cluster
az horizondb cluster show --resource-group example-resource-group --cluster-name example-cluster
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
The name of the HorizonDB cluster.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
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 of resource group. You can configure the default group using az configure --defaults group=<name>.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
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
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |
az horizondb cluster update
Command group 'az horizondb cluster' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Update an existing HorizonDB cluster.
az horizondb cluster update [--acquire-policy-token]
[--ai-model-management {Disabled, Enabled}]
[--backup-retention-days]
[--change-reference]
[--cluster-name --name]
[--ids]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--primary-key-uri]
[--primary-user-assigned-identity-id --primary-user-id]
[--public-access {Disabled, Enabled}]
[--resource-group]
[--subscription]
[--tags]
Examples
Rotate the customer-managed key used by a HorizonDB cluster
az horizondb cluster update --resource-group example-resource-group --cluster-name example-cluster --primary-key-uri https://example.vault.azure.net/keys/new-key
Update the managed identity used to access the encryption key
az horizondb cluster update --resource-group example-resource-group --cluster-name example-cluster --primary-user-id /subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/example-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/example-identity
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Acquiring an Azure Policy token automatically for this resource operation.
| Property | Value |
|---|---|
| Parameter group: | Global Policy Arguments |
Specifies whether AI Model Management is enabled for the cluster.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
| Accepted values: | Disabled, Enabled |
The number of days that automatic backups are retained.
| Property | Value |
|---|---|
| Parameter group: | Backup Arguments |
The related change reference ID for this resource operation.
| Property | Value |
|---|---|
| Parameter group: | Global Policy Arguments |
The name of the HorizonDB cluster.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
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 |
Do not wait for the long-running operation to finish.
| Property | Value |
|---|---|
| Accepted values: | 0, 1, f, false, n, no, t, true, y, yes |
The versionless Azure Key Vault key URI used to encrypt the cluster's primary storage. Key version paths are not supported. During initial cluster creation, this property can be provided together with primaryUserAssignedIdentityId. For updates to an existing cluster through PUT or PATCH, this property and primaryUserAssignedIdentityId cannot both change in the same request; the first update must complete before submitting a separate update for the other property.
| Property | Value |
|---|---|
| Parameter group: | DataEncryption Arguments |
The Azure resource ID of the user-assigned managed identity used to access the primary encryption key. The identity must also be assigned to the Cluster through its top-level identity property. During initial cluster creation, this property can be provided together with primaryKeyUri. For updates to an existing cluster through PUT or PATCH, this property and primaryKeyUri cannot both change in the same request; the first update must complete before submitting a separate update for the other property.
| Property | Value |
|---|---|
| Parameter group: | DataEncryption Arguments |
Specifies whether public access is enabled for the cluster. Omission preserves the current value.
| Property | Value |
|---|---|
| Parameter group: | Network Arguments |
| Accepted values: | Disabled, Enabled |
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
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 |
Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
Global Parameters
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |
az horizondb cluster wait
Command group 'az horizondb cluster' 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 wait [--acquire-policy-token]
[--change-reference]
[--cluster-name --name]
[--created]
[--custom]
[--deleted]
[--exists]
[--ids]
[--interval]
[--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.
Acquiring an Azure Policy token automatically for this resource operation.
| Property | Value |
|---|---|
| Parameter group: | Global Policy Arguments |
The related change reference ID for this resource operation.
| Property | Value |
|---|---|
| Parameter group: | Global Policy Arguments |
The name of the HorizonDB cluster.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Wait until created with 'provisioningState' at 'Succeeded'.
| Property | Value |
|---|---|
| Parameter group: | Wait Condition Arguments |
| Default value: | False |
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 |
Wait until deleted.
| Property | Value |
|---|---|
| Parameter group: | Wait Condition Arguments |
| Default value: | False |
Wait until the resource exists.
| Property | Value |
|---|---|
| Parameter group: | Wait Condition Arguments |
| Default value: | False |
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 |
Polling interval in seconds.
| Property | Value |
|---|---|
| Parameter group: | Wait Condition Arguments |
| Default value: | 30 |
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
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 |
Maximum wait in seconds.
| Property | Value |
|---|---|
| Parameter group: | Wait Condition Arguments |
| Default value: | 3600 |
Wait until updated with provisioningState at 'Succeeded'.
| Property | Value |
|---|---|
| Parameter group: | Wait Condition Arguments |
| Default value: | False |
Global Parameters
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |