Server Automatic Tuning - Update

Service:

SQL Database

Version d'API:

2023-08-01

Mettez à jour les options de réglage automatique sur le serveur.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
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	Nom du serveur.
subscriptionId	path	True	string	ID d’abonnement qui identifie 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	AutomaticTuningServerMode	État souhaité du réglage automatique.
properties.options	<string,  AutomaticTuningServerOptions>	Définition des options de réglage automatique.

Réponses

Nom	Type	Description
200 OK	ServerAutomaticTuning	Mise à jour réussie des options de réglage automatique au niveau du serveur.
Other Status Codes	ErrorResponse	Réponses d’erreur : *** 400 FeatureDisabledOnSelectedEdition : l’utilisateur a tenté d’utiliser une fonctionnalité désactivée dans l’édition actuelle de la base de données. 400 InvalidIdentifier : l’identificateur contient NULL ou un caractère Unicode non valide. 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 : l’état d’exécution automatique spécifié pour le conseiller n’est pas autorisé. 404 SubscriptionDoesNotHaveServer - Le serveur demandé est introuvable 404 DatabaseDoesNotExist - La base de données demandée 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 NotSupported : cette fonctionnalité n’est pas prise en charge. Conflit 409 : la demande n’a pas pu être traitée en raison d’un conflit dans la demande. 409 CannotCancelOperation : l’opération de gestion est dans un état qui ne peut pas être annulé. 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 Default AdvisorStateNotAllowedInCustomServerMode - État du conseiller DEFAULT non autorisé en mode PERSONNALISÉ 409 UpdateNotAllowedIfServerAutotuningUpdateOperationInProgress : les paramètres de réglage automatique de la requête précédente n’ont pas été propagés à toutes les bases de données utilisateur. 429 SubscriptionTooManyCreateUpdateRequests : demandes au-delà des requêtes maximales pouvant être traitées par les ressources disponibles. 429 SubscriptionTooManyRequests : demandes au-delà des requêtes maximales pouvant être traitées par les ressources disponibles. 500 OperationTimedOut : l’opération a expiré et a été restaurée automatiquement. Réessayez l’opération. 503 ServiceTemporarilyUnavailable - Fonctionnalité temporairement indisponible. 503 TooManyRequests : demandes au-delà des requêtes maximales pouvant être traitées par les ressources disponibles.

Exemples

Updates server automatic tuning settings with all properties

Updates server automatic tuning settings with minimal properties

Updates server automatic tuning settings with all properties

Exemple de requête

HTTP

PATCH https://management.azure.com/subscriptions/c3aa9078-0000-0000-0000-e36f151182d7/resourceGroups/default-sql-onebox/providers/Microsoft.Sql/servers/testsvr11/automaticTuning/current?api-version=2023-08-01

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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/ServerAutomaticTuningUpdateMax.json
// this example is just showing the usage of "ServerAutomaticTuning_Update" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SqlServerAutomaticTuningResource created on azure
// for more information of creating SqlServerAutomaticTuningResource, please refer to the document of SqlServerAutomaticTuningResource
string subscriptionId = "c3aa9078-0000-0000-0000-e36f151182d7";
string resourceGroupName = "default-sql-onebox";
string serverName = "testsvr11";
ResourceIdentifier sqlServerAutomaticTuningResourceId = SqlServerAutomaticTuningResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName);
SqlServerAutomaticTuningResource sqlServerAutomaticTuning = client.GetSqlServerAutomaticTuningResource(sqlServerAutomaticTuningResourceId);

// invoke the operation
SqlServerAutomaticTuningData data = new SqlServerAutomaticTuningData
{
    DesiredState = AutomaticTuningServerMode.Auto,
    Options =
    {
    ["createIndex"] = new AutomaticTuningServerOptions
    {
    DesiredState = AutomaticTuningOptionModeDesired.Off,
    },
    ["dropIndex"] = new AutomaticTuningServerOptions
    {
    DesiredState = AutomaticTuningOptionModeDesired.On,
    },
    ["forceLastGoodPlan"] = new AutomaticTuningServerOptions
    {
    DesiredState = AutomaticTuningOptionModeDesired.Default,
    }
    },
};
SqlServerAutomaticTuningResource result = await sqlServerAutomaticTuning.UpdateAsync(data);

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
SqlServerAutomaticTuningData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Exemple de réponse

