configurations

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

Overview

Name	configurations
Type	Resource
Id	azure.postgresql_hsc.configurations

Fields

The following fields are returned by SELECT queries:

list_by_server

Name	Datatype	Description
properties	object	The properties of a configuration.

get

Name	Datatype	Description
properties	object	The properties of configuration.

list_by_cluster

Name	Datatype	Description
properties	object	The properties of configuration.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_by_server	select	subscriptionId, resourceGroupName, clusterName, serverName		List all the configurations of a server in cluster.
get	select	subscriptionId, resourceGroupName, clusterName, configurationName		Gets information of a configuration for coordinator and nodes.
list_by_cluster	select	subscriptionId, resourceGroupName, clusterName		List all the configurations of 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
clusterName	string	The name of the cluster.
configurationName	string	The name of the cluster configuration.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
serverName	string	The name of the server.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

list_by_server

List all the configurations of a server in cluster.

SELECT
properties
FROM azure.postgresql_hsc.configurations
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND clusterName = '{{ clusterName }}' -- required
AND serverName = '{{ serverName }}' -- required
;

get

Gets information of a configuration for coordinator and nodes.

SELECT
properties
FROM azure.postgresql_hsc.configurations
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND clusterName = '{{ clusterName }}' -- required
AND configurationName = '{{ configurationName }}' -- required
;

list_by_cluster

List all the configurations of a cluster.

SELECT
properties
FROM azure.postgresql_hsc.configurations
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND clusterName = '{{ clusterName }}' -- required
;