Workload Groups - List By Database

Service:

SQL Database

API Version:

2021-11-01

Gets the list of workload groups

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/workloadGroups?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.
api-version	query	True	string	The API version to use for the request.

Responses

Name	Type	Description
200 OK	WorkloadGroupListResult	Successfully retrieved the list of workload groups.
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

Get the list of workload groups for a data warehouse

Sample Request

HTTP

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

Java

import com.azure.core.util.Context;

/** Samples for WorkloadGroups ListByDatabase. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/GetWorkloadGroupList.json
     */
    /**
     * Sample code: Get the list of workload groups for a data warehouse.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        getTheListOfWorkloadGroupsForADataWarehouse(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getWorkloadGroups().listByDatabase("Default-SQL-SouthEastAsia",
            "testsvr", "testdb", Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

200

{
  "value": [
    {
      "properties": {
        "minResourcePercent": 0,
        "maxResourcePercent": 100,
        "minResourcePercentPerRequest": 5,
        "maxResourcePercentPerRequest": 5,
        "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"
    },
    {
      "properties": {
        "minResourcePercent": 0,
        "maxResourcePercent": 100,
        "minResourcePercentPerRequest": 10,
        "maxResourcePercentPerRequest": 10,
        "importance": "normal",
        "queryExecutionTimeout": 0
      },
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb/workloadGroups/mediumrc",
      "name": "mediumrc",
      "type": "Microsoft.Sql/servers/databases/workloadGroups"
    },
    {
      "properties": {
        "minResourcePercent": 0,
        "maxResourcePercent": 100,
        "minResourcePercentPerRequest": 20,
        "maxResourcePercentPerRequest": 20,
        "importance": "high",
        "queryExecutionTimeout": 0
      },
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb/workloadGroups/largerc",
      "name": "largerc",
      "type": "Microsoft.Sql/servers/databases/workloadGroups"
    }
  ]
}

Definitions

Name	Description
WorkloadGroup	Workload group operations for a data warehouse
WorkloadGroupListResult	A list of workload groups.

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.

WorkloadGroupListResult

A list of workload groups.

Name	Type	Description
nextLink	string	Link to retrieve next page of results.
value	WorkloadGroup[]	Array of results.