Database Automatic Tuning - Update

Referenz

Dienst:: SQL Database

API-Version:: 2021-11-01

Aktualisieren Sie die Eigenschaften der automatischen Optimierung für die Zieldatenbank.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
databaseName	path	True	string	Der Name der Datenbank.
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	AutomaticTuningMode	Automatische Optimierung des gewünschten Zustands.
properties.options	<string, AutomaticTuningOptions>	Definition der automatischen Optimierungsoptionen.

Antworten

Name	Typ	Beschreibung
200 OK	DatabaseAutomaticTuning	Die angegebenen Einstellungen für die automatische Datenbankoptimierung 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 SystemDatabasesNotSupported: Der Benutzer hat versucht, automatische Optimierungsinformationen für Systemdatenbanken abzurufen. 400 DataWarehouseNotSupported: Die automatische Optimierung wird für SQL-Data Warehouse nicht unterstützt. 400 InvalidAutomaticTuningUpsertRequest: Der Text der Automatischen Optimierungsanforderung ist nicht vorhanden oder weist kein Eigenschaftenobjekt auf. 400 InvalidAdvisorAutoExecuteStatus: Die angegebene automatische Ausführung status 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 NotSupported: 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 DisabledBySystem: Diese Option ist vom System deaktiviert 409 DefaultAdvisorStateNotAllowedInCustomDbMode : Default Advisor-Status ist im BENUTZERDEFINIERTEn Modus nicht zulässig 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: Der Vorgang ist timeout und wird automatisch zurückgesetzt. 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

DatabaseAutomaticTuning

Die angegebenen Einstellungen für die automatische Datenbankoptimierung 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 SystemDatabasesNotSupported: Der Benutzer hat versucht, automatische Optimierungsinformationen für Systemdatenbanken abzurufen.
400 DataWarehouseNotSupported: Die automatische Optimierung wird für SQL-Data Warehouse nicht unterstützt.
400 InvalidAutomaticTuningUpsertRequest: Der Text der Automatischen Optimierungsanforderung ist nicht vorhanden oder weist kein Eigenschaftenobjekt auf.
400 InvalidAdvisorAutoExecuteStatus: Die angegebene automatische Ausführung status 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 NotSupported: 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 DisabledBySystem: Diese Option ist vom System deaktiviert
409 DefaultAdvisorStateNotAllowedInCustomDbMode : Default Advisor-Status ist im BENUTZERDEFINIERTEn Modus nicht zulässig
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: Der Vorgang ist timeout und wird automatisch zurückgesetzt. 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 database automatic tuning settings with all properties

Updates database automatic tuning settings with minimal properties

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

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


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

Beispiel für eine Antwort

Statuscode:: 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

Beispielanforderung

HTTP
Java

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


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

Beispiel für eine Antwort

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

Definitionen

Name	Beschreibung
AutomaticTuningDisabledReason	Die Beschreibung des Grunds, falls gewünscht, und der tatsächliche Zustand unterscheiden sich.
AutomaticTuningMode	Automatische Optimierung des gewünschten Zustands.
AutomaticTuningOptionModeActual	Ist-Zustand der Automatischen Optimierungsoption.
AutomaticTuningOptionModeDesired	Gewünschter Zustand der automatischen Optimierungsoption.
AutomaticTuningOptions	Automatische Optimierungseigenschaften für einzelne Berater.
DatabaseAutomaticTuning	Automatische Optimierung auf Datenbankebene.

AutomaticTuningDisabledReason

Die Beschreibung des Grunds, falls gewünscht, und der tatsächliche Zustand unterscheiden sich.

Name	Typ	Beschreibung
AutoConfigured	string
Default	string
Disabled	string
InheritedFromServer	string
NotSupported	string
QueryStoreOff	string
QueryStoreReadOnly	string

AutomaticTuningMode

Automatische Optimierung des gewünschten Zustands.

Name	Typ	Beschreibung
Auto	string
Custom	string
Inherit	string
Unspecified	string

AutomaticTuningOptionModeActual

Ist-Zustand der Automatischen Optimierungsoption.

Name	Typ	Beschreibung
Off	string
On	string

AutomaticTuningOptionModeDesired

Gewünschter Zustand der automatischen Optimierungsoption.

Name	Typ	Beschreibung
Default	string
Off	string
On	string

AutomaticTuningOptions

Automatische Optimierungseigenschaften für einzelne Berater.

Name	Typ	Beschreibung
actualState	AutomaticTuningOptionModeActual	Ist-Zustand der Automatischen Optimierungsoption.
desiredState	AutomaticTuningOptionModeDesired	Gewünschter Zustand der automatischen Optimierungsoption.
reasonCode	integer	Der Grundcode, falls gewünscht, und der tatsächliche Zustand unterscheiden sich.
reasonDesc	AutomaticTuningDisabledReason	Die Beschreibung des Grunds, falls gewünscht, und der tatsächliche Zustand unterscheiden sich.