Database Automatic Tuning - Update

Layanan:

SQL Database

Versi API:

2023-08-01

Perbarui properti penyetelan otomatis untuk database target.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/automaticTuning/current?api-version=2023-08-01

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
databaseName	path	True	string	Nama database.
resourceGroupName	path	True	string	Nama grup sumber daya yang berisi sumber daya. Anda dapat memperoleh nilai ini dari API Azure Resource Manager atau portal.
serverName	path	True	string	Nama server.
subscriptionId	path	True	string	ID langganan yang mengidentifikasi langganan Azure.
api-version	query	True	string	Versi API yang akan digunakan untuk permintaan tersebut.

Isi Permintaan

Nama	Jenis	Deskripsi
properties.desiredState	AutomaticTuningMode	Status penyetelan otomatis yang diinginkan.
properties.options	<string,  AutomaticTuningOptions>	Definisi opsi penyetelan otomatis.

Respons

Nama	Jenis	Deskripsi
200 OK	DatabaseAutomaticTuning	Berhasil memperbarui pengaturan penyetelan otomatis database yang ditentukan.
Other Status Codes	ErrorResponse	Respons Kesalahan: *** 400 FeatureDisabledOnSelectedEdition - Pengguna mencoba menggunakan fitur yang dinonaktifkan pada edisi database saat ini. 400 InvalidIdentifier - Pengidentifikasi berisi NULL atau karakter unicode yang tidak valid. 400 SystemDatabasesNotSupported - Pengguna mencoba mendapatkan informasi penyetelan otomatis pada database sistem. 400 DataWarehouseNotSupported - Penyetelan otomatis tidak didukung untuk Gudang Data SQL. 400 InvalidAutomaticTuningUpsertRequest - Isi permintaan penyetelan otomatis pembaruan tidak ada atau tidak memiliki objek properti. 400 InvalidAdvisorAutoExecuteStatus - Status eksekusi otomatis yang ditentukan untuk penasihat tidak diizinkan. 404 SubscriptionDoesNotHaveServer - Server yang diminta tidak ditemukan 404 DatabaseDoesNotExist - Database yang diminta tidak ditemukan 404 SubscriptionDoesNotHaveElasticPool - Kumpulan elastis yang diminta tidak ditemukan 404 OperationIdNotFound - Operasi dengan Id tidak ada. 404 AutomaticTuningOptionNotFound - Opsi penyetelan otomatis yang diminta tidak ditemukan. 405 NotSupported - Fungsionalitas ini tidak didukung. 409 Konflik - Permintaan tidak dapat diproses karena konflik dalam permintaan. 409 CannotCancelOperation - Operasi manajemen dalam keadaan yang tidak dapat dibatalkan. 409 OperationCancelled - Operasi telah dibatalkan oleh pengguna. 409 OperationInterrupted - Operasi pada sumber daya tidak dapat diselesaikan karena terganggu oleh operasi lain pada sumber daya yang sama. 409 DefaultAdvisorStateNotAllowedInCustomDbMode - Status penasihat DEFAULT tidak diizinkan dalam mode KUSTOM 409 DisabledBySystem - Opsi ini dinonaktifkan oleh sistem 429 SubscriptionTooManyCreateUpdateRequests - Permintaan di luar permintaan maks yang dapat diproses oleh sumber daya yang tersedia. 429 SubscriptionTooManyRequests - Permintaan di luar permintaan maks yang dapat diproses oleh sumber daya yang tersedia. 500 OperationTimedOut - Waktu operasi habis dan secara otomatis digulung balik. Silakan coba lagi operasi ini. 503 ServiceTemporarilyUnavailable - Fitur sementara tidak tersedia. 503 TooManyRequests - Permintaan di luar permintaan maks yang dapat diproses oleh sumber daya yang tersedia.

Contoh

Updates database automatic tuning settings with all properties

Updates database automatic tuning settings with minimal properties

Updates database automatic tuning settings with all properties

Permintaan sampel

HTTP

PATCH https://management.azure.com/subscriptions/c3aa9078-0000-0000-0000-e36f151182d7/resourceGroups/default-sql-onebox/providers/Microsoft.Sql/servers/testsvr11/databases/db1/automaticTuning/current?api-version=2023-08-01

