Server Automatic Tuning - Update

Referenz

Service:: SQL Database

API Version:: 2021-11-01

Aktualisieren sie die Optionen für die automatische Optimierung auf dem Server.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
resourceGroupName	path	True	string	Der Name der Ressourcengruppe, die die Ressource enthält. Dieser Wert kann über die Azure-Ressourcen-Manager-API oder das Portal abgerufen werden.
serverName	path	True	string	Name des Servers
subscriptionId	path	True	string	Abonnement-ID für ein Azure-Abonnement.
api-version	query	True	string	API-Version, die für die Anforderung verwendet werden soll.

Anforderungstext

Name	Typ	Beschreibung
properties.desiredState	AutomaticTuningServerMode	Gewünschter Zustand der automatischen Optimierung.
properties.options	<string, AutomaticTuningServerOptions>	Definition der Optionen für die automatische Optimierung.

Antworten

Name	Typ	Beschreibung
200 OK	ServerAutomaticTuning	Die optionen für die automatische Optimierung auf Serverebene wurden erfolgreich aktualisiert.
Other Status Codes		Fehlerantworten: *** 400 FeatureDisabledOnSelectedEdition: Der Benutzer hat versucht, ein Feature zu verwenden, das in der aktuellen Datenbankedition deaktiviert ist. 400 InvalidIdentifier: Der Bezeichner enthält NULL oder ein ungültiges Unicode-Zeichen. 400 InvalidAutomaticTuningUpsertRequest: Der Anforderungstext der automatischen Optimierung ist nicht vorhanden oder weist kein Eigenschaftenobjekt auf. 400 InvalidAdvisorAutoExecuteStatus: Die angegebene status für die automatische Ausführung für den Advisor ist nicht zulässig. 404 DatabaseDoesNotExist: Die angeforderte Datenbank wurde nicht gefunden. 404 SubscriptionDoesNotHaveServer: Der angeforderte Server wurde nicht gefunden. 404 SubscriptionDoesNotHaveElasticPool: Der angeforderte Pool für elastische Datenbanken wurde nicht gefunden. 404 OperationIdNotFound: Der Vorgang mit der ID ist nicht vorhanden. 404 AutomaticTuningOptionNotFound: Die angeforderte automatische Optimierungsoption wurde nicht gefunden. 405 Nicht Unterstützt: Diese Funktionalität wird nicht unterstützt. 409 Konflikt: Die Anforderung konnte aufgrund eines Konflikts in der Anforderung nicht verarbeitet werden. 409 OperationCancelled: Der Vorgang wurde vom Benutzer abgebrochen. 409 OperationInterrupted: Der Vorgang für die Ressource konnte nicht abgeschlossen werden, da er durch einen anderen Vorgang für dieselbe Ressource unterbrochen wurde. 409 DefaultAdvisorStateNotAllowedInCustomServerMode – DEFAULT advisor state not allowed in CUSTOM mode 409 UpdateNotAllowedIfServerAutotuningUpdateOperationInProgress: Einstellungen für die automatische Optimierung aus der vorherigen Anforderung wurden nicht an alle Benutzerdatenbanken weitergegeben. 429 SubscriptionTooManyCreateUpdateRequests: Anforderungen, die über die maximale Anzahl von Anforderungen hinausgehen, die von verfügbaren Ressourcen verarbeitet werden können. 429 SubscriptionTooManyRequests: Anforderungen, die über die maximale Anzahl von Anforderungen hinausgehen, die von verfügbaren Ressourcen verarbeitet werden können. 500 OperationTimedOut: Timeout des Vorgangs und automatisches Rollback. Wiederholen Sie den Vorgang. 503 ServiceTemporarilyUnavailable: Feature vorübergehend nicht verfügbar. 503 TooManyRequests: Anforderungen, die über die maximale Anzahl von Anforderungen hinausgehen, die von verfügbaren Ressourcen verarbeitet werden können.

Name

Typ

Beschreibung

200 OK

ServerAutomaticTuning

Die optionen für die automatische Optimierung auf Serverebene wurden erfolgreich aktualisiert.

Other Status Codes

Fehlerantworten: ***

