Workspace Managed Sql Server Usages - List

Get list of usages metric for the server.
Get list of server usages metric for workspace managed sql server.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlUsages?api-version=2021-06-01

URI Parameters

Name In Required Type Description
resourceGroupName
path True

string

The name of the resource group. The name is case insensitive.

subscriptionId
path True

string

The ID of the target subscription.

workspaceName
path True

string

The name of the workspace.

api-version
query True

string

The API version to use for this operation.

Responses

Name Type Description
200 OK

ServerUsageListResult

OK

Other Status Codes

*** Error Responses: ***

  • 404 SubscriptionDoesNotHaveServer - The requested server was not found.

  • 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.

  • 409 UnsupportedWorkspaceType - Unsupported operation for the workspace type.

  • 500 InternalServerError - Something went wrong.

Examples

List usages metric for the workspace managed sql server

Sample Request

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/wsg-7398/providers/Microsoft.Synapse/workspaces/testWorkspace/sqlUsages?api-version=2021-06-01

Sample Response

{
  "value": [
    {
      "name": "server_dtu_quota",
      "resourceName": "testWorkspace",
      "displayName": "Database Throughput Unit Quota",
      "currentValue": 0,
      "limit": 45000,
      "unit": "DTUs",
      "nextResetTime": null
    },
    {
      "name": "server_dtu_quota_current",
      "resourceName": "testWorkspace",
      "displayName": "Database Throughput Unit Quota",
      "currentValue": 0,
      "limit": 45000,
      "unit": "DTUs",
      "nextResetTime": null
    }
  ]
}

Definitions

Name Description
ServerUsage

Represents server metrics.

ServerUsageListResult

Represents the response to a list server metrics request.

ServerUsage

Represents server metrics.

Name Type Description
currentValue

number

The current value of the metric.

displayName

string

The metric display name.

limit

number

The current limit of the metric.

name

string

Name of the server usage metric.

nextResetTime

string

The next reset time for the metric (ISO8601 format).

resourceName

string

The name of the resource.

unit

string

The units of the metric.

ServerUsageListResult

Represents the response to a list server metrics request.

Name Type Description
nextLink

string

Link to retrieve next page of results.

value

ServerUsage[]

The list of server metrics for the server.