horizon_db_parameter_groups

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

Overview

Name	horizon_db_parameter_groups
Type	Resource
Id	azure.horizon_db.horizon_db_parameter_groups

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.
applyImmediately	boolean	Indicates whether the parameters should be applied immediately.
description	string	Description of the parameter group.
location	string	The geo-location where the resource lives. Required.
parameters	array	Parameters in the parameter group.
pgVersion	integer	PostgreSQL version for the parameter group.
provisioningState	string	The provisioning state of the parameter group. Known values are: "Succeeded", "Failed", "Canceled", "InProgress", and "Provisioning". (Succeeded, Failed, Canceled, InProgress, Provisioning)
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	integer	Current version of the parameter group.

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.
applyImmediately	boolean	Indicates whether the parameters should be applied immediately.
description	string	Description of the parameter group.
location	string	The geo-location where the resource lives. Required.
parameters	array	Parameters in the parameter group.
pgVersion	integer	PostgreSQL version for the parameter group.
provisioningState	string	The provisioning state of the parameter group. Known values are: "Succeeded", "Failed", "Canceled", "InProgress", and "Provisioning". (Succeeded, Failed, Canceled, InProgress, Provisioning)
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	integer	Current version of the parameter group.

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.
applyImmediately	boolean	Indicates whether the parameters should be applied immediately.
description	string	Description of the parameter group.
location	string	The geo-location where the resource lives. Required.
parameters	array	Parameters in the parameter group.
pgVersion	integer	PostgreSQL version for the parameter group.
provisioningState	string	The provisioning state of the parameter group. Known values are: "Succeeded", "Failed", "Canceled", "InProgress", and "Provisioning". (Succeeded, Failed, Canceled, InProgress, Provisioning)
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	integer	Current version of the parameter group.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, parameter_group_name, subscription_id		Gets information about a HorizonDb parameter group.
list_by_resource_group	select	resource_group_name, subscription_id		Lists all HorizonDb parameter groups in a resource group.
list_by_subscription	select	subscription_id		Lists all HorizonDb parameter groups in a subscription.
create_or_update	insert	resource_group_name, parameter_group_name, subscription_id, location		Creates a new HorizonDb parameter group or updates an existing parameter group.
update	update	resource_group_name, parameter_group_name, subscription_id		Updates an existing HorizonDb parameter group.
create_or_update	replace	resource_group_name, parameter_group_name, subscription_id, location		Creates a new HorizonDb parameter group or updates an existing parameter group.
delete	delete	resource_group_name, parameter_group_name, subscription_id		Deletes a HorizonDb parameter group.
list_connections	exec	resource_group_name, parameter_group_name, subscription_id		Gets all connections to a parameter group.
list_versions	exec	resource_group_name, parameter_group_name, subscription_id	version	Lists parameter groups filtered by version number.

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
parameter_group_name	string	The name of the HorizonDb parameter group. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
version	integer	The version number to filter by. Default value is None.

SELECT examples

get

Gets information about a HorizonDb parameter group.

SELECT
id,
name,
applyImmediately,
description,
location,
parameters,
pgVersion,
provisioningState,
systemData,
tags,
type,
version
FROM azure.horizon_db.horizon_db_parameter_groups
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND parameter_group_name = '{{ parameter_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Lists all HorizonDb parameter groups in a resource group.

SELECT
id,
name,
applyImmediately,
description,
location,
parameters,
pgVersion,
provisioningState,
systemData,
tags,
type,
version
FROM azure.horizon_db.horizon_db_parameter_groups
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

Lists all HorizonDb parameter groups in a subscription.

SELECT
id,
name,
applyImmediately,
description,
location,
parameters,
pgVersion,
provisioningState,
systemData,
tags,
type,
version
FROM azure.horizon_db.horizon_db_parameter_groups
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates a new HorizonDb parameter group or updates an existing parameter group.

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

Manifest

# Description fields are for documentation purposes
- name: horizon_db_parameter_groups
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the horizon_db_parameter_groups resource.
  - name: parameter_group_name
    value: "{{ parameter_group_name }}"
    description: Required parameter for the horizon_db_parameter_groups resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the horizon_db_parameter_groups 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:
      parameters:
        - name: "{{ name }}"
          description: "{{ description }}"
          value: "{{ value }}"
          dataType: "{{ dataType }}"
          allowedValues: "{{ allowedValues }}"
          isDynamic: {{ isDynamic }}
          isReadOnly: {{ isReadOnly }}
          documentationLink: "{{ documentationLink }}"
          unit: "{{ unit }}"
      description: "{{ description }}"
      pgVersion: {{ pgVersion }}
      version: {{ version }}
      applyImmediately: {{ applyImmediately }}
      provisioningState: "{{ provisioningState }}"

UPDATE examples

update

Updates an existing HorizonDb parameter group.

UPDATE azure.horizon_db.horizon_db_parameter_groups
SET 
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND parameter_group_name = '{{ parameter_group_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 parameter group or updates an existing parameter group.

REPLACE azure.horizon_db.horizon_db_parameter_groups
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND parameter_group_name = '{{ parameter_group_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 parameter group.

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

Lifecycle Methods

list_connections

Gets all connections to a parameter group.

EXEC azure.horizon_db.horizon_db_parameter_groups.list_connections 
@resource_group_name='{{ resource_group_name }}' --required, 
@parameter_group_name='{{ parameter_group_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

list_versions

Lists parameter groups filtered by version number.

EXEC azure.horizon_db.horizon_db_parameter_groups.list_versions 
@resource_group_name='{{ resource_group_name }}' --required, 
@parameter_group_name='{{ parameter_group_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required, 
@version='{{ version }}'
;