Database Automatic Tuning - Get

Service:: SQL Database

Version d'API:: 2025-01-01

Obtient le réglage automatique d’une base de données.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
databaseName	path	True	string	Nom de la base de données.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nom du groupe de ressources. Le nom ne respecte pas la casse.
serverName	path	True	string	Le nom du serveur
subscriptionId	path	True	string (uuid)	ID de l’abonnement cible. La valeur doit être un UUID.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

Réponses

Nom	Type	Description
200 OK	DatabaseAutomaticTuning	Opération Azure terminée avec succès.
Other Status Codes	ErrorResponse	Réponse d’erreur inattendue.

Sécurité

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

Get a database's automatic tuning settings

GET 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=2025-01-01

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/SQL/stable/2025-01-01/examples/DatabaseAutomaticTuningGet.json
// this example is just showing the usage of "DatabaseAutomaticTuning_Get" 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 SqlDatabaseAutomaticTuningResource created on azure
// for more information of creating SqlDatabaseAutomaticTuningResource, please refer to the document of SqlDatabaseAutomaticTuningResource
string subscriptionId = "c3aa9078-0000-0000-0000-e36f151182d7";
string resourceGroupName = "default-sql-onebox";
string serverName = "testsvr11";
string databaseName = "db1";
ResourceIdentifier sqlDatabaseAutomaticTuningResourceId = SqlDatabaseAutomaticTuningResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, databaseName);
SqlDatabaseAutomaticTuningResource sqlDatabaseAutomaticTuning = client.GetSqlDatabaseAutomaticTuningResource(sqlDatabaseAutomaticTuningResourceId);

// invoke the operation
SqlDatabaseAutomaticTuningResource result = await sqlDatabaseAutomaticTuning.GetAsync();

// 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
SqlDatabaseAutomaticTuningData 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

{
  "name": "current",
  "type": "Microsoft.Sql/servers/databases/automaticTuning",
  "id": "/subscriptions/c3aa9078-0000-0000-0000-e36f151182d7/resourceGroups/default-sql-onebox/providers/Microsoft.Sql/servers/testsvr11/databases/db1/automaticTuning/current",
  "properties": {
    "actualState": "Auto",
    "desiredState": "Auto",
    "options": {
      "createIndex": {
        "actualState": "On",
        "desiredState": "Default",
        "reasonCode": 2,
        "reasonDesc": "AutoConfigured"
      },
      "dropIndex": {
        "actualState": "Off",
        "desiredState": "Default",
        "reasonCode": 2,
        "reasonDesc": "AutoConfigured"
      },
      "forceLastGoodPlan": {
        "actualState": "On",
        "desiredState": "Default",
        "reasonCode": 2,
        "reasonDesc": "AutoConfigured"
      },
      "maintainIndex": {
        "actualState": "Off",
        "desiredState": "Default",
        "reasonCode": 2,
        "reasonDesc": "AutoConfigured"
      }
    }
  }
}

Définitions

Nom	Description
AutomaticTuningDisabledReason	Description de la raison si vous le souhaitez et l’état réel sont différents.
AutomaticTuningMode	État souhaité du réglage automatique.
AutomaticTuningOptionModeActual	État réel de l’option paramétrage automatique.
AutomaticTuningOptionModeDesired	État souhaité de l’option paramétrage automatique.
AutomaticTuningOptions	Propriétés de réglage automatique pour les conseillers individuels.
createdByType	Type d’identité qui a créé la ressource.
DatabaseAutomaticTuning	Réglage automatique au niveau de la base de données.
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.

AutomaticTuningDisabledReason

Énumération

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

Valeur	Description
Default	Par défaut
Disabled	Désactivé
AutoConfigured	AutoConfiguré
InheritedFromServer	InheritedFromServer
QueryStoreOff	QueryStoreOff
QueryStoreReadOnly	QueryStoreReadOnly
NotSupported	Non pris en charge

AutomaticTuningMode

Énumération

État souhaité du réglage automatique.

Valeur	Description
Inherit	Hériter
Custom	Personnalisée
Auto	Auto
Unspecified	Non spécifié

AutomaticTuningOptionModeActual

Énumération

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

Valeur	Description
Off	Désactivé
On	Il en va

AutomaticTuningOptionModeDesired

Énumération

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

Valeur	Description
Off	Désactivé
On	Il en va
Default	Par défaut

AutomaticTuningOptions

Objet

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	AutomaticTuningDisabledReason	Description de la raison si vous le souhaitez et l’état réel sont différents.

createdByType

Énumération

Type d’identité qui a créé la ressource.

Valeur	Description
User
Application
ManagedIdentity
Key