Database Automatic Tuning - Get

Servizio:

SQL Database

Versione API:

2023-08-01

Ottiene l'ottimizzazione automatica di un database.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/automaticTuning/current?api-version=2023-08-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	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.

Risposte

Nome	Tipo	Descrizione
200 OK	DatabaseAutomaticTuning	Le proprietà di ottimizzazione automatica del database sono state recuperate correttamente.
Other Status Codes	ErrorResponse	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. 404 SubscriptionDoesNotHaveServer - Il server richiesto non è stato trovato 404 DatabaseDoesNotExist - Impossibile trovare il database richiesto 404 SubscriptionDoesNotHaveElasticPool - Il pool elastico richiesto non è stato trovato 404 OperationIdNotFound - L'operazione con ID non esiste. 405 NotSupported : questa funzionalità non è supportata. 409 Conflitto - Impossibile elaborare la richiesta a causa di un conflitto nella richiesta. 409 CannotCancelOperation: l'operazione di gestione si trova in uno stato che non può essere annullato. 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. 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

Get a database's automatic tuning settings

Esempio di richiesta

HTTP

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=2023-08-01

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

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.
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore

AutomaticTuningDisabledReason

Enumerazione

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

Valore	Descrizione
Default
Disabled
AutoConfigured
InheritedFromServer
QueryStoreOff
QueryStoreReadOnly
NotSupported

AutomaticTuningMode

Enumerazione

Ottimizzazione automatica dello stato desiderato.

Valore	Descrizione
Inherit
Custom
Auto
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
Off
On
Default

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.

ErrorAdditionalInfo

Object

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorDetail

Object

Dettagli dell'errore.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorDetail[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorResponse

Object

Risposta di errore

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.