{
  "properties": {
    "desiredState": "Auto",
    "options": {
      "createIndex": {
        "desiredState": "Off"
      },
      "dropIndex": {
        "desiredState": "On"
      },
      "forceLastGoodPlan": {
        "desiredState": "Default"
      }
    }
  }
}

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/DatabaseAutomaticTuningUpdateMax.json
// this example is just showing the usage of "DatabaseAutomaticTuning_Update" 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 SqlDatabaseAutomaticTuningResource created on azure
// for more information of creating SqlDatabaseAutomaticTuningResource, please refer to the document of SqlDatabaseAutomaticTuningResource
string subscriptionId = "c3aa9078-0000-0000-0000-e36f151182d7";
string resourceGroupName = "default-sql-onebox";
string serverName = "testsvr11";
string databaseName = "db1";
ResourceIdentifier sqlDatabaseAutomaticTuningResourceId = SqlDatabaseAutomaticTuningResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, databaseName);
SqlDatabaseAutomaticTuningResource sqlDatabaseAutomaticTuning = client.GetSqlDatabaseAutomaticTuningResource(sqlDatabaseAutomaticTuningResourceId);

// invoke the operation
SqlDatabaseAutomaticTuningData data = new SqlDatabaseAutomaticTuningData
{
    DesiredState = AutomaticTuningMode.Auto,
    Options =
    {
    ["createIndex"] = new AutomaticTuningOptions
    {
    DesiredState = AutomaticTuningOptionModeDesired.Off,
    },
    ["dropIndex"] = new AutomaticTuningOptions
    {
    DesiredState = AutomaticTuningOptionModeDesired.On,
    },
    ["forceLastGoodPlan"] = new AutomaticTuningOptions
    {
    DesiredState = AutomaticTuningOptionModeDesired.Default,
    }
    },
};
SqlDatabaseAutomaticTuningResource result = await sqlDatabaseAutomaticTuning.UpdateAsync(data);

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
SqlDatabaseAutomaticTuningData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

{
  "id": "/subscriptions/c3aa9078-0000-0000-0000-e36f151182d7/resourceGroups/default-sql-onebox/providers/Microsoft.Sql/servers/testsvr11/databases/db1/automaticTuning/current",
  "name": "current",
  "type": "Microsoft.Sql/servers/databases/automaticTuning",
  "properties": {
    "desiredState": "Auto",
    "actualState": "Auto",
    "options": {
      "forceLastGoodPlan": {
        "desiredState": "Default",
        "actualState": "On",
        "reasonCode": 2,
        "reasonDesc": "AutoConfigured"
      },
      "createIndex": {
        "desiredState": "Off",
        "actualState": "Off"
      },
      "dropIndex": {
        "desiredState": "On",
        "actualState": "On"
      },
      "maintainIndex": {
        "desiredState": "Default",
        "actualState": "Off",
        "reasonCode": 2,
        "reasonDesc": "AutoConfigured"
      }
    }
  }
}

Updates database automatic tuning settings with minimal properties

Permintaan sampel

HTTP

PATCH https://management.azure.com/subscriptions/c3aa9078-0000-0000-0000-e36f151182d7/resourceGroups/default-sql-onebox/providers/Microsoft.Sql/servers/testsvr11/databases/db1/automaticTuning/current?api-version=2023-08-01

{
  "properties": {
    "desiredState": "Auto"
  }
}

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/DatabaseAutomaticTuningUpdateMin.json
// this example is just showing the usage of "DatabaseAutomaticTuning_Update" 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 SqlDatabaseAutomaticTuningResource created on azure
// for more information of creating SqlDatabaseAutomaticTuningResource, please refer to the document of SqlDatabaseAutomaticTuningResource
string subscriptionId = "c3aa9078-0000-0000-0000-e36f151182d7";
string resourceGroupName = "default-sql-onebox";
string serverName = "testsvr11";
string databaseName = "db1";
ResourceIdentifier sqlDatabaseAutomaticTuningResourceId = SqlDatabaseAutomaticTuningResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, databaseName);
SqlDatabaseAutomaticTuningResource sqlDatabaseAutomaticTuning = client.GetSqlDatabaseAutomaticTuningResource(sqlDatabaseAutomaticTuningResourceId);

