Database Advisors - Get

Reference

Service:: SQL Database

API Version:: 2014-04-01

Returns details of a Database Advisor.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/advisors/{advisorName}?api-version=2014-04-01

URI Parameters

Name	In	Required	Type	Description
advisorName	path	True	string	The name of the Database Advisor.
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	Advisor	Successfully retrieved details of specified database advisor.

Examples

Get database advisor

Sample request

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workloadinsight-demos/providers/Microsoft.Sql/servers/misosisvr/databases/IndexAdvisor_test_3/advisors/CreateIndex?api-version=2014-04-01

Sample response

Status code:: 200

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workloadinsight-demos/providers/Microsoft.Sql/servers/misosisvr/databases/IndexAdvisor_test_3/advisors/CreateIndex",
  "name": "CreateIndex",
  "type": "Microsoft.Sql/servers/databases/advisors",
  "properties": {
    "advisorStatus": "GA",
    "autoExecuteValue": "Enabled",
    "recommendationsStatus": "LowActivity",
    "lastChecked": "2017-07-04T13:17:13Z"
  }
}

Definitions

Name	Description
Advisor	Database Advisor.
AdvisorStatus	Gets the status of availability of this advisor to customers. Possible values are 'GA', 'PublicPreview', 'LimitedPublicPreview' and 'PrivatePreview'.
AutoExecuteStatus	Gets the auto-execute status (whether to let the system execute the recommendations) of this advisor. Possible values are 'Enabled' and 'Disabled'

Advisor

Object

Database Advisor.

Name	Type	Description
id	string	Resource ID.
kind	string	Resource kind.
location	string	Resource location.
name	string	Resource name.
properties.advisorStatus	AdvisorStatus	Gets the status of availability of this advisor to customers. Possible values are 'GA', 'PublicPreview', 'LimitedPublicPreview' and 'PrivatePreview'.
properties.autoExecuteValue	AutoExecuteStatus	Gets the auto-execute status (whether to let the system execute the recommendations) of this advisor. Possible values are 'Enabled' and 'Disabled'
properties.lastChecked	string (date-time)	Gets the time when the current resource was analyzed for recommendations by this advisor.
properties.recommendationsStatus	string	Gets that status of recommendations for this advisor and reason for not having any recommendations. Possible values include, but are not limited to, 'Ok' (Recommendations available), LowActivity (not enough workload to analyze), 'DbSeemsTuned' (Database is doing well), etc.
type	string	Resource type.

AdvisorStatus

Enumeration

Gets the status of availability of this advisor to customers. Possible values are 'GA', 'PublicPreview', 'LimitedPublicPreview' and 'PrivatePreview'.

Value	Description
GA
LimitedPublicPreview
PrivatePreview
PublicPreview

AutoExecuteStatus