configurations

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

Overview

Name	configurations
Type	Resource
Id	azure.postgresql_flexible_servers.configurations

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.
allowedValues	string	Allowed values of the configuration (also known as server parameter).
dataType	string	Data type of the configuration (also known as server parameter). Known values are: "Boolean", "Numeric", "Integer", "Enumeration", "String", and "Set". (Boolean, Numeric, Integer, Enumeration, String, Set)
defaultValue	string	Value assigned by default to the configuration (also known as server parameter).
description	string	Description of the configuration (also known as server parameter).
documentationLink	string	Link pointing to the documentation of the configuration (also known as server parameter).
isConfigPendingRestart	boolean	Indicates if the value assigned to the configuration (also known as server parameter) is pending a server restart for it to take effect.
isDynamicConfig	boolean	Indicates if it's a dynamic (true) or static (false) configuration (also known as server parameter). Static server parameters require a server restart after changing the value assigned to them, for the change to take effect. Dynamic server parameters do not require a server restart after changing the value assigned to them, for the change to take effect.
isReadOnly	boolean	Indicates if it's a read-only (true) or modifiable (false) configuration (also known as server parameter).
source	string	Source of the value assigned to the configuration (also known as server parameter). Required to update the value assigned to a specific modifiable configuration.
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".
unit	string	Units in which the configuration (also known as server parameter) value is expressed.
value	string	Value of the configuration (also known as server parameter). Required to update the value assigned to a specific modifiable configuration.

list_by_server

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.
allowedValues	string	Allowed values of the configuration (also known as server parameter).
dataType	string	Data type of the configuration (also known as server parameter). Known values are: "Boolean", "Numeric", "Integer", "Enumeration", "String", and "Set". (Boolean, Numeric, Integer, Enumeration, String, Set)
defaultValue	string	Value assigned by default to the configuration (also known as server parameter).
description	string	Description of the configuration (also known as server parameter).
documentationLink	string	Link pointing to the documentation of the configuration (also known as server parameter).
isConfigPendingRestart	boolean	Indicates if the value assigned to the configuration (also known as server parameter) is pending a server restart for it to take effect.
isDynamicConfig	boolean	Indicates if it's a dynamic (true) or static (false) configuration (also known as server parameter). Static server parameters require a server restart after changing the value assigned to them, for the change to take effect. Dynamic server parameters do not require a server restart after changing the value assigned to them, for the change to take effect.
isReadOnly	boolean	Indicates if it's a read-only (true) or modifiable (false) configuration (also known as server parameter).
source	string	Source of the value assigned to the configuration (also known as server parameter). Required to update the value assigned to a specific modifiable configuration.
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".
unit	string	Units in which the configuration (also known as server parameter) value is expressed.
value	string	Value of the configuration (also known as server parameter). Required to update the value assigned to a specific modifiable configuration.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, server_name, configuration_name, subscription_id		Gets information about a specific configuration (also known as server parameter) of a server.
list_by_server	select	resource_group_name, server_name, subscription_id		Lists all configurations (also known as server parameters) of a server.
update	update	resource_group_name, server_name, configuration_name, subscription_id		Updates the value assigned to a specific modifiable configuration (also known as server parameter) of a server.
put	exec	resource_group_name, server_name, configuration_name, subscription_id		Updates, using Put verb, the value assigned to a specific modifiable configuration (also known as server parameter) of a server.

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
configuration_name	string	Name of the configuration (also known as server parameter). Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
server_name	string	The name of the server. Required.
subscription_id	string

SELECT examples

get

Gets information about a specific configuration (also known as server parameter) of a server.

SELECT
id,
name,
allowedValues,
dataType,
defaultValue,
description,
documentationLink,
isConfigPendingRestart,
isDynamicConfig,
isReadOnly,
source,
systemData,
type,
unit,
value
FROM azure.postgresql_flexible_servers.configurations
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND server_name = '{{ server_name }}' -- required
AND configuration_name = '{{ configuration_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_server

Lists all configurations (also known as server parameters) of a server.

SELECT
id,
name,
allowedValues,
dataType,
defaultValue,
description,
documentationLink,
isConfigPendingRestart,
isDynamicConfig,
isReadOnly,
source,
systemData,
type,
unit,
value
FROM azure.postgresql_flexible_servers.configurations
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND server_name = '{{ server_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

UPDATE examples

update

Updates the value assigned to a specific modifiable configuration (also known as server parameter) of a server.

UPDATE azure.postgresql_flexible_servers.configurations
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND server_name = '{{ server_name }}' --required
AND configuration_name = '{{ configuration_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

Lifecycle Methods

put

Updates, using Put verb, the value assigned to a specific modifiable configuration (also known as server parameter) of a server.

EXEC azure.postgresql_flexible_servers.configurations.put 
@resource_group_name='{{ resource_group_name }}' --required, 
@server_name='{{ server_name }}' --required, 
@configuration_name='{{ configuration_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;