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 パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
resource
|
path | True |
string |
リソース グループの名前。 名前の大文字と小文字は区別されます。 |
server
|
path | True |
string |
サーバーの名前。 正規表現パターン: |
subscription
|
path | True |
string uuid |
ターゲット サブスクリプションの ID。 値は UUID である必要があります。 |
api-version
|
query | True |
string |
この操作に使用する API バージョン。 |
keyword
|
query |
string |
サーバー構成のキーワード (keyword)。 |
|
page
|
query |
integer int32 |
サーバー構成のページ。 |
|
page
|
query |
integer int32 |
サーバー構成の pageSize。 |
|
tags
|
query |
string |
サーバー構成のタグ。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
OK |
|
Other Status Codes |
操作に失敗した理由を説明するエラー応答。 |
セキュリティ
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
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 |
構成を表します。 |
Configuration |
サーバー構成の一覧。 |
Configuration |
構成のソース。 |
created |
リソースを作成した ID の種類。 |
Error |
リソース管理エラーの追加情報。 |
Error |
エラーの詳細。 |
Error |
エラー応答 |
Is |
が構成保留中の再起動かどうか。 |
Is |
が構成の動的である場合。 |
Is |
が構成の読み取り専用である場合。 |
system |
リソースの作成と最後の変更に関連するメタデータ。 |
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 |
が構成保留中の再起動かどうか。 |
|
properties.isDynamicConfig |
が構成の動的である場合。 |
|
properties.isReadOnly |
が構成の読み取り専用である場合。 |
|
properties.source |
構成のソース。 |
|
properties.value |
string |
構成の値。 |
systemData |
createdBy および modifiedBy 情報を含む Azure Resource Manager メタデータ。 |
|
type |
string |
リソースの型。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts" |
ConfigurationListResult
サーバー構成の一覧。
名前 | 型 | 説明 |
---|---|---|
nextLink |
string |
操作の次のページを取得するために使用されるリンク。 |
value |
サーバー構成の一覧。 |
ConfigurationSource
構成のソース。
名前 | 型 | 説明 |
---|---|---|
system-default |
string |
|
user-override |
string |
createdByType
リソースを作成した ID の種類。
名前 | 型 | 説明 |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
ErrorAdditionalInfo
リソース管理エラーの追加情報。
名前 | 型 | 説明 |
---|---|---|
info |
object |
追加情報。 |
type |
string |
追加情報の種類。 |
ErrorDetail
エラーの詳細。
名前 | 型 | 説明 |
---|---|---|
additionalInfo |
エラーの追加情報。 |
|
code |
string |
エラー コード。 |
details |
エラーの詳細です。 |
|
message |
string |
エラー メッセージ。 |
target |
string |
エラーのターゲット。 |
ErrorResponse
エラー応答
名前 | 型 | 説明 |
---|---|---|
error |
error オブジェクト。 |
IsConfigPendingRestart
が構成保留中の再起動かどうか。
名前 | 型 | 説明 |
---|---|---|
False |
string |
|
True |
string |
IsDynamicConfig
が構成の動的である場合。
名前 | 型 | 説明 |
---|---|---|
False |
string |
|
True |
string |
IsReadOnly
が構成の読み取り専用である場合。
名前 | 型 | 説明 |
---|---|---|
False |
string |
|
True |
string |
systemData
リソースの作成と最後の変更に関連するメタデータ。
名前 | 型 | 説明 |
---|---|---|
createdAt |
string |
リソース作成のタイムスタンプ (UTC)。 |
createdBy |
string |
リソースを作成した ID。 |
createdByType |
リソースを作成した ID の種類。 |
|
lastModifiedAt |
string |
リソースの最終変更のタイムスタンプ (UTC) |
lastModifiedBy |
string |
リソースを最後に変更した ID。 |
lastModifiedByType |
リソースを最後に変更した ID の種類。 |