你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Configurations - List By Server

服务:: MySQL

API 版本:: 2024-12-30

列出给定服务器中的所有配置。

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

具有可选参数:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/configurations?api-version=2024-12-30&tags={tags}&keyword={keyword}&page={page}&pageSize={pageSize}

URI 参数

名称	在	必需	类型	说明
resourceGroupName	path	True	string minLength: 1 maxLength: 90	资源组的名称。此名称不区分大小写。
serverName	path	True	string minLength: 1 maxLength: 63 pattern: ^[a-z0-9][-a-z0-9]*(?	服务器的名称。
subscriptionId	path	True	string (uuid)	目标订阅的 ID。该值必须是 UUID。
api-version	query	True	string minLength: 1	要用于此操作的 API 版本。
keyword	query		string	服务器配置的关键字。
page	query		integer (int32)	服务器配置的页。
pageSize	query		integer (int32)	服务器配置的 pageSize。
tags	query		string	服务器配置的标记。

响应

名称	类型	说明
200 OK	ConfigurationListResult	Azure作已成功完成。
Other Status Codes	ErrorResponse	意外错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

List all configurations for a server

示例请求

HTTP

GET https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver/configurations?api-version=2024-12-30&page=1&pageSize=8

示例响应

状态代码:: 200

{
  "value": [
    {
      "name": "archive",
      "type": "Microsoft.DBforMySQL/flexibleServers/configurations",
      "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver/configurations/archive",
      "properties": {
        "description": "Tell the server to enable or disable archive engine.",
        "allowedValues": "ON,OFF",
        "dataType": "Enumeration",
        "defaultValue": "OFF",
        "isConfigPendingRestart": "False",
        "isDynamicConfig": "False",
        "isReadOnly": "True",
        "source": "system-default",
        "value": "OFF"
      }
    },
    {
      "name": "audit_log_enabled",
      "type": "Microsoft.DBforMySQL/flexibleServers/configurations",
      "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver/configurations/audit_log_enabled",
      "properties": {
        "description": "Allow to audit the log.",
        "allowedValues": "ON,OFF",
        "dataType": "Enumeration",
        "defaultValue": "OFF",
        "isConfigPendingRestart": "False",
        "isDynamicConfig": "True",
        "isReadOnly": "False",
        "source": "system-default",
        "value": "OFF"
      }
    },
    {
      "name": "audit_log_events",
      "type": "Microsoft.DBforMySQL/flexibleServers/configurations",
      "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver/configurations/audit_log_events",
      "properties": {
        "description": "Select the events to audit logs.",
        "allowedValues": "DDL,DML_SELECT,DML_NONSELECT,DCL,ADMIN,DML,GENERAL,CONNECTION,TABLE_ACCESS",
        "dataType": "Set",
        "defaultValue": "CONNECTION",
        "isConfigPendingRestart": "False",
        "isDynamicConfig": "True",
        "isReadOnly": "False",
        "source": "system-default",
        "value": "CONNECTION"
      }
    },
    {
      "name": "audit_log_exclude_users",
      "type": "Microsoft.DBforMySQL/flexibleServers/configurations",
      "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver/configurations/audit_log_exclude_users",
      "properties": {
        "description": "The comma-separated user list whose commands will not be in the audit logs.",
        "allowedValues": "",
        "dataType": "String",
        "defaultValue": "azure_superuser",
        "isConfigPendingRestart": "False",
        "isDynamicConfig": "True",
        "isReadOnly": "False",
        "source": "system-default",
        "value": "azure_superuser"
      }
    },
    {
      "name": "audit_log_include_users",
      "type": "Microsoft.DBforMySQL/flexibleServers/configurations",
      "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver/configurations/audit_log_include_users",
      "properties": {
        "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.",
        "allowedValues": "",
        "dataType": "String",
        "defaultValue": "",
        "isConfigPendingRestart": "False",
        "isDynamicConfig": "True",
        "isReadOnly": "False",
        "source": "system-default",
        "value": ""
      }
    },
    {
      "name": "audit_slow_log_enabled",
      "type": "Microsoft.DBforMySQL/flexibleServers/configurations",
      "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver/configurations/audit_slow_log_enabled",
      "properties": {
        "description": "Allow to audit the slow log.",
        "allowedValues": "ON,OFF",
        "dataType": "Enumeration",
        "defaultValue": "ON",
        "isConfigPendingRestart": "False",
        "isDynamicConfig": "True",
        "isReadOnly": "True",
        "source": "system-default",
        "value": "ON"
      }
    },
    {
      "name": "auto_generate_certs",
      "type": "Microsoft.DBforMySQL/flexibleServers/configurations",
      "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver/configurations/auto_generate_certs",
      "properties": {
        "description": "Controls whether the server autogenerates SSL key and certificate files in the data directory, if they do not already exist.",
        "allowedValues": "ON,OFF",
        "dataType": "Enumeration",
        "defaultValue": "OFF",
        "isConfigPendingRestart": "False",
        "isDynamicConfig": "False",
        "isReadOnly": "True",
        "source": "system-default",
        "value": "OFF"
      }
    },
    {
      "name": "auto_increment_increment",
      "type": "Microsoft.DBforMySQL/flexibleServers/configurations",
      "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver/configurations/auto_increment_increment",
      "properties": {
        "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.",
        "allowedValues": "1-65535",
        "dataType": "Integer",
        "defaultValue": "1",
        "isConfigPendingRestart": "False",
        "isDynamicConfig": "True",
        "isReadOnly": "False",
        "source": "system-default",
        "value": "1"
      }
    }
  ]
}

定义

名称	说明
Configuration	表示配置。
ConfigurationListResult	配置列表作的响应。
ConfigurationSource	配置的源。
createdByType	创建资源的标识的类型。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
IsConfigPendingRestart	配置是否处于待重启状态。
IsDynamicConfig	如果是配置动态。
IsReadOnly	如果是配置只读。
systemData	与创建和上次修改资源相关的元数据。

Configuration

Object

表示配置。

名称	类型	说明
id	string (arm-id)	资源的完全限定资源 ID。例如“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”
name	string	资源的名称
properties.allowedValues	string	配置的允许值。
properties.currentValue	string	配置的当前值。
properties.dataType	string	配置的数据类型。
properties.defaultValue	string	配置的默认值。
properties.description	string	配置的说明。
properties.documentationLink	string	用于从社区或 Azure 站点获取文档的链接。
properties.isConfigPendingRestart	IsConfigPendingRestart	配置是否处于待重启状态。
properties.isDynamicConfig	IsDynamicConfig	如果是配置动态。
properties.isReadOnly	IsReadOnly	如果是配置只读。
properties.source	ConfigurationSource	配置的源。
properties.value	string	配置的值。
systemData	systemData	包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。
type	string	资源类型。例如，“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

ConfigurationListResult

Object

配置列表作的响应。

名称	类型	说明
nextLink	string (uri)	指向下一页项目的链接
value	Configuration[]	此页面上的配置项

ConfigurationSource

枚举

配置的源。

值	说明
system-default
user-override

createdByType

枚举

创建资源的标识的类型。

值	说明
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetail

Object

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

Object

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。

IsConfigPendingRestart

枚举

配置是否处于待重启状态。

值	说明
True
False

IsDynamicConfig

枚举

如果是配置动态。

值	说明
True
False

IsReadOnly

枚举

如果是配置只读。

值	说明
True
False

systemData

Object

与创建和上次修改资源相关的元数据。

名称	类型	说明
createdAt	string (date-time)	资源创建时间戳（UTC）。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识的类型。
lastModifiedAt	string (date-time)	上次修改的资源时间戳（UTC）
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	createdByType	上次修改资源的标识的类型。

通过

Configurations - List By Server

URI 参数

响应

安全性

azure_auth

作用域

示例

List all configurations for a server

示例请求

示例响应

定义

Configuration

ConfigurationListResult

ConfigurationSource

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

IsConfigPendingRestart

IsDynamicConfig

IsReadOnly

systemData