Database Automatic Tuning - Update

Služba:

SQL Database

Verze rozhraní API:

2021-11-01

Aktualizujte vlastnosti automatického ladění pro cílovou databázi.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
databaseName	path	True	string	Název databáze.
resourceGroupName	path	True	string	Název skupiny prostředků, která obsahuje prostředek. Tuto hodnotu můžete získat z rozhraní API Azure Resource Manageru nebo portálu.
serverName	path	True	string	Název serveru.
subscriptionId	path	True	string	ID předplatného, které identifikuje předplatné Azure.
api-version	query	True	string	Verze rozhraní API, která se má použít pro požadavek.

Text požadavku

Name	Typ	Description
properties.desiredState	AutomaticTuningMode	Požadovaný stav automatického ladění
properties.options	<string,  AutomaticTuningOptions>	Definice možností automatického ladění

Odpovědi

Name	Typ	Description
200 OK	DatabaseAutomaticTuning	Nastavení automatického ladění zadané databáze bylo úspěšně aktualizováno.
Other Status Codes		Chybové odpovědi: *** 400 FeatureDisabledOnSelectedEdition – Uživatel se pokusil použít funkci, která je v aktuální edici databáze zakázaná. 400 InvalidIdentifier – identifikátor obsahuje hodnotu NULL nebo neplatný znak unicode. 400 SystemDatabasesNotSupported – Uživatel se pokusil získat informace o automatickém ladění systémových databází. 400 DataWarehouseNotSupported – Sql Data Warehouse nepodporuje automatické ladění. 400 InvalidAutomaticTuningUpsertRequest – tělo požadavku automatického ladění aktualizace neexistuje nebo nemá žádný objekt vlastností. 400 InvalidAdvisorAutoExecuteStatus – Zadaný stav automatického spuštění pro poradce není povolený. 404 DatabaseDoesNotExist – Požadovaná databáze nebyla nalezena. 404 SubscriptionDoesNotHaveServer – Požadovaný server nebyl nalezen. 404 SubscriptionDoesNotHaveElasticPool – Požadovaný elastický fond nebyl nalezen. 404 OperationIdNotFound – operace s ID neexistuje. 404 AutomaticTuningOptionNotFound – Požadovaná možnost automatického ladění nebyla nalezena. 405 NotSupported – Tato funkce není podporována. 409 Konflikt – Požadavek nelze zpracovat kvůli konfliktu v požadavku. 409 OperationCancelled - Operace byla zrušena uživatelem. 409 OperationInterrupted – operaci s prostředkem nebylo možné dokončit, protože byla přerušena jinou operací na stejném prostředku. 409 DisabledBySystem – Tato možnost je zakázána systémem. 409 DefaultAdvisorStateNotAllowedInCustomDbMode – výchozí stav poradce není v vlastním režimu povolený 429 SubscriptionTooManyCreateUpdateRequests – Požadavky nad rámec maximálních požadavků, které je možné zpracovat dostupnými prostředky. 429 SubscriptionTooManyRequests – Požadavky nad rámec maximálních požadavků, které je možné zpracovat dostupnými prostředky. 500 OperationTimedOut – Vypršel časový limit operace a automaticky se vrátil zpět. Zkuste operaci zopakovat. 503 ServiceTemporarilyUnavailable – Funkce je dočasně nedostupná. 503 TooManyRequests – Požadavky nad rámec maximálních požadavků, které je možné zpracovat dostupnými prostředky.

Příklady

Updates database automatic tuning settings with all properties

Updates database automatic tuning settings with minimal properties

Updates database automatic tuning settings with all properties

Ukázkový požadavek

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.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))),
            com.azure.core.util.Context.NONE);
    }

    // Use "Map.of" if available
    @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

Ukázková odpověď

Stavový kód:

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

Ukázkový požadavek

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.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),
            com.azure.core.util.Context.NONE);
    }

    // Use "Map.of" if available
    @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

Ukázková odpověď

Stavový kód:

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

Definice

Name	Description
AutomaticTuningDisabledReason	Popis důvodu, pokud se požadovaný a skutečný stav liší.
AutomaticTuningMode	Požadovaný stav automatického ladění
AutomaticTuningOptionModeActual	Skutečný stav možnosti automatického ladění
AutomaticTuningOptionModeDesired	Požadovaný stav možnosti automatického ladění
AutomaticTuningOptions	Vlastnosti automatického ladění pro jednotlivé poradce
DatabaseAutomaticTuning	Automatické ladění na úrovni databáze

AutomaticTuningDisabledReason

Výčet

Popis důvodu, pokud se požadovaný a skutečný stav liší.

Hodnota	Description
AutoConfigured
Default
Disabled
InheritedFromServer
NotSupported
QueryStoreOff
QueryStoreReadOnly

AutomaticTuningMode

Výčet

Požadovaný stav automatického ladění

Hodnota	Description
Auto
Custom
Inherit
Unspecified

AutomaticTuningOptionModeActual

Výčet

Skutečný stav možnosti automatického ladění

Hodnota	Description
Off
On

AutomaticTuningOptionModeDesired

Výčet

Požadovaný stav možnosti automatického ladění

Hodnota	Description
Default
Off
On

AutomaticTuningOptions

Objekt

Vlastnosti automatického ladění pro jednotlivé poradce

Name	Typ	Description
actualState	AutomaticTuningOptionModeActual	Skutečný stav možnosti automatického ladění
desiredState	AutomaticTuningOptionModeDesired	Požadovaný stav možnosti automatického ladění
reasonCode	integer (int32)	Kód důvodu, pokud se požadovaný a skutečný stav liší.
reasonDesc	AutomaticTuningDisabledReason	Popis důvodu, pokud se požadovaný a skutečný stav liší.

DatabaseAutomaticTuning

Objekt

Automatické ladění na úrovni databáze

Name	Typ	Description
id	string	ID prostředku.
name	string	Název prostředku
properties.actualState	AutomaticTuningMode	Skutečný stav automatického ladění
properties.desiredState	AutomaticTuningMode	Požadovaný stav automatického ladění
properties.options	<string,  AutomaticTuningOptions>	Definice možností automatického ladění
type	string	Typ zdroje.