Service Tier Advisors - Get

Service:: SQL Database

API Version:: 2014-04-01

Gets a service tier advisor.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/serviceTierAdvisors/{serviceTierAdvisorName}?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.
serviceTierAdvisorName	path	True	string	The name of service tier advisor.
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	ServiceTierAdvisor	OK

Examples

Get a service tier advisor

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

import com.azure.core.util.Context;

/** Samples for ServiceTierAdvisors Get. */
public final class Main {
    /*
     * x-ms-original-file: specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/examples/ServiceTierAdvisorGet.json
     */
    /**
     * Sample code: Get a service tier advisor.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getAServiceTierAdvisor(com.azure.resourcemanager.AzureResourceManager azure) {
        azure
            .sqlServers()
            .manager()
            .serviceClient()
            .getServiceTierAdvisors()
            .getWithResponse("sqlcrudtest-6852", "sqlcrudtest-2080", "sqlcrudtest-9187", "Current", 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

{
  "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.
SloUsageMetric	A Slo Usage Metric.

ServiceObjectiveName

Enumeration

The serviceLevelObjective for SLO usage metric.

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

ServiceTierAdvisor

Object

Represents a Service Tier Advisor.

Name	Type	Description
id	string	Resource ID.
name	string	Resource name.
properties.activeTimeRatio	number (double)	The activeTimeRatio for service tier advisor.
properties.avgDtu	number (double)	Gets or sets avgDtu for service tier advisor.
properties.confidence	number (double)	Gets or sets confidence for service tier advisor.
properties.currentServiceLevelObjective	string	Gets or sets currentServiceLevelObjective for service tier advisor.
properties.currentServiceLevelObjectiveId	string (uuid)	Gets or sets currentServiceLevelObjectiveId for service tier advisor.
properties.databaseSizeBasedRecommendationServiceLevelObjective	string	Gets or sets databaseSizeBasedRecommendationServiceLevelObjective for service tier advisor.
properties.databaseSizeBasedRecommendationServiceLevelObjectiveId	string (uuid)	Gets or sets databaseSizeBasedRecommendationServiceLevelObjectiveId for service tier advisor.
properties.disasterPlanBasedRecommendationServiceLevelObjective	string	Gets or sets disasterPlanBasedRecommendationServiceLevelObjective for service tier advisor.
properties.disasterPlanBasedRecommendationServiceLevelObjectiveId	string (uuid)	Gets or sets disasterPlanBasedRecommendationServiceLevelObjectiveId for service tier advisor.
properties.maxDtu	number (double)	Gets or sets maxDtu for service tier advisor.
properties.maxSizeInGB	number (double)	Gets or sets maxSizeInGB for service tier advisor.
properties.minDtu	number (double)	Gets or sets minDtu for service tier advisor.
properties.observationPeriodEnd	string (date-time)	The observation period start (ISO8601 format).
properties.observationPeriodStart	string (date-time)	The observation period start (ISO8601 format).
properties.overallRecommendationServiceLevelObjective	string	Gets or sets overallRecommendationServiceLevelObjective for service tier advisor.
properties.overallRecommendationServiceLevelObjectiveId	string (uuid)	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 (uuid)	Gets or sets usageBasedRecommendationServiceLevelObjectiveId for service tier advisor.
type	string	Resource type.

SloUsageMetric