Configurations - Update

Service:: MySQL

API Version:: 2023-12-30

Updates a configuration of a server.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/configurations/{configurationName}?api-version=2023-12-30

URI Parameters

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

Request Body

Name	Type	Description
properties.currentValue	string	Current value of the configuration.
properties.source	ConfigurationSource	Source of the configuration.
properties.value	string	Value of the configuration.

Responses

Name	Type	Description
200 OK	Configuration	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

Update a user configuration

Sample request

HTTP

PATCH https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/flexibleServers/testserver/configurations/event_scheduler?api-version=2023-12-30

{
  "properties": {
    "value": "on",
    "source": "user-override"
  }
}

Sample response

Status code:: 200

{
  "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/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/testserver/configurations/event_scheduler",
  "name": "event_scheduler",
  "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-12-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-12-30

Definitions

Name	Description
Configuration	Represents a Configuration.
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.
systemData	Metadata pertaining to creation and last modification of the resource.

Configuration

Object

Represents a Configuration.

Name	Type	Description
id	string (arm-id)	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"

ConfigurationSource

Enumeration

Source of the configuration.

Value	Description
system-default
user-override

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

The resource management error additional info.

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

ErrorDetail

Object

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

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

IsConfigPendingRestart

Enumeration

If is the configuration pending restart or not.

Value	Description
True
False

IsDynamicConfig

Enumeration

If is the configuration dynamic.

Value	Description
True
False

IsReadOnly

Enumeration

If is the configuration read only.

Value	Description
True
False

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	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 (date-time)	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

Configurations - Update

URI Parameters

Request Body

Responses

Security

azure_auth

Scopes

Examples

Update a user configuration

Sample request

Sample response

Definitions

Configuration

ConfigurationSource

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

IsConfigPendingRestart

IsDynamicConfig

IsReadOnly

systemData