Code d’état:

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

Exemple de requête

HTTP

PATCH https://management.azure.com/subscriptions/c3aa9078-0000-0000-0000-e36f151182d7/resourceGroups/default-sql-onebox/providers/Microsoft.Sql/servers/testsvr11/automaticTuning/current?api-version=2023-08-01

{
  "properties": {
    "desiredState": "Auto"
  }
}

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/ServerAutomaticTuningUpdateMin.json
// this example is just showing the usage of "ServerAutomaticTuning_Update" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SqlServerAutomaticTuningResource created on azure
// for more information of creating SqlServerAutomaticTuningResource, please refer to the document of SqlServerAutomaticTuningResource
string subscriptionId = "c3aa9078-0000-0000-0000-e36f151182d7";
string resourceGroupName = "default-sql-onebox";
string serverName = "testsvr11";
ResourceIdentifier sqlServerAutomaticTuningResourceId = SqlServerAutomaticTuningResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName);
SqlServerAutomaticTuningResource sqlServerAutomaticTuning = client.GetSqlServerAutomaticTuningResource(sqlServerAutomaticTuningResourceId);

// invoke the operation
SqlServerAutomaticTuningData data = new SqlServerAutomaticTuningData
{
    DesiredState = AutomaticTuningServerMode.Auto,
};
SqlServerAutomaticTuningResource result = await sqlServerAutomaticTuning.UpdateAsync(data);

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
SqlServerAutomaticTuningData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Exemple de réponse

Code d’état:

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

Définitions

Nom	Description
AutomaticTuningOptionModeActual	État réel de l’option paramétrage automatique.
AutomaticTuningOptionModeDesired	État souhaité de l’option paramétrage automatique.
AutomaticTuningServerMode	État souhaité du réglage automatique.
AutomaticTuningServerOptions	Propriétés de réglage automatique pour les conseillers individuels.
AutomaticTuningServerReason	Description de la raison si vous le souhaitez et l’état réel sont différents.
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
ServerAutomaticTuning	Réglage automatique au niveau du serveur.

AutomaticTuningOptionModeActual

Énumération

État réel de l’option paramétrage automatique.

Valeur	Description
Off
On

AutomaticTuningOptionModeDesired

Énumération

État souhaité de l’option paramétrage automatique.

Valeur	Description
Off
On
Default

AutomaticTuningServerMode

Énumération

État souhaité du réglage automatique.

Valeur	Description
Custom
Auto
Unspecified

AutomaticTuningServerOptions

Object

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

Nom	Type	Description
actualState	AutomaticTuningOptionModeActual	État réel de l’option paramétrage automatique.
desiredState	AutomaticTuningOptionModeDesired	État souhaité de l’option paramétrage automatique.
reasonCode	integer (int32)	Code de raison si vous le souhaitez et l’état réel sont différents.
reasonDesc	AutomaticTuningServerReason	Description de la raison si vous le souhaitez et l’état réel sont différents.

AutomaticTuningServerReason

Énumération

Description de la raison si vous le souhaitez et l’état réel sont différents.

Valeur	Description
Default
Disabled
AutoConfigured

ErrorAdditionalInfo

Object

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires.
type	string	Type d’informations supplémentaire.

ErrorDetail

Object

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d’erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Object

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

ServerAutomaticTuning

Object

Réglage automatique au niveau du serveur.

Nom	Type	Description
id	string	ID de ressource.
name	string	Nom de la ressource.
properties.actualState	AutomaticTuningServerMode	Réglage automatique de l’état réel.
properties.desiredState	AutomaticTuningServerMode	État souhaité du réglage automatique.
properties.options	<string,  AutomaticTuningServerOptions>	Définition des options de réglage automatique.
type	string	Type de ressource.