Workload Groups - Get

Gets a workload group

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/workloadGroups/{workloadGroupName}?api-version=2021-11-01

URI Parameters

Name In Required Type Description
databaseName
path True

string

The name of the 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.

workloadGroupName
path True

string

The name of the workload group.

api-version
query True

string

The API version to use for the request.

Responses

Name Type Description
200 OK

WorkloadGroup

Successfully retrieved the specifies workload group.

Other Status Codes

*** Error Responses: ***

  • 400 OperationNotAllowedOnPausedDatabase - Operation is not allowed on a paused database.

  • 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.

  • 404 SubscriptionDoesNotHaveServer - The requested server was not found

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

  • 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.

  • 404 ResourceNotFound - The requested resource was not found.

  • 409 ConflictingDatabaseOperation - There is already some operation on the database and the current operation should wait till it is done.

  • 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.

  • 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.

  • 503 DatabaseUnavailable - The operation failed because the database is unavailable.

  • 504 RequestTimeout - Service request exceeded the allowed timeout.

Examples

Gets a workload group for a data warehouse

Sample request

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb/workloadGroups/smallrc?api-version=2021-11-01

Sample response

{
  "properties": {
    "minResourcePercent": 0,
    "maxResourcePercent": 100,
    "minResourcePercentPerRequest": 3,
    "maxResourcePercentPerRequest": 3,
    "importance": "normal",
    "queryExecutionTimeout": 0
  },
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb/workloadGroups/smallrc",
  "name": "smallrc",
  "type": "Microsoft.Sql/servers/databases/workloadGroups"
}

Definitions

WorkloadGroup

Workload group operations for a data warehouse

Name Type Description
id

string

Resource ID.

name

string

Resource name.

properties.importance

string

The workload group importance level.

properties.maxResourcePercent

integer

The workload group cap percentage resource.

properties.maxResourcePercentPerRequest

number

The workload group request maximum grant percentage.

properties.minResourcePercent

integer

The workload group minimum percentage resource.

properties.minResourcePercentPerRequest

number

The workload group request minimum grant percentage.

properties.queryExecutionTimeout

integer

The workload group query execution timeout.

type

string

Resource type.