Database Automatic Tuning - Update

Service:

SQL Database

API Version:

2021-11-01

Aktualizowanie właściwości automatycznego dostrajania dla docelowej bazy danych.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
databaseName	path	True	string	Nazwa bazy danych.
resourceGroupName	path	True	string	Nazwa grupy zasobów zawierającej zasób. Tę wartość można uzyskać z interfejsu API usługi Azure Resource Manager lub portalu.
serverName	path	True	string	Nazwa serwera.
subscriptionId	path	True	string	Identyfikator subskrypcji identyfikujący subskrypcję platformy Azure.
api-version	query	True	string	Wersja interfejsu API do użycia dla żądania.

Treść żądania

Nazwa	Typ	Opis
properties.desiredState	AutomaticTuningMode	Żądany stan automatycznego dostrajania.
properties.options	<string,  AutomaticTuningOptions>	Definicja opcji automatycznego dostrajania.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	DatabaseAutomaticTuning	Pomyślnie zaktualizowano określone ustawienia automatycznego dostrajania bazy danych.
Other Status Codes		Odpowiedzi na błędy: *** 400 FeatureDisabledOnSelectedEdition — użytkownik próbował użyć funkcji wyłączonej w bieżącej wersji bazy danych. 400 InvalidIdentifier — identyfikator zawiera wartość NULL lub nieprawidłowy znak Unicode. 400 SystemDatabasesNotSupported — użytkownik próbował uzyskać informacje o automatycznym dostrajaniu w systemowych bazach danych. 400 DataWarehouseNotSupported — automatyczne dostrajanie nie jest obsługiwane w przypadku Data Warehouse SQL. 400 InvalidAutomaticTuningUpsertRequest — treść żądania automatycznego dostrajania aktualizacji nie istnieje lub nie ma obiektu właściwości. 400 InvalidAdvisorAutoExecuteStatus — określony stan automatycznego wykonywania dla doradcy jest niedozwolony. 404 DatabaseDoesNotExist — nie można odnaleźć żądanej bazy danych 404 SubscriptionDoesNotHaveServer — nie znaleziono żądanego serwera 404 SubscriptionDoesNotHaveElasticPool — nie znaleziono żądanej elastycznej puli 404 OperationIdNotFound — operacja o identyfikatorze nie istnieje. 404 AutomaticTuningOptionNotFound — nie znaleziono żądanej opcji automatycznego dostrajania. 405 NotSupported — ta funkcja nie jest obsługiwana. 409 Konflikt — nie można przetworzyć żądania z powodu konfliktu w żądaniu. 409 OperationCancelled — operacja została anulowana przez użytkownika. 409 Operacja przerwana — nie można ukończyć operacji na zasobie, ponieważ została przerwana przez inną operację na tym samym zasobie. 409 DisabledBySystem — ta opcja jest wyłączona przez system 409 DefaultAdvisorStateNotAllowedInCustomDbMode — stan doradcy DOMYŚLNEgo nie jest dozwolony w trybie NIESTANDARDOWYm 429 SubscriptionTooManyCreateUpdateRequests — żądania wykraczające poza maksymalne żądania, które mogą być przetwarzane przez dostępne zasoby. 429 SubscriptionTooManyRequests — żądania wykraczające poza maksymalną liczbę żądań, które mogą być przetwarzane przez dostępne zasoby. 500 OperationTimedOut — upłynął limit czasu operacji i automatycznie wycofano. Ponów próbę wykonania operacji. 503 ServiceTemporarilyUnavailable — funkcja jest tymczasowo niedostępna. 503 TooManyRequests — żądania wykraczające poza maksymalne żądania, które mogą być przetwarzane przez dostępne zasoby.

Przykłady

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

Definicje

Nazwa	Opis
AutomaticTuningDisabledReason	Opis przyczyny w razie potrzeby i rzeczywisty stan są różne.
AutomaticTuningMode	Żądany stan automatycznego dostrajania.
AutomaticTuningOptionModeActual	Stan rzeczywisty opcji automatycznego dostrajania.
AutomaticTuningOptionModeDesired	Żądany stan opcji automatycznego dostrajania.
AutomaticTuningOptions	Właściwości automatycznego dostrajania dla poszczególnych doradców.
DatabaseAutomaticTuning	Automatyczne dostrajanie na poziomie bazy danych.

AutomaticTuningDisabledReason

Opis przyczyny w razie potrzeby i rzeczywisty stan są różne.

Nazwa	Typ	Opis
AutoConfigured	string
Default	string
Disabled	string
InheritedFromServer	string
NotSupported	string
QueryStoreOff	string
QueryStoreReadOnly	string

AutomaticTuningMode

Żądany stan automatycznego dostrajania.

Nazwa	Typ	Opis
Auto	string
Custom	string
Inherit	string
Unspecified	string

AutomaticTuningOptionModeActual

Stan rzeczywisty opcji automatycznego dostrajania.

Nazwa	Typ	Opis
Off	string
On	string

AutomaticTuningOptionModeDesired

Żądany stan opcji automatycznego dostrajania.

Nazwa	Typ	Opis
Default	string
Off	string
On	string

AutomaticTuningOptions

Właściwości automatycznego dostrajania dla poszczególnych doradców.

Nazwa	Typ	Opis
actualState	AutomaticTuningOptionModeActual	Stan rzeczywisty opcji automatycznego dostrajania.
desiredState	AutomaticTuningOptionModeDesired	Żądany stan opcji automatycznego dostrajania.
reasonCode	integer	Kod przyczyny w razie potrzeby i rzeczywisty stan są różne.
reasonDesc	AutomaticTuningDisabledReason	Opis przyczyny w razie potrzeby i rzeczywisty stan są różne.

DatabaseAutomaticTuning

Automatyczne dostrajanie na poziomie bazy danych.

Nazwa	Typ	Opis
id	string	Identyfikator zasobu.
name	string	Nazwa zasobu.
properties.actualState	AutomaticTuningMode	Automatyczne dostrajanie stanu rzeczywistego.
properties.desiredState	AutomaticTuningMode	Żądany stan automatycznego dostrajania.
properties.options	<string,  AutomaticTuningOptions>	Definicja opcji automatycznego dostrajania.
type	string	Typ zasobu.