Server Automatic Tuning - Get

Retrieves server automatic tuning options.

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

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

*** 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 DatabaseDoesNotExist - The requested database was not found

  • 404 SubscriptionDoesNotHaveServer - The requested server 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 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.

  • 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.

  • 503 ServiceTemporarilyUnavailable - Feature temporarily unavailable.

Examples

Get a server's automatic tuning settings

Sample Request

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

Sample Response

{
  "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.

ServerAutomaticTuning

Server-level Automatic Tuning.

AutomaticTuningOptionModeActual

Automatic tuning option actual state.

Name Type Description
Off

string

On

string

AutomaticTuningOptionModeDesired

Automatic tuning option desired state.

Name Type Description
Default

string

Off

string

On

string

AutomaticTuningServerMode

Automatic tuning desired state.

Name Type Description
Auto

string

Custom

string

Unspecified

string

AutomaticTuningServerOptions

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

Reason code if desired and actual state are different.

reasonDesc

AutomaticTuningServerReason

Reason description if desired and actual state are different.

AutomaticTuningServerReason

Reason description if desired and actual state are different.

Name Type Description
AutoConfigured

string

Default

string

Disabled

string

ServerAutomaticTuning

Server-level Automatic Tuning.

Name Type Description
id

string

Resource ID.

name

string

Resource name.

properties.actualState

AutomaticTuningServerMode

Automatic tuning actual state.

properties.desiredState

AutomaticTuningServerMode

Automatic tuning desired state.

properties.options

<string,  AutomaticTuningServerOptions>

Automatic tuning options definition.

type

string

Resource type.