Database Automatic Tuning - Update

Service:

SQL Database

API Version:

2021-11-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=2021-11-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 Azure Resource Manager API 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 digunakan untuk permintaan.

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		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 advisor tidak diizinkan. 404 DatabaseDoesNotExist - Database yang diminta tidak ditemukan 404 SubscriptionDoesNotHaveServer - Server 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 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 DisabledBySystem - Opsi ini dinonaktifkan oleh sistem 409 DefaultAdvisorStateNotAllowedInCustomDbMode - Status penasihat DEFAULT tidak diizinkan dalam mode KUSTOM 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. Coba lagi operasi ini. 503 ServiceTemporarilyUnavailable - Fitur untuk 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

Sample Request

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=2021-11-01

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

Java

import com.azure.core.util.Context;
import com.azure.resourcemanager.sql.fluent.models.DatabaseAutomaticTuningInner;
import com.azure.resourcemanager.sql.models.AutomaticTuningMode;
import com.azure.resourcemanager.sql.models.AutomaticTuningOptionModeDesired;
import com.azure.resourcemanager.sql.models.AutomaticTuningOptions;
import java.util.HashMap;
import java.util.Map;

/** Samples for DatabaseAutomaticTuning Update. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/DatabaseAutomaticTuningUpdateMax.json
     */
    /**
     * Sample code: Updates database automatic tuning settings with all properties.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        updatesDatabaseAutomaticTuningSettingsWithAllProperties(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getDatabaseAutomaticTunings().updateWithResponse(
            "default-sql-onebox", "testsvr11", "db1",
            new DatabaseAutomaticTuningInner().withDesiredState(AutomaticTuningMode.AUTO)
                .withOptions(mapOf("createIndex",
                    new AutomaticTuningOptions().withDesiredState(AutomaticTuningOptionModeDesired.OFF), "dropIndex",
                    new AutomaticTuningOptions().withDesiredState(AutomaticTuningOptionModeDesired.ON),
                    "forceLastGoodPlan",
                    new AutomaticTuningOptions().withDesiredState(AutomaticTuningOptionModeDesired.DEFAULT))),
            Context.NONE);
    }

    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

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

Sample Response

Status code:

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

Sample Request

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=2021-11-01

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

Java

import com.azure.core.util.Context;
import com.azure.resourcemanager.sql.fluent.models.DatabaseAutomaticTuningInner;
import com.azure.resourcemanager.sql.models.AutomaticTuningMode;
import java.util.HashMap;
import java.util.Map;

/** Samples for DatabaseAutomaticTuning Update. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/DatabaseAutomaticTuningUpdateMin.json
     */
    /**
     * Sample code: Updates database automatic tuning settings with minimal properties.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void updatesDatabaseAutomaticTuningSettingsWithMinimalProperties(
        com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getDatabaseAutomaticTunings().updateWithResponse(
            "default-sql-onebox", "testsvr11", "db1",
            new DatabaseAutomaticTuningInner().withDesiredState(AutomaticTuningMode.AUTO), Context.NONE);
    }

    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

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

Sample Response

Status code:

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 individu.
DatabaseAutomaticTuning	Penyetelan Otomatis tingkat database.

AutomaticTuningDisabledReason

Deskripsi alasan jika diinginkan dan status aktual berbeda.

Nama	Jenis	Deskripsi
AutoConfigured	string
Default	string
Disabled	string
InheritedFromServer	string
NotSupported	string
QueryStoreOff	string
QueryStoreReadOnly	string

AutomaticTuningMode

Status penyetelan otomatis yang diinginkan.

Nama	Jenis	Deskripsi
Auto	string
Custom	string
Inherit	string
Unspecified	string

AutomaticTuningOptionModeActual

Status aktual opsi penyetelan otomatis.

Nama	Jenis	Deskripsi
Off	string
On	string

AutomaticTuningOptionModeDesired

Status yang diinginkan opsi penyetelan otomatis.

Nama	Jenis	Deskripsi
Default	string
Off	string
On	string

AutomaticTuningOptions

Properti penyetelan otomatis untuk penasihat individu.

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

DatabaseAutomaticTuning

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