configurations

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

Overview

Name	configurations
Type	Resource
Id	azure.cosmosdb_for_postgresql.configurations

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}".
name	string	The name of the resource.
allowedValues	string	Allowed values of the configuration.
dataType	string	Data type of the configuration. Known values are: "Boolean", "Numeric", "Integer", and "Enumeration".
description	string	Description of the configuration.
provisioningState	string	Provisioning state of the configuration. Known values are: "Succeeded", "Canceled", "InProgress", and "Failed".
requiresRestart	boolean	If configuration change requires restart.
serverRoleGroupConfigurations	array	The list of server role group configuration values.
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_by_server

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}".
name	string	The name of the resource.
allowedValues	string	Allowed values of the configuration.
dataType	string	Data type of the configuration. Known values are: "Boolean", "Numeric", "Integer", and "Enumeration".
defaultValue	string	Default value of the configuration.
description	string	Description of the configuration.
provisioningState	string	Provisioning state of the configuration. Known values are: "Succeeded", "Canceled", "InProgress", and "Failed".
requiresRestart	boolean	If configuration change requires restart.
source	string	Source of the 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".
value	string	Value of the configuration.

list_by_cluster

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}".
name	string	The name of the resource.
allowedValues	string	Allowed values of the configuration.
dataType	string	Data type of the configuration. Known values are: "Boolean", "Numeric", "Integer", and "Enumeration".
description	string	Description of the configuration.
provisioningState	string	Provisioning state of the configuration. Known values are: "Succeeded", "Canceled", "InProgress", and "Failed".
requiresRestart	boolean	If configuration change requires restart.
serverRoleGroupConfigurations	array	The list of server role group configuration values.
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, configuration_name, subscription_id		Gets information of a configuration for coordinator and nodes.
list_by_server	select	resource_group_name, cluster_name, server_name, subscription_id		List all the configurations of a server in cluster.
list_by_cluster	select	resource_group_name, cluster_name, subscription_id		List all the configurations of a cluster.
get_coordinator	exec	resource_group_name, cluster_name, configuration_name, subscription_id		Gets information of a configuration for coordinator.
update_on_coordinator	exec	resource_group_name, cluster_name, configuration_name, subscription_id		Updates configuration of coordinator in a cluster.
get_node	exec	resource_group_name, cluster_name, configuration_name, subscription_id		Gets information of a configuration for worker nodes.
update_on_node	exec	resource_group_name, cluster_name, configuration_name, subscription_id		Updates configuration of worker nodes in 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
cluster_name	string	The name of the cluster. Required.
configuration_name	string	The name of the cluster configuration. 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 of a configuration for coordinator and nodes.

SELECT
id,
name,
allowedValues,
dataType,
description,
provisioningState,
requiresRestart,
serverRoleGroupConfigurations,
systemData,
type
FROM azure.cosmosdb_for_postgresql.configurations
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cluster_name = '{{ cluster_name }}' -- required
AND configuration_name = '{{ configuration_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_server

List all the configurations of a server in cluster.

SELECT
id,
name,
allowedValues,
dataType,
defaultValue,
description,
provisioningState,
requiresRestart,
source,
systemData,
type,
value
FROM azure.cosmosdb_for_postgresql.configurations
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cluster_name = '{{ cluster_name }}' -- required
AND server_name = '{{ server_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_cluster

List all the configurations of a cluster.

SELECT
id,
name,
allowedValues,
dataType,
description,
provisioningState,
requiresRestart,
serverRoleGroupConfigurations,
systemData,
type
FROM azure.cosmosdb_for_postgresql.configurations
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cluster_name = '{{ cluster_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

Lifecycle Methods

get_coordinator

Gets information of a configuration for coordinator.

EXEC azure.cosmosdb_for_postgresql.configurations.get_coordinator 
@resource_group_name='{{ resource_group_name }}' --required, 
@cluster_name='{{ cluster_name }}' --required, 
@configuration_name='{{ configuration_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

update_on_coordinator

Updates configuration of coordinator in a cluster.

EXEC azure.cosmosdb_for_postgresql.configurations.update_on_coordinator 
@resource_group_name='{{ resource_group_name }}' --required, 
@cluster_name='{{ cluster_name }}' --required, 
@configuration_name='{{ configuration_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;

get_node

Gets information of a configuration for worker nodes.

EXEC azure.cosmosdb_for_postgresql.configurations.get_node 
@resource_group_name='{{ resource_group_name }}' --required, 
@cluster_name='{{ cluster_name }}' --required, 
@configuration_name='{{ configuration_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

update_on_node

Updates configuration of worker nodes in a cluster.

EXEC azure.cosmosdb_for_postgresql.configurations.update_on_node 
@resource_group_name='{{ resource_group_name }}' --required, 
@cluster_name='{{ cluster_name }}' --required, 
@configuration_name='{{ configuration_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;