horizon_db_clusters

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

Overview

Name	horizon_db_clusters
Type	Resource
Id	azure.horizon_db.horizon_db_clusters

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.
administratorLogin	string	The administrator login name. Required.
administratorLoginPassword	string	The administrator login password.
createMode	string	The mode to create a new HorizonDb cluster. Known values are: "Create", "Update", and "PointInTimeRestore". (Create, Update, PointInTimeRestore)
fullyQualifiedDomainName	string	The fully qualified domain name of the cluster.
location	string	The geo-location where the resource lives. Required.
network	object	The network related info.
parameterGroup	object	Defines connection to a parameter group.
pointInTimeUTC	string (date-time)	Restore point creation time specifying the time to restore from.
poolName	string	The pool name for restore or replica operations.
processorType	string	The processor type for the HorizonDb cluster.
provisioningState	string	The provisioning state of the cluster. Known values are: "Succeeded", "Failed", "Canceled", "InProgress", and "Provisioning". (Succeeded, Failed, Canceled, InProgress, Provisioning)
readonlyEndpoint	string	The fully qualified domain name used for readonly endpoint for the cluster.
replicaCount	integer	Number of replicas.
sourceClusterResourceId	string	The source cluster resource ID for restore or replica creation.
state	string	Current state of the cluster. 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".
vCores	integer	Number of vCores.
version	string	The version of the HorizonDb cluster.
zonePlacementPolicy	string	Defines how replicas are placed across availability zones. Known values are: "Strict" and "BestEffort". (Strict, BestEffort)

list_by_resource_group

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.
administratorLogin	string	The administrator login name. Required.
administratorLoginPassword	string	The administrator login password.
createMode	string	The mode to create a new HorizonDb cluster. Known values are: "Create", "Update", and "PointInTimeRestore". (Create, Update, PointInTimeRestore)
fullyQualifiedDomainName	string	The fully qualified domain name of the cluster.
location	string	The geo-location where the resource lives. Required.
network	object	The network related info.
parameterGroup	object	Defines connection to a parameter group.
pointInTimeUTC	string (date-time)	Restore point creation time specifying the time to restore from.
poolName	string	The pool name for restore or replica operations.
processorType	string	The processor type for the HorizonDb cluster.
provisioningState	string	The provisioning state of the cluster. Known values are: "Succeeded", "Failed", "Canceled", "InProgress", and "Provisioning". (Succeeded, Failed, Canceled, InProgress, Provisioning)
readonlyEndpoint	string	The fully qualified domain name used for readonly endpoint for the cluster.
replicaCount	integer	Number of replicas.
sourceClusterResourceId	string	The source cluster resource ID for restore or replica creation.
state	string	Current state of the cluster. 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".
vCores	integer	Number of vCores.
version	string	The version of the HorizonDb cluster.
zonePlacementPolicy	string	Defines how replicas are placed across availability zones. Known values are: "Strict" and "BestEffort". (Strict, BestEffort)

list_by_subscription

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.
administratorLogin	string	The administrator login name. Required.
administratorLoginPassword	string	The administrator login password.
createMode	string	The mode to create a new HorizonDb cluster. Known values are: "Create", "Update", and "PointInTimeRestore". (Create, Update, PointInTimeRestore)
fullyQualifiedDomainName	string	The fully qualified domain name of the cluster.
location	string	The geo-location where the resource lives. Required.
network	object	The network related info.
parameterGroup	object	Defines connection to a parameter group.
pointInTimeUTC	string (date-time)	Restore point creation time specifying the time to restore from.
poolName	string	The pool name for restore or replica operations.
processorType	string	The processor type for the HorizonDb cluster.
provisioningState	string	The provisioning state of the cluster. Known values are: "Succeeded", "Failed", "Canceled", "InProgress", and "Provisioning". (Succeeded, Failed, Canceled, InProgress, Provisioning)
readonlyEndpoint	string	The fully qualified domain name used for readonly endpoint for the cluster.
replicaCount	integer	Number of replicas.
sourceClusterResourceId	string	The source cluster resource ID for restore or replica creation.
state	string	Current state of the cluster. 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".
vCores	integer	Number of vCores.
version	string	The version of the HorizonDb cluster.
zonePlacementPolicy	string	Defines how replicas are placed across availability zones. Known values are: "Strict" and "BestEffort". (Strict, BestEffort)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, cluster_name, subscription_id		Gets information about a HorizonDb cluster.
list_by_resource_group	select	resource_group_name, subscription_id		Lists all HorizonDb clusters in a resource group.
list_by_subscription	select	subscription_id		Lists all HorizonDb clusters in a subscription.
create_or_update	insert	resource_group_name, cluster_name, subscription_id, location		Creates a new HorizonDb cluster or updates an existing cluster.
update	update	resource_group_name, cluster_name, subscription_id		Updates an existing HorizonDb cluster (e.g., tags, virtual cores, replica count).
create_or_update	replace	resource_group_name, cluster_name, subscription_id, location		Creates a new HorizonDb cluster or updates an existing cluster.
delete	delete	resource_group_name, cluster_name, subscription_id		Deletes a HorizonDb 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.
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 cluster.

