az horizondb

Commands

Name	Description	Type	Status
az horizondb create	Create a new Azure HorizonDB cluster.	Extension	GA
az horizondb delete	Delete an Azure HorizonDB cluster.	Extension	GA
az horizondb firewall-rule	Manage firewall rules for an Azure HorizonDB cluster.	Extension	GA
az horizondb firewall-rule create	Create a firewall rule for an Azure HorizonDB cluster.	Extension	GA
az horizondb firewall-rule delete	Delete a firewall rule for an Azure HorizonDB cluster.	Extension	GA
az horizondb firewall-rule list	List the firewall rules for an Azure HorizonDB cluster.	Extension	GA
az horizondb firewall-rule show	Show the details of a firewall rule for an Azure HorizonDB cluster.	Extension	GA
az horizondb firewall-rule update	Update a firewall rule for an Azure HorizonDB cluster.	Extension	GA
az horizondb list	List Azure HorizonDB clusters.	Extension	GA
az horizondb parameter-group	Manage Azure HorizonDB parameter groups.	Extension	GA
az horizondb parameter-group create	Create a new Azure HorizonDB parameter group.	Extension	GA
az horizondb parameter-group delete	Delete an Azure HorizonDB parameter group.	Extension	GA
az horizondb parameter-group list	List Azure HorizonDB parameter groups.	Extension	GA
az horizondb parameter-group list-connections	List Azure HorizonDB clusters connected to a parameter group.	Extension	GA
az horizondb parameter-group show	Show details of an Azure HorizonDB parameter group.	Extension	GA
az horizondb private-endpoint-connection	Manage HorizonDB private endpoint connections.	Extension	GA
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-link-resource	Manage HorizonDB private link resources.	Extension	GA
az horizondb private-link-resource list	List private link resources for a HorizonDB cluster.	Extension	GA
az horizondb private-link-resource show	Show details of a HorizonDB private link resource.	Extension	GA
az horizondb show	Show details of an Azure HorizonDB cluster.	Extension	GA
az horizondb update	Update an existing Azure HorizonDB cluster.	Extension	GA

az horizondb create --administrator-login
                    --administrator-login-password
                    [--acquire-policy-token]
                    [--change-reference]
                    [--location]
                    [--name]
                    [--public-access]
                    [--replica-count]
                    [--resource-group]
                    [--tags]
                    [--v-cores]
                    [--version]
                    [--yes]
                    [--zone-placement-policy {BestEffort, Strict}]

Examples

Create a new HorizonDB cluster.

az horizondb create --name examplecluster --resource-group exampleresourcegroup --location centralus --administrator-login myadmin --administrator-login-password examplepassword --version 17 --v-cores 4 --replica-count 3

Create a HorizonDB cluster with zone placement policy.

az horizondb create --name examplecluster --resource-group exampleresourcegroup --location centralus --administrator-login myadmin --administrator-login-password examplepassword --version 17 --v-cores 4 --replica-count 3 --zone-placement-policy Strict

Create a HorizonDB cluster and allow public access from a single IP address (creates a firewall rule).

az horizondb create --name examplecluster --resource-group exampleresourcegroup --location centralus --administrator-login myadmin --administrator-login-password examplepassword --version 17 --v-cores 4 --public-access 12.12.12.12

Create a HorizonDB cluster and allow public access from a range of IP addresses.

az horizondb create --name examplecluster --resource-group exampleresourcegroup --location centralus --administrator-login myadmin --administrator-login-password examplepassword --version 17 --v-cores 4 --public-access 12.12.12.0-12.12.12.255

Create a HorizonDB cluster and allow public access from all IP addresses.

az horizondb create --name examplecluster --resource-group exampleresourcegroup --location centralus --administrator-login myadmin --administrator-login-password examplepassword --version 17 --v-cores 4 --public-access All

Required Parameters

Optional Parameters

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

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 delete [--acquire-policy-token]
                    [--change-reference]
                    [--ids]
                    [--name]
                    [--resource-group]
                    [--subscription]
                    [--yes]

Examples

Delete an Azure HorizonDB cluster.

az horizondb delete --name examplecluster --resource-group exampleresourcegroup

Optional Parameters

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

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 list [--resource-group]

Examples

List all Azure HorizonDB clusters in the current subscription.

az horizondb list

List Azure HorizonDB clusters in a resource group.

az horizondb list --resource-group exampleresourcegroup

Optional Parameters

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

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 show [--ids]
                  [--name]
                  [--resource-group]
                  [--subscription]

Examples

Show details of an Azure HorizonDB cluster.

az horizondb show --name examplecluster --resource-group exampleresourcegroup

Optional Parameters

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

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 update [--acquire-policy-token]
                    [--administrator-login-password]
                    [--change-reference]
                    [--ids]
                    [--name]
                    [--no-wait]
                    [--parameter-group]
                    [--public-access {Disabled, Enabled}]
                    [--resource-group]
                    [--subscription]
                    [--tags]
                    [--v-cores]
                    [--yes]

Examples

Update an existing HorizonDB cluster to have 6 vCores.

az horizondb update --name examplecluster --resource-group exampleresourcegroup --v-cores 6

Assign a parameter group to an existing HorizonDB cluster.

az horizondb update --name examplecluster --resource-group exampleresourcegroup --parameter-group /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.HorizonDb/parameterGroups/{parameterGroup}

Enable public access on an existing HorizonDB cluster (detects your client IP and prompts to create a firewall rule).

az horizondb update --name examplecluster --resource-group exampleresourcegroup --public-access Enabled

Optional Parameters

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

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