// invoke the operation
SqlDatabaseAutomaticTuningData data = new SqlDatabaseAutomaticTuningData
{
    DesiredState = AutomaticTuningMode.Auto,
};
SqlDatabaseAutomaticTuningResource result = await sqlDatabaseAutomaticTuning.UpdateAsync(data);

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
SqlDatabaseAutomaticTuningData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

{
  "id": "/subscriptions/c3aa9078-0000-0000-0000-e36f151182d7/resourceGroups/default-sql-onebox/providers/Microsoft.Sql/servers/testsvr11/databases/db1/automaticTuning/current",
  "name": "current",
  "type": "Microsoft.Sql/servers/databases/automaticTuning",
  "properties": {
    "desiredState": "Auto",
    "actualState": "Auto",
    "options": {
      "forceLastGoodPlan": {
        "desiredState": "Default",
        "actualState": "On",
        "reasonCode": 2,
        "reasonDesc": "AutoConfigured"
      },
      "createIndex": {
        "desiredState": "Default",
        "actualState": "On",
        "reasonCode": 2,
        "reasonDesc": "AutoConfigured"
      },
      "dropIndex": {
        "desiredState": "Default",
        "actualState": "Off",
        "reasonCode": 2,
        "reasonDesc": "AutoConfigured"
      },
      "maintainIndex": {
        "desiredState": "Default",
        "actualState": "Off",
        "reasonCode": 2,
        "reasonDesc": "AutoConfigured"
      }
    }
  }
}

Definisi

Nama	Deskripsi
AutomaticTuningDisabledReason	Deskripsi alasan jika diinginkan dan status aktual berbeda.
AutomaticTuningMode	Status penyetelan otomatis yang diinginkan.
AutomaticTuningOptionModeActual	Status aktual opsi penyetelan otomatis.
AutomaticTuningOptionModeDesired	Status yang diinginkan opsi penyetelan otomatis.
AutomaticTuningOptions	Properti penyetelan otomatis untuk penasihat individual.
DatabaseAutomaticTuning	Penyetelan Otomatis tingkat database.
ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
ErrorDetail	Detail kesalahan.
ErrorResponse	Respons kesalahan

AutomaticTuningDisabledReason

Enumeration

Deskripsi alasan jika diinginkan dan status aktual berbeda.

Nilai	Deskripsi
Default
Disabled
AutoConfigured
InheritedFromServer
QueryStoreOff
QueryStoreReadOnly
NotSupported

AutomaticTuningMode

Enumeration

Status penyetelan otomatis yang diinginkan.

Nilai	Deskripsi
Inherit
Custom
Auto
Unspecified

AutomaticTuningOptionModeActual

Enumeration

Status aktual opsi penyetelan otomatis.

Nilai	Deskripsi
Off
On

AutomaticTuningOptionModeDesired

Enumeration

Status yang diinginkan opsi penyetelan otomatis.

Nilai	Deskripsi
Off
On
Default

AutomaticTuningOptions

Objek

Properti penyetelan otomatis untuk penasihat individual.

Nama	Jenis	Deskripsi
actualState	AutomaticTuningOptionModeActual	Status aktual opsi penyetelan otomatis.
desiredState	AutomaticTuningOptionModeDesired	Status yang diinginkan opsi penyetelan otomatis.
reasonCode	integer (int32)	Kode alasan jika diinginkan dan status aktual berbeda.
reasonDesc	AutomaticTuningDisabledReason	Deskripsi alasan jika diinginkan dan status aktual berbeda.

DatabaseAutomaticTuning

Objek

Penyetelan Otomatis tingkat database.

Nama	Jenis	Deskripsi
id	string	ID Sumber Daya.
name	string	Nama sumber daya.
properties.actualState	AutomaticTuningMode	Status aktual penyetelan otomatis.
properties.desiredState	AutomaticTuningMode	Status penyetelan otomatis yang diinginkan.
properties.options	<string,  AutomaticTuningOptions>	Definisi opsi penyetelan otomatis.
type	string	Jenis sumber daya.

ErrorAdditionalInfo

Objek

Info tambahan kesalahan manajemen sumber daya.

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

ErrorDetail

Objek

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

Objek

Respons kesalahan

Nama	Jenis	Deskripsi
error	ErrorDetail	Objek kesalahan.