Service Tier Advisors - List By Database

Service:

SQL Database

API Version:

2014-04-01

Returns service tier advisors for specified database.

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

URI Parameters

Name	In	Required	Type	Description
databaseName	path	True	string	The name of 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	ServiceTierAdvisorListResult	OK

Examples

Get a list of a service tier advisors

Sample Request

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Sql/servers/sqlcrudtest-2080/databases/sqlcrudtest-9187/serviceTierAdvisors?api-version=2014-04-01

Java

import com.azure.core.util.Context;

/** Samples for ServiceTierAdvisors ListByDatabase. */
public final class Main {
    /*
     * x-ms-original-file: specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/examples/ServiceTierAdvisorList.json
     */
    /**
     * Sample code: Get a list of a service tier advisors.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getAListOfAServiceTierAdvisors(com.azure.resourcemanager.AzureResourceManager azure) {
        azure
            .sqlServers()
            .manager()
            .serviceClient()
            .getServiceTierAdvisors()
            .listByDatabase("sqlcrudtest-6852", "sqlcrudtest-2080", "sqlcrudtest-9187", Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

200

{
  "value": [
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Sql/servers/sqlcrudtest-2080/databases/sqlcrudtest-9187/serviceTierAdvisors/Current",
      "name": "Current",
      "type": "Microsoft.Sql/servers/databases/serviceTierAdvisors",
      "properties": {
        "observationPeriodStart": "2017-07-12T12:00:00Z",
        "observationPeriodEnd": "2017-07-26T13:00:00Z",
        "activeTimeRatio": 0,
        "minDtu": 0,
        "avgDtu": 0,
        "maxDtu": 0,
        "maxSizeInGB": 0.0234375,
        "serviceLevelObjectiveUsageMetrics": [
          {
            "serviceLevelObjective": "Basic",
            "serviceLevelObjectiveId": "dd6d99bb-f193-4ec1-86f2-43d3bccbc49c",
            "inRangeTimeRatio": 1
          }
        ],
        "currentServiceLevelObjective": "S0",
        "currentServiceLevelObjectiveId": "f1173c43-91bd-4aaa-973c-54e79e15235b",
        "usageBasedRecommendationServiceLevelObjective": null,
        "usageBasedRecommendationServiceLevelObjectiveId": null,
        "databaseSizeBasedRecommendationServiceLevelObjective": null,
        "databaseSizeBasedRecommendationServiceLevelObjectiveId": null,
        "disasterPlanBasedRecommendationServiceLevelObjective": null,
        "disasterPlanBasedRecommendationServiceLevelObjectiveId": null,
        "overallRecommendationServiceLevelObjective": null,
        "overallRecommendationServiceLevelObjectiveId": null,
        "confidence": 1
      }
    }
  ]
}

Definitions

Name	Description
ServiceObjectiveName	The serviceLevelObjective for SLO usage metric.
ServiceTierAdvisor	Represents a Service Tier Advisor.
ServiceTierAdvisorListResult	Represents the response to a list service tier advisor request.
SloUsageMetric	A Slo Usage Metric.

ServiceObjectiveName

The serviceLevelObjective for SLO usage metric.

Name	Type	Description
Basic	string
DS100	string
DS1000	string
DS1200	string
DS1500	string
DS200	string
DS2000	string
DS300	string
DS400	string
DS500	string
DS600	string
DW100	string
DW1000	string
DW10000c	string
DW1000c	string
DW1200	string
DW1500	string
DW15000c	string
DW1500c	string
DW200	string
DW2000	string
DW2000c	string
DW2500c	string
DW300	string
DW3000	string
DW30000c	string
DW3000c	string
DW400	string
DW500	string
DW5000c	string
DW600	string
DW6000	string
DW6000c	string
DW7500c	string
ElasticPool	string
Free	string
P1	string
P11	string
P15	string
P2	string
P3	string
P4	string
P6	string
PRS1	string
PRS2	string
PRS4	string
PRS6	string
S0	string
S1	string
S12	string
S2	string
S3	string
S4	string
S6	string
S7	string
S9	string
System	string
System0	string
System1	string
System2	string
System2L	string
System3	string
System3L	string
System4	string
System4L	string

ServiceTierAdvisor

Represents a Service Tier Advisor.

Name	Type	Description
id	string	Resource ID.
name	string	Resource name.
properties.activeTimeRatio	number	The activeTimeRatio for service tier advisor.
properties.avgDtu	number	Gets or sets avgDtu for service tier advisor.
properties.confidence	number	Gets or sets confidence for service tier advisor.
properties.currentServiceLevelObjective	string	Gets or sets currentServiceLevelObjective for service tier advisor.
properties.currentServiceLevelObjectiveId	string	Gets or sets currentServiceLevelObjectiveId for service tier advisor.
properties.databaseSizeBasedRecommendationServiceLevelObjective	string	Gets or sets databaseSizeBasedRecommendationServiceLevelObjective for service tier advisor.
properties.databaseSizeBasedRecommendationServiceLevelObjectiveId	string	Gets or sets databaseSizeBasedRecommendationServiceLevelObjectiveId for service tier advisor.
properties.disasterPlanBasedRecommendationServiceLevelObjective	string	Gets or sets disasterPlanBasedRecommendationServiceLevelObjective for service tier advisor.
properties.disasterPlanBasedRecommendationServiceLevelObjectiveId	string	Gets or sets disasterPlanBasedRecommendationServiceLevelObjectiveId for service tier advisor.
properties.maxDtu	number	Gets or sets maxDtu for service tier advisor.
properties.maxSizeInGB	number	Gets or sets maxSizeInGB for service tier advisor.
properties.minDtu	number	Gets or sets minDtu for service tier advisor.
properties.observationPeriodEnd	string	The observation period start (ISO8601 format).
properties.observationPeriodStart	string	The observation period start (ISO8601 format).
properties.overallRecommendationServiceLevelObjective	string	Gets or sets overallRecommendationServiceLevelObjective for service tier advisor.
properties.overallRecommendationServiceLevelObjectiveId	string	Gets or sets overallRecommendationServiceLevelObjectiveId for service tier advisor.
properties.serviceLevelObjectiveUsageMetrics	SloUsageMetric[]	Gets or sets serviceLevelObjectiveUsageMetrics for the service tier advisor.
properties.usageBasedRecommendationServiceLevelObjective	string	Gets or sets usageBasedRecommendationServiceLevelObjective for service tier advisor.
properties.usageBasedRecommendationServiceLevelObjectiveId	string	Gets or sets usageBasedRecommendationServiceLevelObjectiveId for service tier advisor.
type	string	Resource type.

ServiceTierAdvisorListResult

Represents the response to a list service tier advisor request.

Name	Type	Description
value	ServiceTierAdvisor[]	The list of service tier advisors for specified database.

SloUsageMetric

A Slo Usage Metric.

Name	Type	Description
inRangeTimeRatio	number	Gets or sets inRangeTimeRatio for SLO usage metric.
serviceLevelObjective	ServiceObjectiveName	The serviceLevelObjective for SLO usage metric.
serviceLevelObjectiveId	string	The serviceLevelObjectiveId for SLO usage metric.