horizon_db_replicas

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

Overview

Name	horizon_db_replicas
Type	Resource
Id	azure.horizon_db.horizon_db_replicas

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.
availabilityZone	string	The availability zone of the replica.
fullyQualifiedDomainName	string	The fully qualified domain name of the replica.
provisioningState	string	The provisioning state of the replica. Known values are: "Succeeded", "Failed", "Canceled", "InProgress", and "Provisioning". (Succeeded, Failed, Canceled, InProgress, Provisioning)
role	string	Role of the replica. Known values are: "Read" and "ReadWrite". (Read, ReadWrite)
status	string	Current status of the replica. 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.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

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.
availabilityZone	string	The availability zone of the replica.
fullyQualifiedDomainName	string	The fully qualified domain name of the replica.
provisioningState	string	The provisioning state of the replica. Known values are: "Succeeded", "Failed", "Canceled", "InProgress", and "Provisioning". (Succeeded, Failed, Canceled, InProgress, Provisioning)
role	string	Role of the replica. Known values are: "Read" and "ReadWrite". (Read, ReadWrite)
status	string	Current status of the replica. 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.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

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, replica_name, subscription_id		Gets information about a HorizonDb replica.
list	select	resource_group_name, cluster_name, pool_name, subscription_id		Lists all HorizonDb replicas in a pool.
create_or_update	insert	resource_group_name, cluster_name, pool_name, replica_name, subscription_id		Creates a new HorizonDb replica or updates an existing replica.
update	update	resource_group_name, cluster_name, pool_name, replica_name, subscription_id		Updates an existing HorizonDb replica (e.g., role).
create_or_update	replace	resource_group_name, cluster_name, pool_name, replica_name, subscription_id		Creates a new HorizonDb replica or updates an existing replica.
delete	delete	resource_group_name, cluster_name, pool_name, replica_name, subscription_id		Deletes a HorizonDb replica.

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.
replica_name	string	The name of the HorizonDb replica. 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 replica.

SELECT
id,
name,
availabilityZone,
fullyQualifiedDomainName,
provisioningState,
role,
status,
systemData,
type
FROM azure.horizon_db.horizon_db_replicas
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cluster_name = '{{ cluster_name }}' -- required
AND pool_name = '{{ pool_name }}' -- required
AND replica_name = '{{ replica_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Lists all HorizonDb replicas in a pool.

SELECT
id,
name,
availabilityZone,
fullyQualifiedDomainName,
provisioningState,
role,
status,
systemData,
type
FROM azure.horizon_db.horizon_db_replicas
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
;

INSERT examples

create_or_update

Creates a new HorizonDb replica or updates an existing replica.

INSERT INTO azure.horizon_db.horizon_db_replicas (
properties,
resource_group_name,
cluster_name,
pool_name,
replica_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ cluster_name }}',
'{{ pool_name }}',
'{{ replica_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: horizon_db_replicas
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the horizon_db_replicas resource.
  - name: cluster_name
    value: "{{ cluster_name }}"
    description: Required parameter for the horizon_db_replicas resource.
  - name: pool_name
    value: "{{ pool_name }}"
    description: Required parameter for the horizon_db_replicas resource.
  - name: replica_name
    value: "{{ replica_name }}"
    description: Required parameter for the horizon_db_replicas resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the horizon_db_replicas resource.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      role: "{{ role }}"
      status: "{{ status }}"
      fullyQualifiedDomainName: "{{ fullyQualifiedDomainName }}"
      availabilityZone: "{{ availabilityZone }}"
      provisioningState: "{{ provisioningState }}"

UPDATE examples

update

Updates an existing HorizonDb replica (e.g., role).

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

REPLACE examples

create_or_update

Creates a new HorizonDb replica or updates an existing replica.

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

DELETE examples

delete

Deletes a HorizonDb replica.

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