Get Service Objective Dimension Setting (classic)

 

THIS TOPIC APPLIES TO: noSQL Server yesAzure SQL DatabaseyesAzure SQL Data Warehouse noParallel Data Warehouse

Gets a service objective dimension setting for an Azure SQL Database Server.

Important

The recommended REST commands to work with SQL Database are the Resource Manager based Azure SQL Database REST API. While there is no change to SQL Database, be aware that the classic deployment model command in this article is scheduled for deprecation on December 1, 2019. For a table providing links to the specific new commands you should use, see Operations for Azure SQL Databases.

Request

The Get Service Objective Dimension Setting request must be specified as follows:

  • Replace {subscriptionId} with your subscription ID.

  • Replace {serverName} with your server name.

  • Replace {dimensionSettingId} with your dimension setting ID.

Method Request URI HTTP Version
GET https://management.core.windows.net:8443/{subscriptionId}/services/sqlservers/servers/{serverName}/dimensionsettings/{dimensionSettingId} HTTP/1.1

URI Parameters

None.

Request Headers

The following table describes the required and optional request headers:

Request Header Description
x-ms-version Required. Specifies the version of the operation to use for this request. This header should be set to 2012-03-01.

Request Body

None.

Response

The response includes an HTTP status code, a set of response headers, and a response body.

Status Code

Response Headers

The response for this operation includes the following headers. The response may also include additional standard HTTP headers. All standard headers conform to the HTTP/1.1 protocol specification.

Response Header Description
x-ms-request-id A value that uniquely identifies a request made against the database management service. This request id is used for request tracking. If a failure occurs that requires the user to contact Microsoft Support, the request id should be provided to Microsoft to assist in tracking and resolving the failure for the request.

Response Body

The following is an example response body:

<ServiceResource xmlns="https://schemas.microsoft.com/windowsazure" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">  
  <Name>Shared</Name>  
  <Type>Microsoft.SqlAzure.DimensionSetting</Type>  
  <State>Normal</State>  
  <SelfLink>https://management.core.windows.net/2eae7c21-ffd1-49e4-ac22-39095e0b9f02/services/sqlservers/servers/bpr0d6li5t/dimensionsettings/22467ff6-6823-4d18-a169-913150e7714f</SelfLink>  
  <ParentLink>https://management.core.windows.net/2eae7c21-ffd1-49e4-ac22-39095e0b9f02/services/sqlservers/servers/bpr0d6li5t</ParentLink>  
  <Id>22467ff6-6823-4d18-a169-913150e7714f</Id>  
  <Description>Resource capacity is not reserved.</Description>  
  <Ordinal>1</Ordinal>  
  <IsDefault>True</IsDefault>  
</ServiceResource>  

The following table describes the elements in the response body:

Element Name Description
Name The name of the dimension setting.
Type The type of the service resource; Microsoft.SqlAzure.DimensionSetting.
State The state of the service resource.
SelfLink The URI identifier for this service resource.
ParentLink The URI identifier for the parent of this resource (the server).
Id The identifier for this service resource.
Description A detailed description.
Ordinal Specifies the ordinal position of this dimension setting.
IsDefault Specifies if this is the default dimension setting.

See Also

Common REST API Error Codes
Azure SQL Database
Operations for Azure SQL Databases
List Service Objective Dimension Settings (classic)
Azure SQL Database Cmdlets