SELECT
id,
name,
administratorLogin,
administratorLoginPassword,
createMode,
fullyQualifiedDomainName,
location,
network,
parameterGroup,
pointInTimeUTC,
poolName,
processorType,
provisioningState,
readonlyEndpoint,
replicaCount,
sourceClusterResourceId,
state,
systemData,
tags,
type,
vCores,
version,
zonePlacementPolicy
FROM azure.horizon_db.horizon_db_clusters
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cluster_name = '{{ cluster_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Lists all HorizonDb clusters in a resource group.

SELECT
id,
name,
administratorLogin,
administratorLoginPassword,
createMode,
fullyQualifiedDomainName,
location,
network,
parameterGroup,
pointInTimeUTC,
poolName,
processorType,
provisioningState,
readonlyEndpoint,
replicaCount,
sourceClusterResourceId,
state,
systemData,
tags,
type,
vCores,
version,
zonePlacementPolicy
FROM azure.horizon_db.horizon_db_clusters
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

Lists all HorizonDb clusters in a subscription.

SELECT
id,
name,
administratorLogin,
administratorLoginPassword,
createMode,
fullyQualifiedDomainName,
location,
network,
parameterGroup,
pointInTimeUTC,
poolName,
processorType,
provisioningState,
readonlyEndpoint,
replicaCount,
sourceClusterResourceId,
state,
systemData,
tags,
type,
vCores,
version,
zonePlacementPolicy
FROM azure.horizon_db.horizon_db_clusters
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates a new HorizonDb cluster or updates an existing cluster.

INSERT INTO azure.horizon_db.horizon_db_clusters (
tags,
location,
properties,
resource_group_name,
cluster_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ resource_group_name }}',
'{{ cluster_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: horizon_db_clusters
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the horizon_db_clusters resource.
  - name: cluster_name
    value: "{{ cluster_name }}"
    description: Required parameter for the horizon_db_clusters resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the horizon_db_clusters resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      administratorLogin: "{{ administratorLogin }}"
      administratorLoginPassword: "{{ administratorLoginPassword }}"
      version: "{{ version }}"
      createMode: "{{ createMode }}"
      pointInTimeUTC: "{{ pointInTimeUTC }}"
      sourceClusterResourceId: "{{ sourceClusterResourceId }}"
      poolName: "{{ poolName }}"
      replicaCount: {{ replicaCount }}
      vCores: {{ vCores }}
      processorType: "{{ processorType }}"
      network:
        publicNetworkAccess: "{{ publicNetworkAccess }}"
      state: "{{ state }}"
      fullyQualifiedDomainName: "{{ fullyQualifiedDomainName }}"
      readonlyEndpoint: "{{ readonlyEndpoint }}"
      provisioningState: "{{ provisioningState }}"
      zonePlacementPolicy: "{{ zonePlacementPolicy }}"
      parameterGroup:
        id: "{{ id }}"
        syncStatus: "{{ syncStatus }}"
        applyImmediately: {{ applyImmediately }}

UPDATE examples

update

Updates an existing HorizonDb cluster (e.g., tags, virtual cores, replica count).

UPDATE azure.horizon_db.horizon_db_clusters
SET 
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND cluster_name = '{{ cluster_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Creates a new HorizonDb cluster or updates an existing cluster.

REPLACE azure.horizon_db.horizon_db_clusters
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND cluster_name = '{{ cluster_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Deletes a HorizonDb cluster.

DELETE FROM azure.horizon_db.horizon_db_clusters
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND cluster_name = '{{ cluster_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;