Database Automatic Tuning - Get

Service:: SQL Database

API Version:: 2023-08-01

Gets a database's automatic tuning.

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

URI Parameters

Name	In	Required	Type	Description
databaseName	path	True	string	The name of the database.
resourceGroupName	path	True	string	The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serverName	path	True	string	The name of the server.
subscriptionId	path	True	string	The subscription ID that identifies an Azure subscription.
api-version	query	True	string	The API version to use for the request.

Responses

Name	Type	Description
200 OK	DatabaseAutomaticTuning	Successfully retrieved database automatic tuning properties.
Other Status Codes	ErrorResponse	* Error Responses: * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition. 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character. 400 SystemDatabasesNotSupported - User tried to get automatic tuning information on system databases. 400 DataWarehouseNotSupported - Automatic tuning is not supported for SQL Data Warehouse. 404 SubscriptionDoesNotHaveServer - The requested server was not found 404 DatabaseDoesNotExist - The requested database was not found 404 SubscriptionDoesNotHaveElasticPool - The requested elastic pool was not found 404 OperationIdNotFound - The operation with Id does not exist. 405 NotSupported - This functionality is not supported. 409 Conflict - Request could not be processed because of conflict in the request. 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled. 409 OperationCancelled - The operation has been cancelled by user. 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource. 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources. 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources. 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation. 503 ServiceTemporarilyUnavailable - Feature temporarily unavailable. 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.

Name

Type

Description

200 OK

DatabaseAutomaticTuning

Successfully retrieved database automatic tuning properties.

Other Status Codes

ErrorResponse

*** Error Responses: ***

400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.
400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.
400 SystemDatabasesNotSupported - User tried to get automatic tuning information on system databases.
400 DataWarehouseNotSupported - Automatic tuning is not supported for SQL Data Warehouse.
404 SubscriptionDoesNotHaveServer - The requested server was not found
404 DatabaseDoesNotExist - The requested database was not found
404 SubscriptionDoesNotHaveElasticPool - The requested elastic pool was not found
404 OperationIdNotFound - The operation with Id does not exist.
405 NotSupported - This functionality is not supported.
409 Conflict - Request could not be processed because of conflict in the request.
409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.
409 OperationCancelled - The operation has been cancelled by user.
409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.
429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.
429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.
500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.
503 ServiceTemporarilyUnavailable - Feature temporarily unavailable.
503 TooManyRequests - Requests beyond max requests that can be processed by available resources.

Examples

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=2023-08-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/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://free.blessedness.top/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

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

Definitions

Name	Description
AutomaticTuningDisabledReason	Reason description if desired and actual state are different.
AutomaticTuningMode	Automatic tuning desired state.
AutomaticTuningOptionModeActual	Automatic tuning option actual state.
AutomaticTuningOptionModeDesired	Automatic tuning option desired state.
AutomaticTuningOptions	Automatic tuning properties for individual advisors.
DatabaseAutomaticTuning	Database-level Automatic Tuning.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response

AutomaticTuningDisabledReason

Enumeration

Reason description if desired and actual state are different.

Value	Description
Default
Disabled
AutoConfigured
InheritedFromServer
QueryStoreOff
QueryStoreReadOnly
NotSupported

AutomaticTuningMode

Enumeration

Automatic tuning desired state.

Value	Description
Inherit
Custom
Auto
Unspecified

AutomaticTuningOptionModeActual

Enumeration

Automatic tuning option actual state.

Value	Description
Off
On

AutomaticTuningOptionModeDesired

Enumeration

Automatic tuning option desired state.

Value	Description
Off
On
Default

AutomaticTuningOptions

Object

Automatic tuning properties for individual advisors.

Name	Type	Description
actualState	AutomaticTuningOptionModeActual	Automatic tuning option actual state.
desiredState	AutomaticTuningOptionModeDesired	Automatic tuning option desired state.
reasonCode	integer (int32)	Reason code if desired and actual state are different.
reasonDesc	AutomaticTuningDisabledReason	Reason description if desired and actual state are different.