Database Automatic Tuning - Update

Référence

Service:: SQL Database

API Version:: 2021-11-01

Mettez à jour les propriétés de réglage automatique pour la base de données cible.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
databaseName	path	True	string	Nom de la base de données.
resourceGroupName	path	True	string	Nom du groupe de ressources qui contient la ressource. Vous pouvez obtenir cette valeur à partir de l’API Azure Resource Manager ou du portail.
serverName	path	True	string	Le nom du serveur
subscriptionId	path	True	string	L’ID d’abonnement d’un abonnement Azure.
api-version	query	True	string	Version de l’API à utiliser pour la requête.

Corps de la demande

Nom	Type	Description
properties.desiredState	AutomaticTuningMode	État souhaité de réglage automatique.
properties.options	<string, AutomaticTuningOptions>	Définition des options de réglage automatique.

Réponses

Nom	Type	Description
200 OK	DatabaseAutomaticTuning	Mise à jour réussie des paramètres de réglage automatique de base de données spécifiés.
Other Status Codes		Réponses d’erreur : *** 400 FeatureDisabledOnSelectedEdition : l’utilisateur a tenté d’utiliser une fonctionnalité désactivée sur l’édition actuelle de la base de données. 400 InvalidIdentifier : l’identificateur contient null ou un caractère Unicode non valide. 400 SystemDatabasesNotSupported : l’utilisateur a essayé d’obtenir des informations de réglage automatique sur les bases de données système. 400 DataWarehouseNotSupported : le réglage automatique n’est pas pris en charge pour SQL Data Warehouse. 400 InvalidAutomaticTuningUpsertRequest : le corps de la demande de réglage automatique de mise à jour n’existe pas ou n’a pas d’objet de propriétés. 400 InvalidAdvisorAutoExecuteStatus : les status d’exécution automatique spécifiées pour le conseiller ne sont pas autorisées. 404 DatabaseDoesNotExist : la base de données demandée est introuvable 404 SubscriptionDoesNotHaveServer : le serveur demandé est introuvable 404 SubscriptionDoesNotHaveElasticPool - Le pool élastique demandé est introuvable 404 OperationIdNotFound : l’opération avec ID n’existe pas. 404 AutomaticTuningOptionNotFound : l’option de réglage automatique demandée est introuvable. 405 Non pris en charge : cette fonctionnalité n’est pas prise en charge. 409 Conflit : la demande n’a pas pu être traitée en raison d’un conflit dans la demande. 409 OperationCancelled : l’opération a été annulée par l’utilisateur. 409 Opération interrompue : l’opération sur la ressource n’a pas pu être terminée, car elle a été interrompue par une autre opération sur la même ressource. 409 DisabledBySystem : cette option est désactivée par le système 409 DefaultAdvisorStateNotAllowedInCustomDbMode : l’état du conseiller DEFAULT n’est pas autorisé en mode CUSTOM 429 SubscriptionTooManyCreateUpdateRequests : demandes au-delà du nombre maximal de demandes pouvant être traitées par les ressources disponibles. 429 SubscriptionTooManyRequests : demandes au-delà du nombre maximal de demandes pouvant être traitées par les ressources disponibles. 500 OperationTimedOut : l’opération a expiré et a été automatiquement restaurée. Réessayez l’opération. 503 ServiceTemporarilyUnavailable - Fonctionnalité temporairement indisponible. 503 TooManyRequests : demandes au-delà du nombre maximal de demandes pouvant être traitées par les ressources disponibles.

Nom

Type

Description

200 OK

DatabaseAutomaticTuning

Mise à jour réussie des paramètres de réglage automatique de base de données spécifiés.

Other Status Codes

Réponses d’erreur : ***

