Server Automatic Tuning - Get

Reference

Service:: SQL Database

API Version:: 2023-08-01

Retrieves server automatic tuning options.

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

URI Parameters

Name	In	Required	Type	Description
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	ServerAutomaticTuning	Successfully retrieved server 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. 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

ServerAutomaticTuning

Successfully retrieved server 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.
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 server's automatic tuning settings

Sample request

HTTP

GET 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

Sample response

Status code:: 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"
      }
    }
  }
}

Definitions

Name	Description
AutomaticTuningOptionModeActual	Automatic tuning option actual state.
AutomaticTuningOptionModeDesired	Automatic tuning option desired state.
AutomaticTuningServerMode	Automatic tuning desired state.
AutomaticTuningServerOptions	Automatic tuning properties for individual advisors.
AutomaticTuningServerReason	Reason description if desired and actual state are different.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
ServerAutomaticTuning	Server-level Automatic Tuning.

AutomaticTuningOptionModeActual

Enumeration

Automatic tuning option actual state.

Value	Description
Off
On

AutomaticTuningOptionModeDesired

Enumeration

Automatic tuning option desired state.

Value	Description
Default
Off
On

AutomaticTuningServerMode

Enumeration

Automatic tuning desired state.

Value	Description
Auto
Custom
Unspecified

AutomaticTuningServerOptions

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	AutomaticTuningServerReason	Reason description if desired and actual state are different.

AutomaticTuningServerReason

Enumeration

Reason description if desired and actual state are different.

Value	Description
AutoConfigured
Default
Disabled

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.