Server Advisors - Get

Gets a server advisor.

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

URI Parameters

Name In Required Type Description
advisorName
path True

string

The name of the Server Advisor.

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 server advisor.

Other Status Codes

*** Error Responses: ***

  • 404 SubscriptionDoesNotHaveServer - The requested server was not found

  • 404 AdvisorNotFound - The requested advisor was not found.

  • 405 NotSupported - This functionality is not supported.

  • 409 Conflict - Request could not be processed because of conflict in the request.

  • 503 ServiceTemporarilyUnavailable - Feature temporarily unavailable.

Examples

Get server advisor

Sample request

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

Sample response

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workloadinsight-demos/providers/Microsoft.Sql/servers/misosisvr/advisors/CreateIndex",
  "name": "CreateIndex",
  "type": "Microsoft.Sql/servers/advisors",
  "properties": {
    "advisorStatus": "GA",
    "autoExecuteValue": "Disabled"
  }
}

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

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

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

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

Name Type Description
GA

string

LimitedPublicPreview

string

PrivatePreview

string

PublicPreview

string

AutoExecuteStatus

Gets the auto-execute status (whether to let the system execute the recommendations) of this advisor. Possible values are 'Enabled' and 'Disabled'

Name Type Description
Default

string

Disabled

string

Enabled

string