Workload Groups - Create Or Update

Reference

Service:: SQL Database

API Version:: 2021-11-01

Creates or updates a workload group.

PUT 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.

Request Body

Name	Required	Type	Description
properties.maxResourcePercent	True	integer	The workload group cap percentage resource.
properties.minResourcePercent	True	integer	The workload group minimum percentage resource.
properties.minResourcePercentPerRequest	True	number	The workload group request minimum grant percentage.
properties.importance		string	The workload group importance level.
properties.maxResourcePercentPerRequest		number	The workload group request maximum grant percentage.
properties.queryExecutionTimeout		integer	The workload group query execution timeout.

Responses

Name	Type	Description
200 OK	WorkloadGroup	Successfully updated the workload group.
201 Created	WorkloadGroup	Successfully created the workload group.
202 Accepted		Create or update for the workload group accepted.
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. 400 InvalidWorkloadGroupNameParameter - Invalid workload group name 400 InvalidMinResourcePercentParameter - Invalid min resource percent for this workload group. 400 InvalidMinResourcePercentPerRequestParameter - Invalid min resource percent per query for this workload group. 400 InvalidMaxResourcePercentParameter - Invalid max resource percent to allocate for this workload group. 400 InvalidMaxResourcePercentPerRequestParameter - Invalid max resource percent per query for this workload group. 400 InvalidImportanceParameter - Importance must be one of the following strings: Low, Below_Normal, Normal, Above_Normal, High. 400 InvalidQueryExecutionTimeoutParameter - Invalid query execution timeout value for this workload group. 400 InvalidResourceRequestBody - The resource or resource properties in the request body is empty or invalid. 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. 404 OperationIdNotFound - The operation with Id does not exist. 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. 409 OperationCancelled - The operation has been cancelled by user. 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource. 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources. 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources. 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation. 503 TooManyRequests - Requests beyond max requests that can be processed by available resources. 503 DatabaseUnavailable - The operation failed because the database is unavailable. 503 TooManyRequests - Requests beyond max requests that can be processed by available resources. 504 RequestTimeout - Service request exceeded the allowed timeout.

Examples

Create a workload group with all properties specified.

Create a workload group with the required properties specified.

Create a workload group with all properties specified.

PUT 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

{
  "properties": {
    "minResourcePercent": 0,
    "maxResourcePercent": 100,
    "minResourcePercentPerRequest": 3,
    "maxResourcePercentPerRequest": 3,
    "importance": "normal",
    "queryExecutionTimeout": 0
  }
}


import com.azure.core.util.Context;
import com.azure.resourcemanager.sql.fluent.models.WorkloadGroupInner;

/** Samples for WorkloadGroups CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/CreateOrUpdateWorkloadGroupMax.json
     */
    /**
     * Sample code: Create a workload group with all properties specified.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        createAWorkloadGroupWithAllPropertiesSpecified(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getWorkloadGroups().createOrUpdate("Default-SQL-SouthEastAsia",
            "testsvr", "testdb", "smallrc",
            new WorkloadGroupInner().withMinResourcePercent(0).withMaxResourcePercent(100)
                .withMinResourcePercentPerRequest(3.0).withMaxResourcePercentPerRequest(3.0D).withImportance("normal")
                .withQueryExecutionTimeout(0),
            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

{
  "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"
}

Status code:: 201

{
  "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"
}

Status code:: 202

Create a workload group with the required properties specified.

Sample Request

HTTP
Java

PUT 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

{
  "properties": {
    "minResourcePercent": 0,
    "maxResourcePercent": 100,
    "minResourcePercentPerRequest": 3
  }
}


import com.azure.core.util.Context;
import com.azure.resourcemanager.sql.fluent.models.WorkloadGroupInner;

/** Samples for WorkloadGroups CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/CreateOrUpdateWorkloadGroupMin.json
     */
    /**
     * Sample code: Create a workload group with the required properties specified.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        createAWorkloadGroupWithTheRequiredPropertiesSpecified(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getWorkloadGroups().createOrUpdate(
            "Default-SQL-SouthEastAsia", "testsvr", "testdb", "smallrc", new WorkloadGroupInner()
                .withMinResourcePercent(0).withMaxResourcePercent(100).withMinResourcePercentPerRequest(3.0),
            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

{
  "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"
}

Status code:: 201

{
  "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"
}

Status code:: 202

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.

Workload Groups - Create Or Update

URI Parameters

Request Body

Responses

Examples

Create a workload group with all properties specified.

Sample Request

Sample Response

Create a workload group with the required properties specified.

Sample Request

Sample Response

Definitions

WorkloadGroup

Additional resources