Server Automatic Tuning - Update

Služba:

SQL Database

Verze rozhraní API:

2021-11-01

Aktualizace možností automatického ladění na serveru

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
resourceGroupName	path	True	string	Název skupiny prostředků, která prostředek obsahuje. Tuto hodnotu můžete získat z rozhraní API Resource Manager Azure nebo z 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	AutomaticTuningServerMode	Požadovaný stav automatického ladění.
properties.options	<string,  AutomaticTuningServerOptions>	Definice možností automatického ladění

Odpovědi

Name	Typ	Description
200 OK	ServerAutomaticTuning	Možnosti automatického ladění na úrovni serveru byly úspěšně aktualizovány.
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 InvalidAutomaticTuningUpsertRequest – text požadavku automatického ladění aktualizace neexistuje nebo nemá žádný objekt properties. 400 InvalidAdvisorAutoExecuteStatus – Zadaný stav automatického spuštění poradce není povolen. 404 DatabaseDoesNotExist – Požadovaná databáze nebyla nalezena. 404 SubscriptionDoesNotHaveServer – Požadovaný server se nenašel. 404 SubscriptionDoesNotHaveElasticPool – Požadovaný elastický fond se nenašel. 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í se stejným prostředkem. 409 DefaultAdvisorStateNotAllowedInCustomServerMode – výchozí stav poradce není ve vlastním režimu povolený. 409 UpdateNotAllowedIfServerAutotuningUpdateOperationInProgress – nastavení automatického ladění z předchozího požadavku se nerozšířilo do všech uživatelských databází. 429 SubscriptionTooManyCreateUpdateRequests – požadavky nad maximální počet požadavků, které je možné zpracovat dostupnými prostředky. 429 SubscriptionTooManyRequests – požadavky nad rámec maximálního počtu požadavků, které je možné zpracovat dostupnými prostředky. 500 OperationTimedOut – časový limit operace vypršel a automaticky se vrátila zpět. Opakujte operaci. 503 ServiceTemporarilyUnavailable – Funkce je dočasně nedostupná. 503 TooManyRequests – požadavky nad rámec maximálního počtu požadavků, které je možné zpracovat dostupnými prostředky.

Příklady

Updates server automatic tuning settings with all properties

Updates server automatic tuning settings with minimal properties

Updates server 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/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.ServerAutomaticTuningInner;
import com.azure.resourcemanager.sql.models.AutomaticTuningOptionModeDesired;
import com.azure.resourcemanager.sql.models.AutomaticTuningServerMode;
import com.azure.resourcemanager.sql.models.AutomaticTuningServerOptions;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for ServerAutomaticTuning Update.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/ServerAutomaticTuningUpdateMax.json
     */
    /**
     * Sample code: Updates server automatic tuning settings with all properties.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        updatesServerAutomaticTuningSettingsWithAllProperties(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getServerAutomaticTunings().updateWithResponse(
            "default-sql-onebox", "testsvr11",
            new ServerAutomaticTuningInner().withDesiredState(AutomaticTuningServerMode.AUTO)
                .withOptions(mapOf("createIndex",
                    new AutomaticTuningServerOptions().withDesiredState(AutomaticTuningOptionModeDesired.OFF),
                    "dropIndex",
                    new AutomaticTuningServerOptions().withDesiredState(AutomaticTuningOptionModeDesired.ON),
                    "forceLastGoodPlan",
                    new AutomaticTuningServerOptions().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/automaticTuning/current",
  "name": "current",
  "type": "Microsoft.Sql/servers/automaticTuning",
  "properties": {
    "desiredState": "Auto",
    "actualState": "Auto",
    "options": {
      "createIndex": {
        "desiredState": "Off",
        "actualState": "Off"
      },
      "dropIndex": {
        "desiredState": "On",
        "actualState": "On"
      },
      "forceLastGoodPlan": {
        "desiredState": "Default",
        "actualState": "On",
        "reasonCode": 2,
        "reasonDesc": "AutoConfigured"
      },
      "maintainIndex": {
        "desiredState": "Default",
        "actualState": "Off",
        "reasonCode": 2,
        "reasonDesc": "AutoConfigured"
      }
    }
  }
}

Updates server 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/automaticTuning/current?api-version=2021-11-01

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

Java

import com.azure.resourcemanager.sql.fluent.models.ServerAutomaticTuningInner;
import com.azure.resourcemanager.sql.models.AutomaticTuningServerMode;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for ServerAutomaticTuning Update.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/ServerAutomaticTuningUpdateMin.json
     */
    /**
     * Sample code: Updates server automatic tuning settings with minimal properties.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void updatesServerAutomaticTuningSettingsWithMinimalProperties(
        com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getServerAutomaticTunings().updateWithResponse(
            "default-sql-onebox", "testsvr11",
            new ServerAutomaticTuningInner().withDesiredState(AutomaticTuningServerMode.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/automaticTuning/current",
  "name": "current",
  "type": "Microsoft.Sql/servers/automaticTuning",
  "properties": {
    "desiredState": "Auto",
    "actualState": "Auto",
    "options": {
      "createIndex": {
        "desiredState": "Default",
        "actualState": "On",
        "reasonCode": 2,
        "reasonDesc": "AutoConfigured"
      },
      "dropIndex": {
        "desiredState": "Default",
        "actualState": "Off",
        "reasonCode": 2,
        "reasonDesc": "AutoConfigured"
      },
      "forceLastGoodPlan": {
        "desiredState": "Default",
        "actualState": "On",
        "reasonCode": 2,
        "reasonDesc": "AutoConfigured"
      },
      "maintainIndex": {
        "desiredState": "Default",
        "actualState": "Off",
        "reasonCode": 2,
        "reasonDesc": "AutoConfigured"
      }
    }
  }
}

Definice

Name	Description
AutomaticTuningOptionModeActual	Skutečný stav možnosti automatického ladění
AutomaticTuningOptionModeDesired	Možnost automatického ladění požadovaného stavu.
AutomaticTuningServerMode	Požadovaný stav automatického ladění.
AutomaticTuningServerOptions	Vlastnosti automatického ladění pro jednotlivé poradce
AutomaticTuningServerReason	Popis důvodu, pokud se požadovaný a skutečný stav liší.
ServerAutomaticTuning	Automatické ladění na úrovni serveru.

AutomaticTuningOptionModeActual

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

Name	Typ	Description
Off	string
On	string

AutomaticTuningOptionModeDesired

Možnost automatického ladění požadovaného stavu.

Name	Typ	Description
Default	string
Off	string
On	string

AutomaticTuningServerMode

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

Name	Typ	Description
Auto	string
Custom	string
Unspecified	string

AutomaticTuningServerOptions

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

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

AutomaticTuningServerReason

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

Name	Typ	Description
AutoConfigured	string
Default	string
Disabled	string

ServerAutomaticTuning

Automatické ladění na úrovni serveru.

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