Configurations - Batch Update

Reference

Service:: MySQL

API Version:: 2023-06-30

Update a list of configurations in a given server.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/updateConfigurations?api-version=2023-06-30

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string	The name of the resource group. The name is case insensitive.
serverName	path	True	string	The name of the server. Regex pattern: `^[a-z0-9][-a-z0-9]*(?<!-)$`
subscriptionId	path	True	string uuid	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string	The API version to use for this operation.

Request Body

Name	Type	Description
resetAllToDefault	ResetAllToDefault	Whether to reset all server parameters to default.
value	ConfigurationForBatchUpdate[]	The list of server configurations.

Responses

Name	Type	Description
200 OK	ConfigurationListResult	OK
202 Accepted		Accepted
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

ConfigurationList

Sample Request

HTTP

POST https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver/updateConfigurations?api-version=2023-06-30

{
  "value": [
    {
      "name": "event_scheduler",
      "properties": {
        "value": "OFF"
      }
    },
    {
      "name": "div_precision_increment",
      "properties": {
        "value": "8"
      }
    }
  ],
  "resetAllToDefault": "False"
}

Sample Response

Status code:: 200

{
  "value": [
    {
      "properties": {
        "value": "ON",
        "description": "Indicates the status of the Event Scheduler. It is always OFF for a replica server to keep the replication consistency.",
        "defaultValue": "OFF",
        "dataType": "Enumeration",
        "allowedValues": "ON,OFF",
        "source": "user-override",
        "isConfigPendingRestart": "False",
        "isDynamicConfig": "True",
        "isReadOnly": "False"
      },
      "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver/configurations/event_scheduler",
      "name": "event_scheduler",
      "type": "Microsoft.DBforMySQL/flexibleServers/configurations"
    },
    {
      "properties": {
        "value": "8",
        "description": "Number of digits by which to increase the scale of the result of division operations.",
        "defaultValue": "4",
        "dataType": "Integer",
        "allowedValues": "0-30",
        "source": "user-override",
        "isConfigPendingRestart": "False",
        "isDynamicConfig": "True",
        "isReadOnly": "False"
      },
      "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver/configurations/div_precision_increment",
      "name": "div_precision_increment",
      "type": "Microsoft.DBforMySQL/flexibleServers/configurations"
    }
  ]
}

Status code:: 202

Azure-AsyncOperation: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforMySQL/locations/southeastasia/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2023-06-30
Location: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforMySQL/locations/southeastasia/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2023-06-30

Definitions

Name	Description
Configuration	Represents a Configuration.
ConfigurationForBatchUpdate	Represents a Configuration.
ConfigurationListForBatchUpdate	A list of server configurations to update.
ConfigurationListResult	A list of server configurations.
ConfigurationSource	Source of the configuration.
createdByType	The type of identity that created the resource.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
IsConfigPendingRestart	If is the configuration pending restart or not.
IsDynamicConfig	If is the configuration dynamic.
IsReadOnly	If is the configuration read only.
ResetAllToDefault	Whether to reset all server parameters to default.
systemData	Metadata pertaining to creation and last modification of the resource.

Configuration

Represents a Configuration.

Name	Type	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
properties.allowedValues	string	Allowed values of the configuration.
properties.currentValue	string	Current value of the configuration.
properties.dataType	string	Data type of the configuration.
properties.defaultValue	string	Default value of the configuration.
properties.description	string	Description of the configuration.
properties.documentationLink	string	The link used to get the document from community or Azure site.
properties.isConfigPendingRestart	IsConfigPendingRestart	If is the configuration pending restart or not.
properties.isDynamicConfig	IsDynamicConfig	If is the configuration dynamic.
properties.isReadOnly	IsReadOnly	If is the configuration read only.
properties.source	ConfigurationSource	Source of the configuration.
properties.value	string	Value of the configuration.
systemData	systemData	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"

ConfigurationForBatchUpdate

Represents a Configuration.

Name	Type	Description
name	string	Name of the configuration.
properties.source	string	Source of the configuration.
properties.value	string	Value of the configuration.

ConfigurationListForBatchUpdate

A list of server configurations to update.

Name	Type	Description
resetAllToDefault	ResetAllToDefault	Whether to reset all server parameters to default.
value	ConfigurationForBatchUpdate[]	The list of server configurations.

ConfigurationListResult

A list of server configurations.

Name	Type	Description
nextLink	string	The link used to get the next page of operations.
value	Configuration[]	The list of server configurations.

ConfigurationSource

Source of the configuration.

Name	Type	Description
system-default	string
user-override	string

createdByType

The type of identity that created the resource.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Error response

Name	Type	Description
error	ErrorDetail	The error object.

IsConfigPendingRestart

If is the configuration pending restart or not.

Name	Type	Description
False	string
True	string

IsDynamicConfig

If is the configuration dynamic.

Name	Type	Description
False	string
True	string

IsReadOnly

If is the configuration read only.

Name	Type	Description
False	string
True	string

ResetAllToDefault

Whether to reset all server parameters to default.

Name	Type	Description
False	string
True	string

systemData

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

Share via