configurations

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

Overview

Name	configurations
Type	Resource
Id	azure.mysql.configurations

Fields

vw_configurations

Name	Datatype	Description
description	text	field from the properties object
allowed_values	text	field from the properties object
configurationName	text	field from the properties object
current_value	text	field from the properties object
data_type	text	field from the properties object
default_value	text	field from the properties object
documentation_link	text	field from the properties object
is_config_pending_restart	text	field from the properties object
is_dynamic_config	text	field from the properties object
is_read_only	text	field from the properties object
resourceGroupName	text	field from the properties object
serverName	text	field from the properties object
source	text	field from the properties object
subscriptionId	text	field from the properties object
value	text	field from the properties object

configurations

Name	Datatype	Description
properties	object	The properties of a configuration.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	configurationName, resourceGroupName, serverName, subscriptionId	Gets information about a configuration of server.
list_by_server	SELECT	resourceGroupName, serverName, subscriptionId	List all the configurations in a given server.
create_or_update	INSERT	configurationName, resourceGroupName, serverName, subscriptionId	Updates a configuration of a server.
update	UPDATE	configurationName, resourceGroupName, serverName, subscriptionId	Updates a configuration of a server.
batch_update	EXEC	resourceGroupName, serverName, subscriptionId	Update a list of configurations in a given server.

SELECT examples

List all the configurations in a given server.

vw_configurations

SELECT
description,
allowed_values,
configurationName,
current_value,
data_type,
default_value,
documentation_link,
is_config_pending_restart,
is_dynamic_config,
is_read_only,
resourceGroupName,
serverName,
source,
subscriptionId,
value
FROM azure.mysql.vw_configurations
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND serverName = '{{ serverName }}'
AND subscriptionId = '{{ subscriptionId }}';

configurations

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

INSERT example

Use the following StackQL query and manifest file to create a new configurations resource.

All Properties

/*+ create */
INSERT INTO azure.mysql.configurations (
configurationName,
resourceGroupName,
serverName,
subscriptionId,
properties
)
SELECT 
'{{ configurationName }}',
'{{ resourceGroupName }}',
'{{ serverName }}',
'{{ subscriptionId }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: value
          value: string
        - name: currentValue
          value: string
        - name: description
          value: string
        - name: documentationLink
          value: string
        - name: defaultValue
          value: string
        - name: dataType
          value: string
        - name: allowedValues
          value: string
        - name: source
          value: string
        - name: isReadOnly
          value: string
        - name: isConfigPendingRestart
          value: string
        - name: isDynamicConfig
          value: string

UPDATE example

Updates a configurations resource.

/*+ update */
UPDATE azure.mysql.configurations
SET 
properties = '{{ properties }}'
WHERE 
configurationName = '{{ configurationName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND serverName = '{{ serverName }}'
AND subscriptionId = '{{ subscriptionId }}';