Configurations - Batch Update

Layanan:

MySQL

Versi API:

2023-06-01-preview

Memperbarui daftar konfigurasi di server tertentu.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/updateConfigurations?api-version=2023-06-01-preview

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
resourceGroupName	path	True	string	Nama grup sumber daya. Nama tidak peka huruf besar/kecil.
serverName	path	True	string	Nama server. Pola regex: ^[a-z0-9][-a-z0-9]*(?<!-)$
subscriptionId	path	True	string uuid	ID langganan target. Nilai harus UUID.
api-version	query	True	string	Versi API yang digunakan untuk operasi ini.

Isi Permintaan

Nama	Jenis	Deskripsi
resetAllToDefault	ResetAllToDefault	Apakah akan mengatur ulang semua parameter server ke default.
value	ConfigurationForBatchUpdate[]	Daftar konfigurasi server.

Respons

Nama	Jenis	Deskripsi
200 OK	ConfigurationListResult	OK
202 Accepted		Diterima
Other Status Codes	ErrorResponse	Respons kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

ConfigurationList

Permintaan sampel

HTTP

POST https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver/updateConfigurations?api-version=2023-06-01-preview

{
  "value": [
    {
      "name": "event_scheduler",
      "properties": {
        "value": "OFF"
      }
    },
    {
      "name": "div_precision_increment",
      "properties": {
        "value": "8"
      }
    }
  ],
  "resetAllToDefault": "False"
}

Java

import com.azure.resourcemanager.mysqlflexibleserver.models.ConfigurationForBatchUpdate;
import com.azure.resourcemanager.mysqlflexibleserver.models.ConfigurationListForBatchUpdate;
import com.azure.resourcemanager.mysqlflexibleserver.models.ResetAllToDefault;
import java.util.Arrays;

