Share via


Configurations - List By Server

Listet alle Konfigurationen auf einem bestimmten Server auf.

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-Parameter

Name In Erforderlich Typ Beschreibung
resourceGroupName
path True

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

serverName
path True

string

Name des Servers

Regex pattern: ^[a-z0-9][-a-z0-9]*(?<!-)$

subscriptionId
path True

string

uuid

Hierbei handelt es sich um die ID des Zielabonnements. Der Wert muss eine UUID sein.

api-version
query True

string

Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

keyword
query

string

Die Schlüsselwort (keyword) der Serverkonfiguration.

page
query

integer

int32

Die Seite der Serverkonfiguration.

pageSize
query

integer

int32

Die pageSize der Serverkonfiguration.

tags
query

string

Die Tags der Serverkonfiguration.

Antworten

Name Typ Beschreibung
200 OK

ConfigurationListResult

OK

Other Status Codes

ErrorResponse

Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

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

Scopes

Name Beschreibung
user_impersonation Identitätswechsel Ihres Benutzerkontos

Beispiele

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

Definitionen

Name Beschreibung
Configuration

Stellt eine Konfiguration dar.

ConfigurationListResult

Eine Liste der Serverkonfigurationen.

ConfigurationSource

Quelle der Konfiguration.

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.

ErrorDetail

Die Fehlerdetails.

ErrorResponse

Fehlerantwort

IsConfigPendingRestart

Gibt an, ob der Neustart der Konfiguration aussteht oder nicht.

IsDynamicConfig

Wenn die Konfigurationsdynamik ist.

IsReadOnly

Wenn die Konfiguration schreibgeschützter Wert ist.

systemData

Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

Configuration

Stellt eine Konfiguration dar.

Name Typ Beschreibung
id

string

Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

name

string

Der Name der Ressource

properties.allowedValues

string

Zulässige Werte der Konfiguration.

properties.currentValue

string

Aktueller Wert der Konfiguration.

properties.dataType

string

Datentyp der Konfiguration.

properties.defaultValue

string

Standardwert der Konfiguration.

properties.description

string

Beschreibung der Konfiguration.

properties.documentationLink

string

Der Link, der verwendet wird, um das Dokument von der Community oder azure-Website abzurufen.

properties.isConfigPendingRestart

IsConfigPendingRestart

Gibt an, ob der Neustart der Konfiguration aussteht oder nicht.

properties.isDynamicConfig

IsDynamicConfig

Wenn die Konfigurationsdynamik ist.

properties.isReadOnly

IsReadOnly

Wenn die Konfiguration schreibgeschützter Wert ist.

properties.source

ConfigurationSource

Quelle der Konfiguration.

properties.value

string

Wert der Konfiguration.

systemData

systemData

Azure Resource Manager-Metadaten mit createdBy- und modifiedBy-Informationen.

type

string

Der Typ der Ressource. Z.B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

ConfigurationListResult

Eine Liste der Serverkonfigurationen.

Name Typ Beschreibung
nextLink

string

Der Link, der verwendet wird, um die nächste Seite von Vorgängen abzurufen.

value

Configuration[]

Die Liste der Serverkonfigurationen.

ConfigurationSource

Quelle der Konfiguration.

Name Typ Beschreibung
system-default

string

user-override

string

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

Name Typ Beschreibung
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.

Name Typ Beschreibung
info

object

Zusätzliche Informationen.

type

string

Typ der zusätzlichen Informationen.

ErrorDetail

Die Fehlerdetails.

Name Typ Beschreibung
additionalInfo

ErrorAdditionalInfo[]

Die zusätzlichen Fehlerinformationen.

code

string

Der Fehlercode.

details

ErrorDetail[]

Die Fehlerdetails.

message

string

Die Fehlermeldung.

target

string

Das Fehlerziel.

ErrorResponse

Fehlerantwort

Name Typ Beschreibung
error

ErrorDetail

Das Fehlerobjekt.

IsConfigPendingRestart

Gibt an, ob der Neustart der Konfiguration aussteht oder nicht.

Name Typ Beschreibung
False

string

True

string

IsDynamicConfig

Wenn die Konfigurationsdynamik ist.

Name Typ Beschreibung
False

string

True

string

IsReadOnly

Wenn die Konfiguration schreibgeschützter Wert ist.

Name Typ Beschreibung
False

string

True

string

systemData

Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

Name Typ Beschreibung
createdAt

string

Der Zeitstempel der Ressourcenerstellung (UTC).

createdBy

string

Die Identität, die die Ressource erstellt hat.

createdByType

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

lastModifiedAt

string

Der Zeitstempel der letzten Änderung der Ressource (UTC)

lastModifiedBy

string

Die Identität, die die Ressource zuletzt geändert hat.

lastModifiedByType

createdByType

Der Identitätstyp, der die Ressource zuletzt geändert hat.