Server Automatic Tuning - Update

Riferimento

Service:: SQL Database

API Version:: 2021-11-01

Aggiornare le opzioni di ottimizzazione automatica nel server.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
resourceGroupName	path	True	string	Nome del gruppo di risorse contenente la risorsa. È possibile ottenere questo valore dall'API di Gestione risorse di Azure o dal portale.
serverName	path	True	string	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	AutomaticTuningServerMode	Stato desiderato per l'ottimizzazione automatica.
properties.options	<string, AutomaticTuningServerOptions>	Definizione delle opzioni di ottimizzazione automatica.

Risposte

Nome	Tipo	Descrizione
200 OK	ServerAutomaticTuning	Aggiornamento delle opzioni di ottimizzazione automatica a livello di server.
Other Status Codes		Risposte di errore: 400 FeatureDisabledOnSelectedEdition : l'utente ha tentato di usare una funzionalità disabilitata nell'edizione di database corrente. 400 InvalidIdentifier: l'identificatore contiene NULL o un carattere Unicode non valido. 400 InvalidAutomaticTuningUpsertRequest: il corpo della richiesta di ottimizzazione automatica dell'aggiornamento non esiste o non ha alcun oggetto proprietà. 400 InvalidAdvisorAutoExecuteStatus - Lo stato di esecuzione automatica specificato per l'advisor non è consentito. 404 DatabaseDoesNotExist - Il database richiesto non è stato trovato 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 Operazione interrotta- Impossibile completare l'operazione sulla risorsa perché è stata interrotta da un'altra operazione sulla stessa risorsa. 409 DefaultAdvisorStateNotAllowedInCustomServerMode - Stato di advisor PREDEFINITO non consentito in modalità PERSONALIZZATA 409 UpdateNotAllowedIfServerAutotuningUpdateOperationInProgress - Le impostazioni di ottimizzazione automatica della richiesta precedente non sono state propagate a tutti i database utente. 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.

Nome

Tipo

Descrizione

200 OK

ServerAutomaticTuning

Aggiornamento delle opzioni di ottimizzazione automatica a livello di server.

Other Status Codes

Risposte di errore:

400 FeatureDisabledOnSelectedEdition : l'utente ha tentato di usare una funzionalità disabilitata nell'edizione di database corrente.
400 InvalidIdentifier: l'identificatore contiene NULL o un carattere Unicode non valido.
400 InvalidAutomaticTuningUpsertRequest: il corpo della richiesta di ottimizzazione automatica dell'aggiornamento non esiste o non ha alcun oggetto proprietà.
400 InvalidAdvisorAutoExecuteStatus - Lo stato di esecuzione automatica specificato per l'advisor non è consentito.
404 DatabaseDoesNotExist - Il database richiesto non è stato trovato
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 Operazione interrotta- Impossibile completare l'operazione sulla risorsa perché è stata interrotta da un'altra operazione sulla stessa risorsa.
409 DefaultAdvisorStateNotAllowedInCustomServerMode - Stato di advisor PREDEFINITO non consentito in modalità PERSONALIZZATA
409 UpdateNotAllowedIfServerAutotuningUpdateOperationInProgress - Le impostazioni di ottimizzazione automatica della richiesta precedente non sono state propagate a tutti i database utente.
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 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"
      }
    }
  }
}

Definizioni

Nome	Descrizione
AutomaticTuningOptionModeActual	Stato effettivo dell'opzione di ottimizzazione automatica.
AutomaticTuningOptionModeDesired	Stato desiderato per l'opzione di ottimizzazione automatica.
AutomaticTuningServerMode	Stato desiderato per l'ottimizzazione automatica.
AutomaticTuningServerOptions	Proprietà di ottimizzazione automatica per i singoli advisor.
AutomaticTuningServerReason	Descrizione del motivo se lo stato desiderato e effettivo sono diversi.
ServerAutomaticTuning	Ottimizzazione automatica a livello di server.

AutomaticTuningOptionModeActual

Stato effettivo dell'opzione di ottimizzazione automatica.

Nome	Tipo	Descrizione
Off	string
On	string

AutomaticTuningOptionModeDesired

Stato desiderato per l'opzione di ottimizzazione automatica.

Nome	Tipo	Descrizione
Default	string
Off	string
On	string

AutomaticTuningServerMode

Stato desiderato per l'ottimizzazione automatica.

Nome	Tipo	Descrizione
Auto	string
Custom	string
Unspecified	string

AutomaticTuningServerOptions

Proprietà di ottimizzazione automatica per i singoli advisor.

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

AutomaticTuningServerReason

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

Nome	Tipo	Descrizione
AutoConfigured	string
Default	string
Disabled	string