/**
 * Samples for Configurations BatchUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/mysql/resource-manager/Microsoft.DBforMySQL/Configurations/preview/2023-06-01-preview/examples/
     * ConfigurationsBatchUpdate.json
     */
    /**
     * Sample code: ConfigurationList.
     * 
     * @param manager Entry point to MySqlManager.
     */
    public static void configurationList(com.azure.resourcemanager.mysqlflexibleserver.MySqlManager manager) {
        manager.configurations().batchUpdate("testrg", "mysqltestserver",
            new ConfigurationListForBatchUpdate()
                .withValue(Arrays.asList(new ConfigurationForBatchUpdate().withName("event_scheduler").withValue("OFF"),
                    new ConfigurationForBatchUpdate().withName("div_precision_increment").withValue("8")))
                .withResetAllToDefault(ResetAllToDefault.FALSE),
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from typing import Any, IO, Union

from azure.identity import DefaultAzureCredential

from azure.mgmt.rdbms.mysql_flexibleservers import MySQLManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-rdbms
# USAGE
    python configurations_batch_update.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = MySQLManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="ffffffff-ffff-ffff-ffff-ffffffffffff",
    )

    response = client.configurations.begin_batch_update(
        resource_group_name="testrg",
        server_name="mysqltestserver",
        parameters={
            "resetAllToDefault": "False",
            "value": [
                {"name": "event_scheduler", "properties": {"value": "OFF"}},
                {"name": "div_precision_increment", "properties": {"value": "8"}},
            ],
        },
    ).result()
    print(response)


# x-ms-original-file: specification/mysql/resource-manager/Microsoft.DBforMySQL/Configurations/preview/2023-06-01-preview/examples/ConfigurationsBatchUpdate.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armmysqlflexibleservers_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/mysql/armmysqlflexibleservers/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/b8691fbfca8fcdc5a241a0b501c32fd4a76bb0cd/specification/mysql/resource-manager/Microsoft.DBforMySQL/Configurations/preview/2023-06-01-preview/examples/ConfigurationsBatchUpdate.json
func ExampleConfigurationsClient_BeginBatchUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armmysqlflexibleservers.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewConfigurationsClient().BeginBatchUpdate(ctx, "testrg", "mysqltestserver", armmysqlflexibleservers.ConfigurationListForBatchUpdate{
		ResetAllToDefault: to.Ptr(armmysqlflexibleservers.ResetAllToDefaultFalse),
		Value: []*armmysqlflexibleservers.ConfigurationForBatchUpdate{
			{
				Name: to.Ptr("event_scheduler"),
				Properties: &armmysqlflexibleservers.ConfigurationForBatchUpdateProperties{
					Value: to.Ptr("OFF"),
				},
			},
			{
				Name: to.Ptr("div_precision_increment"),
				Properties: &armmysqlflexibleservers.ConfigurationForBatchUpdateProperties{
					Value: to.Ptr("8"),
				},
			}},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ConfigurationListResult = armmysqlflexibleservers.ConfigurationListResult{
	// 	Value: []*armmysqlflexibleservers.Configuration{
	// 		{
	// 			Name: to.Ptr("event_scheduler"),
	// 			Type: to.Ptr("Microsoft.DBforMySQL/flexibleServers/configurations"),
	// 			ID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver/configurations/event_scheduler"),
	// 			Properties: &armmysqlflexibleservers.ConfigurationProperties{
	// 				Description: to.Ptr("Indicates the status of the Event Scheduler. It is always OFF for a replica server to keep the replication consistency."),
	// 				AllowedValues: to.Ptr("ON,OFF"),
	// 				DataType: to.Ptr("Enumeration"),
	// 				DefaultValue: to.Ptr("OFF"),
	// 				IsConfigPendingRestart: to.Ptr(armmysqlflexibleservers.IsConfigPendingRestartFalse),
	// 				IsDynamicConfig: to.Ptr(armmysqlflexibleservers.IsDynamicConfigTrue),
	// 				IsReadOnly: to.Ptr(armmysqlflexibleservers.IsReadOnlyFalse),
	// 				Source: to.Ptr(armmysqlflexibleservers.ConfigurationSourceUserOverride),
	// 				Value: to.Ptr("ON"),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("div_precision_increment"),
	// 			Type: to.Ptr("Microsoft.DBforMySQL/flexibleServers/configurations"),
	// 			ID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver/configurations/div_precision_increment"),
	// 			Properties: &armmysqlflexibleservers.ConfigurationProperties{
	// 				Description: to.Ptr("Number of digits by which to increase the scale of the result of division operations."),
	// 				AllowedValues: to.Ptr("0-30"),
	// 				DataType: to.Ptr("Integer"),
	// 				DefaultValue: to.Ptr("4"),
	// 				IsConfigPendingRestart: to.Ptr(armmysqlflexibleservers.IsConfigPendingRestartFalse),
	// 				IsDynamicConfig: to.Ptr(armmysqlflexibleservers.IsDynamicConfigTrue),
	// 				IsReadOnly: to.Ptr(armmysqlflexibleservers.IsReadOnlyFalse),
	// 				Source: to.Ptr(armmysqlflexibleservers.ConfigurationSourceUserOverride),
	// 				Value: to.Ptr("8"),
	// 			},
	// 	}},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { MySQLManagementFlexibleServerClient } = require("@azure/arm-mysql-flexible");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Update a list of configurations in a given server.
 *
 * @summary Update a list of configurations in a given server.
 * x-ms-original-file: specification/mysql/resource-manager/Microsoft.DBforMySQL/Configurations/preview/2023-06-01-preview/examples/ConfigurationsBatchUpdate.json
 */
async function configurationList() {
  const subscriptionId =
    process.env["MYSQL_SUBSCRIPTION_ID"] || "ffffffff-ffff-ffff-ffff-ffffffffffff";
  const resourceGroupName = process.env["MYSQL_RESOURCE_GROUP"] || "testrg";
  const serverName = "mysqltestserver";
  const parameters = {
    resetAllToDefault: "False",
    value: [
      { name: "event_scheduler", value: "OFF" },
      { name: "div_precision_increment", value: "8" },
    ],
  };
  const credential = new DefaultAzureCredential();
  const client = new MySQLManagementFlexibleServerClient(credential, subscriptionId);
  const result = await client.configurations.beginBatchUpdateAndWait(
    resourceGroupName,
    serverName,
    parameters,
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.MySql.FlexibleServers;
using Azure.ResourceManager.MySql.FlexibleServers.Models;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/mysql/resource-manager/Microsoft.DBforMySQL/Configurations/preview/2023-06-01-preview/examples/ConfigurationsBatchUpdate.json
// this example is just showing the usage of "Configurations_BatchUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this MySqlFlexibleServerResource created on azure
// for more information of creating MySqlFlexibleServerResource, please refer to the document of MySqlFlexibleServerResource
string subscriptionId = "ffffffff-ffff-ffff-ffff-ffffffffffff";
string resourceGroupName = "testrg";
string serverName = "mysqltestserver";
ResourceIdentifier mySqlFlexibleServerResourceId = MySqlFlexibleServerResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName);
MySqlFlexibleServerResource mySqlFlexibleServer = client.GetMySqlFlexibleServerResource(mySqlFlexibleServerResourceId);

// invoke the operation
MySqlFlexibleServerConfigurationListForBatchUpdate mySqlFlexibleServerConfigurationListForBatchUpdate = new MySqlFlexibleServerConfigurationListForBatchUpdate()
{
    Values =
    {
    new MySqlFlexibleServerConfigurationForBatchUpdate()
    {
    Name = "event_scheduler",
    Value = "OFF",
    },new MySqlFlexibleServerConfigurationForBatchUpdate()
    {
    Name = "div_precision_increment",
    Value = "8",
    }
    },
    ResetAllToDefault = MySqlFlexibleServerConfigurationResetAllToDefault.False,
};
ArmOperation<MySqlFlexibleServerConfigurations> lro = await mySqlFlexibleServer.UpdateConfigurationsAsync(WaitUntil.Completed, mySqlFlexibleServerConfigurationListForBatchUpdate);
MySqlFlexibleServerConfigurations result = lro.Value;

Console.WriteLine($"Succeeded: {result}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Respon sampel

Kode status:

200

{
  "value": [
    {
      "properties": {
        "value": "ON",
        "description": "Indicates the status of the Event Scheduler. It is always OFF for a replica server to keep the replication consistency.",
        "defaultValue": "OFF",
        "dataType": "Enumeration",
        "allowedValues": "ON,OFF",
        "source": "user-override",
        "isConfigPendingRestart": "False",
        "isDynamicConfig": "True",
        "isReadOnly": "False"
      },
      "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver/configurations/event_scheduler",
      "name": "event_scheduler",
      "type": "Microsoft.DBforMySQL/flexibleServers/configurations"
    },
    {
      "properties": {
        "value": "8",
        "description": "Number of digits by which to increase the scale of the result of division operations.",
        "defaultValue": "4",
        "dataType": "Integer",
        "allowedValues": "0-30",
        "source": "user-override",
        "isConfigPendingRestart": "False",
        "isDynamicConfig": "True",
        "isReadOnly": "False"
      },
      "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver/configurations/div_precision_increment",
      "name": "div_precision_increment",
      "type": "Microsoft.DBforMySQL/flexibleServers/configurations"
    }
  ]
}

Kode status:

202

Azure-AsyncOperation: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforMySQL/locations/southeastasia/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2023-06-01-preview
Location: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforMySQL/locations/southeastasia/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2023-06-01-preview

Definisi

Nama	Deskripsi
Configuration	Mewakili Konfigurasi.
ConfigurationForBatchUpdate	Mewakili Konfigurasi.
ConfigurationListForBatchUpdate	Daftar konfigurasi server yang akan diperbarui.
ConfigurationListResult	Daftar konfigurasi server.
ConfigurationSource	Sumber konfigurasi.
createdByType	Jenis identitas yang membuat sumber daya.
ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
ErrorDetail	Detail kesalahan.
ErrorResponse	Respons kesalahan
IsConfigPendingRestart	Jika konfigurasi tertunda mulai ulang atau tidak.
IsDynamicConfig	Jika adalah konfigurasi dinamis.
IsReadOnly	Jika adalah konfigurasi baca saja.
ResetAllToDefault	Apakah akan mengatur ulang semua parameter server ke default.
systemData	Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

Configuration

Mewakili Konfigurasi.

Nama	Jenis	Deskripsi
id	string	ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Misalnya "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Nama sumber daya.
properties.allowedValues	string	Nilai konfigurasi yang diizinkan.
properties.currentValue	string	Nilai konfigurasi saat ini.
properties.dataType	string	Jenis data konfigurasi.
properties.defaultValue	string	Nilai default konfigurasi.
properties.description	string	Deskripsi konfigurasi.
properties.documentationLink	string	Tautan yang digunakan untuk mendapatkan dokumen dari komunitas atau situs Azure.
properties.isConfigPendingRestart	IsConfigPendingRestart	Jika konfigurasi tertunda mulai ulang atau tidak.
properties.isDynamicConfig	IsDynamicConfig	Jika adalah konfigurasi dinamis.
properties.isReadOnly	IsReadOnly	Jika adalah konfigurasi baca saja.
properties.source	ConfigurationSource	Sumber konfigurasi.
properties.value	string	Nilai konfigurasi.
systemData	systemData	Metadata Azure Resource Manager yang berisi informasi createdBy dan modifiedBy.
type	string	Jenis sumber daya. Misalnya "Microsoft.Compute/virtualMachines" atau "Microsoft.Storage/storageAccounts"

ConfigurationForBatchUpdate

Mewakili Konfigurasi.

Nama	Jenis	Deskripsi
name	string	Nama konfigurasi.
properties.source	string	Sumber konfigurasi.
properties.value	string	Nilai konfigurasi.

ConfigurationListForBatchUpdate

Daftar konfigurasi server yang akan diperbarui.

Nama	Jenis	Deskripsi
resetAllToDefault	ResetAllToDefault	Apakah akan mengatur ulang semua parameter server ke default.
value	ConfigurationForBatchUpdate[]	Daftar konfigurasi server.

ConfigurationListResult

Daftar konfigurasi server.

Nama	Jenis	Deskripsi
nextLink	string	Tautan yang digunakan untuk mendapatkan halaman operasi berikutnya.
value	Configuration[]	Daftar konfigurasi server.

ConfigurationSource

Sumber konfigurasi.

Nama	Jenis	Deskripsi
system-default	string
user-override	string

createdByType

Jenis identitas yang membuat sumber daya.

Nama	Jenis	Deskripsi
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Info tambahan kesalahan manajemen sumber daya.

Nama	Jenis	Deskripsi
info	object	Info tambahan.
type	string	Jenis info tambahan.

ErrorDetail

Detail kesalahan.

Nama	Jenis	Deskripsi
additionalInfo	ErrorAdditionalInfo[]	Info tambahan kesalahan.
code	string	Kode kesalahan.
details	ErrorDetail[]	Detail kesalahan.
message	string	Pesan kesalahan.
target	string	Target kesalahan.

ErrorResponse

Respons kesalahan

Nama	Jenis	Deskripsi
error	ErrorDetail	Objek kesalahan.

IsConfigPendingRestart

Jika konfigurasi tertunda mulai ulang atau tidak.

Nama	Jenis	Deskripsi
False	string
True	string

IsDynamicConfig

Jika adalah konfigurasi dinamis.

Nama	Jenis	Deskripsi
False	string
True	string

IsReadOnly

Jika adalah konfigurasi baca saja.

Nama	Jenis	Deskripsi
False	string
True	string

ResetAllToDefault

Apakah akan mengatur ulang semua parameter server ke default.

Nama	Jenis	Deskripsi
False	string
True	string

systemData

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

Nama	Jenis	Deskripsi
createdAt	string	Tanda waktu pembuatan sumber daya (UTC).
createdBy	string	Identitas yang membuat sumber daya.
createdByType	createdByType	Jenis identitas yang membuat sumber daya.
lastModifiedAt	string	Tanda waktu modifikasi terakhir sumber daya (UTC)
lastModifiedBy	string	Identitas yang terakhir mengubah sumber daya.
lastModifiedByType	createdByType	Jenis identitas yang terakhir mengubah sumber daya.