400 FeatureDisabledOnSelectedEdition: Der Benutzer hat versucht, ein Feature zu verwenden, das in der aktuellen Datenbankedition deaktiviert ist.
400 InvalidIdentifier: Der Bezeichner enthält NULL oder ein ungültiges Unicode-Zeichen.
400 InvalidAutomaticTuningUpsertRequest: Der Anforderungstext der automatischen Optimierung ist nicht vorhanden oder weist kein Eigenschaftenobjekt auf.
400 InvalidAdvisorAutoExecuteStatus: Die angegebene status für die automatische Ausführung für den Advisor ist nicht zulässig.
404 DatabaseDoesNotExist: Die angeforderte Datenbank wurde nicht gefunden.
404 SubscriptionDoesNotHaveServer: Der angeforderte Server wurde nicht gefunden.
404 SubscriptionDoesNotHaveElasticPool: Der angeforderte Pool für elastische Datenbanken wurde nicht gefunden.
404 OperationIdNotFound: Der Vorgang mit der ID ist nicht vorhanden.
404 AutomaticTuningOptionNotFound: Die angeforderte automatische Optimierungsoption wurde nicht gefunden.
405 Nicht Unterstützt: Diese Funktionalität wird nicht unterstützt.
409 Konflikt: Die Anforderung konnte aufgrund eines Konflikts in der Anforderung nicht verarbeitet werden.
409 OperationCancelled: Der Vorgang wurde vom Benutzer abgebrochen.
409 OperationInterrupted: Der Vorgang für die Ressource konnte nicht abgeschlossen werden, da er durch einen anderen Vorgang für dieselbe Ressource unterbrochen wurde.
409 DefaultAdvisorStateNotAllowedInCustomServerMode – DEFAULT advisor state not allowed in CUSTOM mode
409 UpdateNotAllowedIfServerAutotuningUpdateOperationInProgress: Einstellungen für die automatische Optimierung aus der vorherigen Anforderung wurden nicht an alle Benutzerdatenbanken weitergegeben.
429 SubscriptionTooManyCreateUpdateRequests: Anforderungen, die über die maximale Anzahl von Anforderungen hinausgehen, die von verfügbaren Ressourcen verarbeitet werden können.
429 SubscriptionTooManyRequests: Anforderungen, die über die maximale Anzahl von Anforderungen hinausgehen, die von verfügbaren Ressourcen verarbeitet werden können.
500 OperationTimedOut: Timeout des Vorgangs und automatisches Rollback. Wiederholen Sie den Vorgang.
503 ServiceTemporarilyUnavailable: Feature vorübergehend nicht verfügbar.
503 TooManyRequests: Anforderungen, die über die maximale Anzahl von Anforderungen hinausgehen, die von verfügbaren Ressourcen verarbeitet werden können.

Beispiele

Updates server automatic tuning settings with all properties

Updates server automatic tuning settings with minimal properties

Updates server automatic tuning settings with all properties

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


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

Sample Request

HTTP
Java

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


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

Definitionen

Name	Beschreibung
AutomaticTuningOptionModeActual	Ist-Zustand der Option für die automatische Optimierung.
AutomaticTuningOptionModeDesired	Gewünschter Zustand der Automatischen Optimierungsoption.
AutomaticTuningServerMode	Gewünschter Zustand der automatischen Optimierung.
AutomaticTuningServerOptions	Automatische Optimierungseigenschaften für einzelne Berater.
AutomaticTuningServerReason	Die Ursachenbeschreibung, falls gewünscht, und der tatsächliche Zustand unterscheiden sich.
ServerAutomaticTuning	Automatische Optimierung auf Serverebene.

AutomaticTuningOptionModeActual

Ist-Zustand der Option für die automatische Optimierung.

Name	Typ	Beschreibung
Off	string
On	string

AutomaticTuningOptionModeDesired

Gewünschter Zustand der Automatischen Optimierungsoption.

Name	Typ	Beschreibung
Default	string
Off	string
On	string

AutomaticTuningServerMode

Gewünschter Zustand der automatischen Optimierung.

Name	Typ	Beschreibung
Auto	string
Custom	string
Unspecified	string

AutomaticTuningServerOptions

Automatische Optimierungseigenschaften für einzelne Berater.

Name	Typ	Beschreibung
actualState	AutomaticTuningOptionModeActual	Ist-Zustand der Option für die automatische Optimierung.
desiredState	AutomaticTuningOptionModeDesired	Gewünschter Zustand der Automatischen Optimierungsoption.
reasonCode	integer	Der Grundcode, falls gewünscht, und der tatsächliche Zustand unterscheiden sich.
reasonDesc	AutomaticTuningServerReason	Die Ursachenbeschreibung, falls gewünscht, und der tatsächliche Zustand unterscheiden sich.

AutomaticTuningServerReason

Die Ursachenbeschreibung, falls gewünscht, und der tatsächliche Zustand unterscheiden sich.

Name	Typ	Beschreibung
AutoConfigured	string
Default	string
Disabled	string