configurations

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

Overview

Name	configurations
Type	Resource
Id	azure.mysql_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. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}".
name	string	The name of the resource.
allowedValues	string	Allowed values of the configuration.
currentValue	string	Current value of the configuration.
dataType	string	Data type of the configuration.
defaultValue	string	Default value of the configuration.
description	string	Description of the configuration.
documentationLink	string	The link used to get the document from community or Azure site.
isConfigPendingRestart	string	If is the configuration pending restart or not. Known values are: "True" and "False".
isDynamicConfig	string	If is the configuration dynamic. Known values are: "True" and "False".
isReadOnly	string	If is the configuration read only. Known values are: "True" and "False".
source	string	Source of the configuration. Known values are: "system-default" and "user-override".
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_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.
currentValue	string	Current value of the configuration.
dataType	string	Data type of the configuration.
defaultValue	string	Default value of the configuration.
description	string	Description of the configuration.
documentationLink	string	The link used to get the document from community or Azure site.
isConfigPendingRestart	string	If is the configuration pending restart or not. Known values are: "True" and "False".
isDynamicConfig	string	If is the configuration dynamic. Known values are: "True" and "False".
isReadOnly	string	If is the configuration read only. Known values are: "True" and "False".
source	string	Source of the configuration. Known values are: "system-default" and "user-override".
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.

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 configuration of server.
list_by_server	select	resource_group_name, server_name, subscription_id	tags, keyword, page, pageSize	List all the configurations in a given server.
create_or_update	insert	resource_group_name, server_name, configuration_name, subscription_id		Updates a configuration of a server.
update	update	resource_group_name, server_name, configuration_name, subscription_id		Updates a configuration of a server.
create_or_update	replace	resource_group_name, server_name, configuration_name, subscription_id		Updates a configuration of a server.
batch_update	exec	resource_group_name, server_name, subscription_id		Update a list of configurations in a given 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	The name of the server 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
keyword	string	The keyword of the server configuration. Default value is None.
page	integer	The page of the server configuration. Default value is None.
pageSize	integer	The pageSize of the server configuration. Default value is None.
tags	string	The tags of the server configuration. Default value is None.

SELECT examples

get

Gets information about a configuration of server.

SELECT
id,
name,
allowedValues,
currentValue,
dataType,
defaultValue,
description,
documentationLink,
isConfigPendingRestart,
isDynamicConfig,
isReadOnly,
source,
systemData,
type,
value
FROM azure.mysql_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

List all the configurations in a given server.

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

INSERT examples

create_or_update

Updates a configuration of a server.

INSERT INTO azure.mysql_flexible_servers.configurations (
properties,
resource_group_name,
server_name,
configuration_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ server_name }}',
'{{ configuration_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: configurations
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the configurations resource.
  - name: server_name
    value: "{{ server_name }}"
    description: Required parameter for the configurations resource.
  - name: configuration_name
    value: "{{ configuration_name }}"
    description: Required parameter for the configurations resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the configurations resource.
  - name: properties
    value:
      value: "{{ value }}"
      currentValue: "{{ currentValue }}"
      source: "{{ source }}"

UPDATE examples

update

Updates a configuration of a server.

UPDATE azure.mysql_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;

REPLACE examples

create_or_update

Updates a configuration of a server.

REPLACE azure.mysql_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

batch_update

Update a list of configurations in a given server.

EXEC azure.mysql_flexible_servers.configurations.batch_update 
@resource_group_name='{{ resource_group_name }}' --required, 
@server_name='{{ server_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"value": "{{ value }}", 
"resetAllToDefault": "{{ resetAllToDefault }}"
}'
;