configurations

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

Overview

Name	configurations
Type	Resource
Id	azure.mysql.configurations

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
properties	object	The properties of a configuration.

list_by_server

Name	Datatype	Description
properties	object	The properties of a configuration.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, serverName, configurationName		Gets information about a configuration of server.
list_by_server	select	subscriptionId, resourceGroupName, serverName	tags, keyword, page, pageSize	List all the configurations in a given server.
create_or_update	insert	subscriptionId, resourceGroupName, serverName, configurationName		Updates a configuration of a server.
update	update	subscriptionId, resourceGroupName, serverName, configurationName		Updates a configuration of a server.
batch_update	exec	subscriptionId, resourceGroupName, serverName		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
configurationName	string	The name of the server 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.
keyword	string	The keyword of the server configuration.
page	integer (int32)	The page of the server configuration.
pageSize	integer (int32)	The pageSize of the server configuration.
tags	string	The tags of the server configuration.

SELECT examples

get

Gets information about a configuration of server.

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

list_by_server

List all the configurations in a given server.

SELECT
properties
FROM azure.mysql.configurations
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND serverName = '{{ serverName }}' -- 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.configurations (
data__properties,
subscriptionId,
resourceGroupName,
serverName,
configurationName
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ serverName }}',
'{{ configurationName }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: configurations
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the configurations resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the configurations resource.
    - name: serverName
      value: string
      description: Required parameter for the configurations resource.
    - name: configurationName
      value: string
      description: Required parameter for the configurations resource.
    - name: properties
      value: object
      description: |
        The properties of a configuration.

UPDATE examples

update

Updates a configuration of a server.

UPDATE azure.mysql.configurations
SET 
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND serverName = '{{ serverName }}' --required
AND configurationName = '{{ configurationName }}' --required
RETURNING
properties;

Lifecycle Methods

batch_update

Update a list of configurations in a given server.

EXEC azure.mysql.configurations.batch_update 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@serverName='{{ serverName }}' --required 
@@json=
'{
"value": "{{ value }}", 
"resetAllToDefault": "{{ resetAllToDefault }}"
}'
;