Database Automatic Tuning - Update

Servizio:

SQL Database

Versione API:

2021-11-01

Aggiornare le proprietà di ottimizzazione automatica per il database di destinazione.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
databaseName	path	True	string	Nome del database.
resourceGroupName	path	True	string	Nome del gruppo di risorse che contiene la risorsa. È possibile ottenere questo valore dall'API di Azure Resource Manager o dal portale.
serverName	path	True	string	Il nome del server.
subscriptionId	path	True	string	ID sottoscrizione che identifica una sottoscrizione di Azure.
api-version	query	True	string	Versione dell'API da usare per la richiesta.

Corpo della richiesta

Nome	Tipo	Descrizione
properties.desiredState	AutomaticTuningMode	Ottimizzazione automatica dello stato desiderato.
properties.options	<string,  AutomaticTuningOptions>	Definizione delle opzioni di ottimizzazione automatica.

Risposte

Nome	Tipo	Descrizione
200 OK	DatabaseAutomaticTuning	Aggiornamento corretto delle impostazioni di ottimizzazione automatica del database specificato.
Other Status Codes		Risposte di errore: 400 FeatureDisabledOnSelectedEdition : l'utente ha tentato di usare una funzionalità disabilitata nell'edizione del database corrente. 400 InvalidIdentifier: l'identificatore contiene NULL o un carattere Unicode non valido. 400 SystemDatabasesNotSupported - L'utente ha tentato di ottenere informazioni di ottimizzazione automatica sui database di sistema. 400 DataWarehouseNotSupported : l'ottimizzazione automatica non è supportata per SQL Data Warehouse. 400 InvalidAutomaticTuningUpsertRequest: il corpo della richiesta di ottimizzazione automatica dell'aggiornamento non esiste o non dispone di alcun oggetto proprietà. 400 InvalidAdvisorAutoExecuteStatus - Lo stato di esecuzione automatica specificato per l'advisor non è consentito. 404 DatabaseDoesNotExist - Impossibile trovare il database richiesto 404 SubscriptionDoesNotHaveServer - Il server richiesto non è stato trovato 404 SubscriptionDoesNotHaveElasticPool - Il pool elastico richiesto non è stato trovato 404 OperationIdNotFound - L'operazione con ID non esiste. 404 AutomaticTuningOptionNotFound - L'opzione di ottimizzazione automatica richiesta non è stata trovata. 405 NotSupported : questa funzionalità non è supportata. 409 Conflitto - Impossibile elaborare la richiesta a causa di un conflitto nella richiesta. 409 OperationCancelled - L'operazione è stata annullata dall'utente. 409 OperationInterrupted - Impossibile completare l'operazione sulla risorsa perché è stata interrotta da un'altra operazione sulla stessa risorsa. 409 DisabledBySystem - Questa opzione è disabilitata dal sistema 409 DefaultAdvisorStateNotAllowedInCustomDbMode - Lo stato predefinito di advisor non è consentito in modalità PERSONALIZZATA 429 SubscriptionTooManyCreateUpdateRequests - Richieste oltre il numero massimo di richieste che possono essere elaborate dalle risorse disponibili. 429 SubscriptionTooManyRequests - Richieste oltre il numero massimo di richieste che possono essere elaborate dalle risorse disponibili. 500 OperationTimedOut: timeout dell'operazione e rollback automatico. Ripetere l'operazione. 503 ServiceTemporarilyUnavailable - Funzionalità temporaneamente non disponibile. 503 TooManyRequests - Richieste oltre il numero massimo di richieste che possono essere elaborate dalle risorse disponibili.

Esempio

Updates database automatic tuning settings with all properties

Updates database automatic tuning settings with minimal properties

Updates database automatic tuning settings with all properties

Esempio di richiesta

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

Risposta di esempio

Codice di stato:

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

Esempio di richiesta

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

Risposta di esempio

Codice di stato:

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

Definizioni

Nome	Descrizione
AutomaticTuningDisabledReason	Descrizione del motivo se lo stato desiderato e effettivo sono diversi.
AutomaticTuningMode	Ottimizzazione automatica dello stato desiderato.
AutomaticTuningOptionModeActual	Stato effettivo dell'opzione di ottimizzazione automatica.
AutomaticTuningOptionModeDesired	Stato desiderato dell'opzione di ottimizzazione automatica.
AutomaticTuningOptions	Proprietà di ottimizzazione automatica per singoli advisor.
DatabaseAutomaticTuning	Ottimizzazione automatica a livello di database.

AutomaticTuningDisabledReason

Enumerazione

Descrizione del motivo se lo stato desiderato e effettivo sono diversi.

Valore	Descrizione
AutoConfigured
Default
Disabled
InheritedFromServer
NotSupported
QueryStoreOff
QueryStoreReadOnly

AutomaticTuningMode

Enumerazione

Ottimizzazione automatica dello stato desiderato.

Valore	Descrizione
Auto
Custom
Inherit
Unspecified

AutomaticTuningOptionModeActual

Enumerazione

Stato effettivo dell'opzione di ottimizzazione automatica.

Valore	Descrizione
Off
On

AutomaticTuningOptionModeDesired

Enumerazione

Stato desiderato dell'opzione di ottimizzazione automatica.

Valore	Descrizione
Default
Off
On

AutomaticTuningOptions

Object

Proprietà di ottimizzazione automatica per singoli advisor.

Nome	Tipo	Descrizione
actualState	AutomaticTuningOptionModeActual	Stato effettivo dell'opzione di ottimizzazione automatica.
desiredState	AutomaticTuningOptionModeDesired	Stato desiderato dell'opzione di ottimizzazione automatica.
reasonCode	integer (int32)	Il codice motivo se lo stato desiderato e effettivo sono diversi.
reasonDesc	AutomaticTuningDisabledReason	Descrizione del motivo se lo stato desiderato e effettivo sono diversi.

DatabaseAutomaticTuning

Object

Ottimizzazione automatica a livello di database.

Nome	Tipo	Descrizione
id	string	ID risorsa.
name	string	Nome risorsa.
properties.actualState	AutomaticTuningMode	Ottimizzazione automatica dello stato effettivo.
properties.desiredState	AutomaticTuningMode	Ottimizzazione automatica dello stato desiderato.
properties.options	<string,  AutomaticTuningOptions>	Definizione delle opzioni di ottimizzazione automatica.
type	string	Tipo di risorsa.