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=2023-08-01
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
|
database
|
path | True |
string |
The name of the database. |
|
resource
|
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. |
|
server
|
path | True |
string |
The name of the server. |
|
subscription
|
path | True |
string |
The subscription ID that identifies an Azure subscription. |
|
workload
|
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 |
Successfully retrieved the specifies workload group. |
|
| Other Status Codes |
*** Error Responses: ***
|
Examples
Gets a workload group for a data warehouse
Sample request
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
| Name | Description |
|---|---|
|
Error |
The resource management error additional info. |
|
Error |
The error detail. |
|
Error |
Error response |
|
Workload |
Workload group operations for a data warehouse |
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 |
The error additional info. |
|
| code |
string |
The error code. |
| details |
The error details. |
|
| message |
string |
The error message. |
| target |
string |
The error target. |
ErrorResponse
Error response
| Name | Type | Description |
|---|---|---|
| error |
The error object. |
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 (int32) |
The workload group cap percentage resource. |
| properties.maxResourcePercentPerRequest |
number (double) |
The workload group request maximum grant percentage. |
| properties.minResourcePercent |
integer (int32) |
The workload group minimum percentage resource. |
| properties.minResourcePercentPerRequest |
number (double) |
The workload group request minimum grant percentage. |
| properties.queryExecutionTimeout |
integer (int32) |
The workload group query execution timeout. |
| type |
string |
Resource type. |