Sql Pool Usages - List

Gets SQL pool usages.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlPools/{sqlPoolName}/usages?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.

sqlPoolName
path True

string

SQL pool name

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

SqlPoolUsageListResult

OK

Other Status Codes

ErrorResponse

Examples

List the usages of a SQL Analytics pool

Sample Request

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6730/providers/Microsoft.Synapse/workspaces/sqlcrudtest-9007/sqlPools/3481/usages?api-version=2021-06-01

Sample Response

{
  "value": [
    {
      "name": "database_size",
      "resourceName": "3481",
      "displayName": "Database Size",
      "currentValue": 4194304,
      "limit": 268435456000,
      "unit": "Bytes",
      "nextResetTime": null
    }
  ]
}

Definitions

Name Description
ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorResponse

Error response

SqlPoolUsage

The Sql pool usages.

SqlPoolUsageListResult

The response to a list Sql pool usages request.

ErrorAdditionalInfo

The resource management error additional info.

Name Type Description
info

object

The additional info.

type

string

The additional info type.

ErrorDetail

The error detail.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

The error additional info.

code

string

The error code.

details

ErrorDetail[]

The error details.

message

string

The error message.

target

string

The error target.

ErrorResponse

Error response

Name Type Description
error

ErrorDetail

The error object.

SqlPoolUsage

The Sql pool usages.

Name Type Description
currentValue

number

The current value of the usage metric.

displayName

string

The usage metric display name.

limit

number

The current limit of the usage metric.

name

string

The name of the usage metric.

nextResetTime

string

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

resourceName

string

The name of the resource.

unit

string

The units of the usage metric.

SqlPoolUsageListResult

The response to a list Sql pool usages request.

Name Type Description
nextLink

string

Link to retrieve next page of results.

value

SqlPoolUsage[]

The list of usages for the Sql pool.