Share via


Workload Groups - Create Or Update

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=2023-08-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 (int32)

The workload group cap percentage resource.

properties.minResourcePercent True

integer (int32)

The workload group minimum percentage resource.

properties.minResourcePercentPerRequest True

number (double)

The workload group request minimum grant percentage.

properties.importance

string

The workload group importance level.

properties.maxResourcePercentPerRequest

number (double)

The workload group request maximum grant percentage.

properties.queryExecutionTimeout

integer (int32)

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.

Headers

Location: string

Other Status Codes

ErrorResponse

*** Error Responses: ***

  • 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state

  • 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state

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

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

  • 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 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.

  • 404 SubscriptionDoesNotHaveServer - The requested server was not found

  • 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 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.

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

  • 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.

  • 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 DatabaseUnavailable - The operation failed because the database is unavailable.

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

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

Sample request

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=2023-08-01

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

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

Create a workload group with the required properties specified.

Sample request

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=2023-08-01

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

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

The resource management error additional info.

ErrorDetail

The error detail.

ErrorResponse

Error response

WorkloadGroup

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

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.

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.