Database Automatic Tuning - Get
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=2015-05-01-preview
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
subscription
|
path | True |
|
The subscription ID that identifies an Azure subscription. |
resource
|
path | True |
|
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. |
server
|
path | True |
|
The name of the server. |
database
|
path | True |
|
The name of the database. |
api-version
|
query | True |
|
The API version to use for the request. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
Successfully retrieved database automatic tuning properties. |
|
Other Status Codes |
*** Error Responses: ***
|
Examples
Get a database'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/databases/db1/automaticTuning/current?api-version=2015-05-01-preview
Sample Response
{
"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
Automatic |
Reason description if desired and actual state are different. |
Automatic |
Automatic tuning desired state. |
Automatic |
Automatic tuning option actual state. |
Automatic |
Automatic tuning option desired state. |
Automatic |
Automatic tuning properties for individual advisors. |
Database |
Database-level Automatic Tuning. |
AutomaticTuningDisabledReason
Reason description if desired and actual state are different.
Name | Type | Description |
---|---|---|
AutoConfigured |
|
|
Default |
|
|
Disabled |
|
|
InheritedFromServer |
|
|
NotSupported |
|
|
QueryStoreOff |
|
|
QueryStoreReadOnly |
|
AutomaticTuningMode
Automatic tuning desired state.
Name | Type | Description |
---|---|---|
Auto |
|
|
Custom |
|
|
Inherit |
|
|
Unspecified |
|
AutomaticTuningOptionModeActual
Automatic tuning option actual state.
Name | Type | Description |
---|---|---|
Off |
|
|
On |
|
AutomaticTuningOptionModeDesired
Automatic tuning option desired state.
Name | Type | Description |
---|---|---|
Default |
|
|
Off |
|
|
On |
|
AutomaticTuningOptions
Automatic tuning properties for individual advisors.
Name | Type | Description |
---|---|---|
actualState |
Automatic tuning option actual state. |
|
desiredState |
Automatic tuning option desired state. |
|
reasonCode |
|
Reason code if desired and actual state are different. |
reasonDesc |
Reason description if desired and actual state are different. |
DatabaseAutomaticTuning
Database-level Automatic Tuning.
Name | Type | Description |
---|---|---|
id |
|
Resource ID. |
name |
|
Resource name. |
properties.actualState |
Automatic tuning actual state. |
|
properties.desiredState |
Automatic tuning desired state. |
|
properties.options |
|
Automatic tuning options definition. |
type |
|
Resource type. |