400 FeatureDisabledOnSelectedEdition : l’utilisateur a tenté d’utiliser une fonctionnalité désactivée sur l’édition actuelle de la base de données.
400 InvalidIdentifier : l’identificateur contient null ou un caractère Unicode non valide.
400 SystemDatabasesNotSupported : l’utilisateur a essayé d’obtenir des informations de réglage automatique sur les bases de données système.
400 DataWarehouseNotSupported : le réglage automatique n’est pas pris en charge pour SQL Data Warehouse.
400 InvalidAutomaticTuningUpsertRequest : le corps de la demande de réglage automatique de mise à jour n’existe pas ou n’a pas d’objet de propriétés.
400 InvalidAdvisorAutoExecuteStatus : les status d’exécution automatique spécifiées pour le conseiller ne sont pas autorisées.
404 DatabaseDoesNotExist : la base de données demandée est introuvable
404 SubscriptionDoesNotHaveServer : le serveur demandé est introuvable
404 SubscriptionDoesNotHaveElasticPool - Le pool élastique demandé est introuvable
404 OperationIdNotFound : l’opération avec ID n’existe pas.
404 AutomaticTuningOptionNotFound : l’option de réglage automatique demandée est introuvable.
405 Non pris en charge : cette fonctionnalité n’est pas prise en charge.
409 Conflit : la demande n’a pas pu être traitée en raison d’un conflit dans la demande.
409 OperationCancelled : l’opération a été annulée par l’utilisateur.
409 Opération interrompue : l’opération sur la ressource n’a pas pu être terminée, car elle a été interrompue par une autre opération sur la même ressource.
409 DisabledBySystem : cette option est désactivée par le système
409 DefaultAdvisorStateNotAllowedInCustomDbMode : l’état du conseiller DEFAULT n’est pas autorisé en mode CUSTOM
429 SubscriptionTooManyCreateUpdateRequests : demandes au-delà du nombre maximal de demandes pouvant être traitées par les ressources disponibles.
429 SubscriptionTooManyRequests : demandes au-delà du nombre maximal de demandes pouvant être traitées par les ressources disponibles.
500 OperationTimedOut : l’opération a expiré et a été automatiquement restaurée. Réessayez l’opération.
503 ServiceTemporarilyUnavailable - Fonctionnalité temporairement indisponible.
503 TooManyRequests : demandes au-delà du nombre maximal de demandes pouvant être traitées par les ressources disponibles.

Exemples

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

Sample Request

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

Définitions

Nom	Description
AutomaticTuningDisabledReason	La description de la raison si l’état souhaité et l’état réel sont différents.
AutomaticTuningMode	État souhaité de réglage automatique.
AutomaticTuningOptionModeActual	État réel de l’option de réglage automatique.
AutomaticTuningOptionModeDesired	État souhaité de l’option de réglage automatique.
AutomaticTuningOptions	Propriétés de réglage automatique pour les conseillers individuels.
DatabaseAutomaticTuning	Réglage automatique au niveau de la base de données.

AutomaticTuningDisabledReason

La description de la raison si l’état souhaité et l’état réel sont différents.

Nom	Type	Description
AutoConfigured	string
Default	string
Disabled	string
InheritedFromServer	string
NotSupported	string
QueryStoreOff	string
QueryStoreReadOnly	string

AutomaticTuningMode

État souhaité de réglage automatique.

Nom	Type	Description
Auto	string
Custom	string
Inherit	string
Unspecified	string

AutomaticTuningOptionModeActual

État réel de l’option de réglage automatique.

Nom	Type	Description
Off	string
On	string

AutomaticTuningOptionModeDesired

État souhaité de l’option de réglage automatique.

Nom	Type	Description
Default	string
Off	string
On	string

AutomaticTuningOptions

Propriétés de réglage automatique pour les conseillers individuels.

Nom	Type	Description
actualState	AutomaticTuningOptionModeActual	État réel de l’option de réglage automatique.
desiredState	AutomaticTuningOptionModeDesired	État souhaité de l’option de réglage automatique.
reasonCode	integer	Le code de motif si l’état souhaité et l’état réel sont différents.
reasonDesc	AutomaticTuningDisabledReason	La description de la raison si l’état souhaité et l’état réel sont différents.