horizon_db_pools

Creates, updates, deletes, gets or lists a horizon_db_pools resource.

Overview

Name	horizon_db_pools
Type	Resource
Id	azure.horizon_db.horizon_db_pools

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
createMode	string	The create mode for the pool. Known values are: "Create" and "Update". (Create, Update)
location	string	The location of the HorizonDb pool.
provisioningState	string	The provisioning state of the pool. Known values are: "Succeeded", "Failed", "Canceled", "InProgress", and "Provisioning". (Succeeded, Failed, Canceled, InProgress, Provisioning)
replicaCount	integer	Number of replicas in the pool.
state	string	Current state of the pool. Known values are: "Ready", "Dropping", "Disabled", "Starting", "Stopping", "Stopped", "Updating", and "Healthy". (Ready, Dropping, Disabled, Starting, Stopping, Stopped, Updating, Healthy)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
version	string	The version of the HorizonDb pool.

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
createMode	string	The create mode for the pool. Known values are: "Create" and "Update". (Create, Update)
location	string	The location of the HorizonDb pool.
provisioningState	string	The provisioning state of the pool. Known values are: "Succeeded", "Failed", "Canceled", "InProgress", and "Provisioning". (Succeeded, Failed, Canceled, InProgress, Provisioning)
replicaCount	integer	Number of replicas in the pool.
state	string	Current state of the pool. Known values are: "Ready", "Dropping", "Disabled", "Starting", "Stopping", "Stopped", "Updating", and "Healthy". (Ready, Dropping, Disabled, Starting, Stopping, Stopped, Updating, Healthy)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
version	string	The version of the HorizonDb pool.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, cluster_name, pool_name, subscription_id		Gets information about a HorizonDb pool.
list	select	resource_group_name, cluster_name, subscription_id		Lists all HorizonDb pools in a cluster.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
cluster_name	string	The name of the HorizonDb cluster. Required.
pool_name	string	The name of the HorizonDb pool. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Gets information about a HorizonDb pool.

SELECT
id,
name,
createMode,
location,
provisioningState,
replicaCount,
state,
systemData,
tags,
type,
version
FROM azure.horizon_db.horizon_db_pools
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cluster_name = '{{ cluster_name }}' -- required
AND pool_name = '{{ pool_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Lists all HorizonDb pools in a cluster.

SELECT
id,
name,
createMode,
location,
provisioningState,
replicaCount,
state,
systemData,
tags,
type,
version
FROM azure.horizon_db.horizon_db_pools
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cluster_name = '{{ cluster_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;