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

Configurations - List By 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 参数

名称 必需 类型 说明
resourceGroupName
path True

string

资源组的名称。 此名称不区分大小写。

serverName
path True

string

服务器的名称。

正则表达式模式: ^[a-z0-9][-a-z0-9]*(?<!-)$

subscriptionId
path True

string

uuid

目标订阅的 ID。 该值必须是 UUID。

api-version
query True

string

要用于此操作的 API 版本。

keyword
query

string

服务器配置的关键字 (keyword) 。

page
query

integer

int32

服务器配置的页。

pageSize
query

integer

int32

服务器配置的 pageSize。

tags
query

string

服务器配置的标记。

响应

名称 类型 说明
200 OK

ConfigurationListResult

确定

Other Status Codes

ErrorResponse

描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

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

Scopes

名称 说明
user_impersonation 模拟用户帐户

示例

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"
    }
  ]
}

定义

名称 说明
Configuration

表示配置。

ConfigurationListResult

服务器配置列表。

ConfigurationSource

配置的源。

createdByType

创建资源的标识类型。

ErrorAdditionalInfo

资源管理错误附加信息。

ErrorDetail

错误详细信息。

ErrorResponse

错误响应

IsConfigPendingRestart

如果 为配置等待重启,则为 。

IsDynamicConfig

如果 是配置动态的。

IsReadOnly

如果 为 ,则配置为只读。

systemData

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

Configuration

表示配置。

名称 类型 说明
id

string

资源的完全限定的资源 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

服务器配置列表。

名称 类型 说明
nextLink

string

用于获取下一页操作的链接。

value

Configuration[]

服务器配置列表。

ConfigurationSource

配置的源。

名称 类型 说明
system-default

string

user-override

string

createdByType

创建资源的标识类型。

名称 类型 说明
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorAdditionalInfo

资源管理错误附加信息。

名称 类型 说明
info

object

其他信息。

type

string

其他信息类型。

ErrorDetail

错误详细信息。

名称 类型 说明
additionalInfo

ErrorAdditionalInfo[]

错误附加信息。

code

string

错误代码。

details

ErrorDetail[]

错误详细信息。

message

string

错误消息。

target

string

错误目标。

ErrorResponse

错误响应

名称 类型 说明
error

ErrorDetail

错误对象。

IsConfigPendingRestart

如果 为配置等待重启,则为 。

名称 类型 说明
False

string

True

string

IsDynamicConfig

如果 是配置动态的。

名称 类型 说明
False

string

True

string

IsReadOnly

如果 为 ,则配置为只读。

名称 类型 说明
False

string

True

string

systemData

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

名称 类型 说明
createdAt

string

资源创建时间戳 (UTC) 。

createdBy

string

创建资源的标识。

createdByType

createdByType

创建资源的标识类型。

lastModifiedAt

string

资源上次修改的时间戳 (UTC)

lastModifiedBy

string

上次修改资源的标识。

lastModifiedByType

createdByType

上次修改资源的标识类型。