Configurations - List By Server
List all the configurations in a given server.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/configurations?api-version=2023-06-01-preview
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/configurations?api-version=2023-06-01-preview&tags={tags}&keyword={keyword}&page={page}&pageSize={pageSize}
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
resource
|
path | True |
string |
The name of the resource group. The name is case insensitive. |
server
|
path | True |
string |
The name of the server. Regex pattern: |
subscription
|
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. |
keyword
|
query |
string |
The keyword of the server configuration. |
|
page
|
query |
integer int32 |
The page of the server configuration. |
|
page
|
query |
integer int32 |
The pageSize of the server configuration. |
|
tags
|
query |
string |
The tags of the server configuration. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
OK |
|
Other Status Codes |
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
List all configurations for a server
Sample request
GET https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver/configurations?api-version=2023-06-01-preview&page=1&pageSize=8
Sample response
{
"value": [
{
"properties": {
"value": "OFF",
"description": "Tell the server to enable or disable archive engine.",
"defaultValue": "OFF",
"dataType": "Enumeration",
"allowedValues": "ON,OFF",
"source": "system-default",
"isConfigPendingRestart": "False",
"isDynamicConfig": "False",
"isReadOnly": "True"
},
"id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver/configurations/archive",
"name": "archive",
"type": "Microsoft.DBforMySQL/flexibleServers/configurations"
},
{
"properties": {
"value": "OFF",
"description": "Allow to audit the log.",
"defaultValue": "OFF",
"dataType": "Enumeration",
"allowedValues": "ON,OFF",
"source": "system-default",
"isConfigPendingRestart": "False",
"isDynamicConfig": "True",
"isReadOnly": "False"
},
"id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver/configurations/audit_log_enabled",
"name": "audit_log_enabled",
"type": "Microsoft.DBforMySQL/flexibleServers/configurations"
},
{
"properties": {
"value": "CONNECTION",
"description": "Select the events to audit logs.",
"defaultValue": "CONNECTION",
"dataType": "Set",
"allowedValues": "DDL,DML_SELECT,DML_NONSELECT,DCL,ADMIN,DML,GENERAL,CONNECTION,TABLE_ACCESS",
"source": "system-default",
"isConfigPendingRestart": "False",
"isDynamicConfig": "True",
"isReadOnly": "False"
},
"id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver/configurations/audit_log_events",
"name": "audit_log_events",
"type": "Microsoft.DBforMySQL/flexibleServers/configurations"
},
{
"properties": {
"value": "azure_superuser",
"description": "The comma-separated user list whose commands will not be in the audit logs.",
"defaultValue": "azure_superuser",
"dataType": "String",
"allowedValues": "",
"source": "system-default",
"isConfigPendingRestart": "False",
"isDynamicConfig": "True",
"isReadOnly": "False"
},
"id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver/configurations/audit_log_exclude_users",
"name": "audit_log_exclude_users",
"type": "Microsoft.DBforMySQL/flexibleServers/configurations"
},
{
"properties": {
"value": "",
"description": "The comma-separated user list whose commands will be in the audit logs. It takes higher priority if the same user name is found in audit_log_exclude_users.",
"defaultValue": "",
"dataType": "String",
"allowedValues": "",
"source": "system-default",
"isConfigPendingRestart": "False",
"isDynamicConfig": "True",
"isReadOnly": "False"
},
"id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver/configurations/audit_log_include_users",
"name": "audit_log_include_users",
"type": "Microsoft.DBforMySQL/flexibleServers/configurations"
},
{
"properties": {
"value": "ON",
"description": "Allow to audit the slow log.",
"defaultValue": "ON",
"dataType": "Enumeration",
"allowedValues": "ON,OFF",
"source": "system-default",
"isConfigPendingRestart": "False",
"isDynamicConfig": "True",
"isReadOnly": "True"
},
"id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver/configurations/audit_slow_log_enabled",
"name": "audit_slow_log_enabled",
"type": "Microsoft.DBforMySQL/flexibleServers/configurations"
},
{
"properties": {
"value": "OFF",
"description": "Controls whether the server autogenerates SSL key and certificate files in the data directory, if they do not already exist.",
"defaultValue": "OFF",
"dataType": "Enumeration",
"allowedValues": "ON,OFF",
"source": "system-default",
"isConfigPendingRestart": "False",
"isDynamicConfig": "False",
"isReadOnly": "True"
},
"id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver/configurations/auto_generate_certs",
"name": "auto_generate_certs",
"type": "Microsoft.DBforMySQL/flexibleServers/configurations"
},
{
"properties": {
"value": "1",
"description": "The auto_increment_increment is intended for use with source-to-source replication, and can be used to control the operation of AUTO_INCREMENT columns.",
"defaultValue": "1",
"dataType": "Integer",
"allowedValues": "1-65535",
"source": "system-default",
"isConfigPendingRestart": "False",
"isDynamicConfig": "True",
"isReadOnly": "False"
},
"id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver/configurations/auto_increment_increment",
"name": "auto_increment_increment",
"type": "Microsoft.DBforMySQL/flexibleServers/configurations"
}
]
}
Definitions
Name | Description |
---|---|
Configuration |
Represents a Configuration. |
Configuration |
A list of server configurations. |
Configuration |
Source of the configuration. |
created |
The type of identity that created the resource. |
Error |
The resource management error additional info. |
Error |
The error detail. |
Error |
Error response |
Is |
If is the configuration pending restart or not. |
Is |
If is the configuration dynamic. |
Is |
If is the configuration read only. |
system |
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 |
If is the configuration pending restart or not. |
|
properties.isDynamicConfig |
If is the configuration dynamic. |
|
properties.isReadOnly |
If is the configuration read only. |
|
properties.source |
Source of the configuration. |
|
properties.value |
string |
Value of the configuration. |
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" |
ConfigurationListResult
A list of server configurations.
Name | Type | Description |
---|---|---|
nextLink |
string |
The link used to get the next page of operations. |
value |
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 |
The error additional info. |
|
code |
string |
The error code. |
details |
The error details. |
|
message |
string |
The error message. |
target |
string |
The error target. |
ErrorResponse
Error response
Name | Type | Description |
---|---|---|
error |
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 |
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 |
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 |
The type of identity that last modified the resource. |