.alter-merge workload_group command

Switch services using the Version drop-down list. Learn more about navigation.
Applies to: ✅ Azure Data Explorer

Alter a workload group.

Permissions

You must have Cluster AllDatabasesAdmin permissions to run this command.

Syntax

.alter-merge workload_group WorkloadGroupName SerializedPolicyObject

Learn more about syntax conventions.

Parameters

* The following policies apply to workload groups:

• request classification
• request limits
• request rate limit
• request rate limits enforcement
• specify query consistency mode

Returns

The command returns one row showing the details of the workload group.

Following is the schema of the output returned:

Examples

Alter specific limits in the request limits policy

Alter specific limits in the request limits policy of the default workload group, while keeping previously defined limits unchanged.

.alter-merge workload_group default ```
{
  "RequestLimitsPolicy": {
    "DataScope": {
      "IsRelaxable": false,
      "Value": "HotCache"
    },
    "MaxExecutionTime": {
      "IsRelaxable": false,
      "Value": "00:01:00"
    }
  }
} ```

Output

Alter the request rate limit policies

Alter the request rate limit policies of the default workload group, while keeping all of its other policies unchanged.

.alter-merge workload_group default ```
{
  "RequestRateLimitPolicies": [
    {
      "IsEnabled": true,
      "Scope": "WorkloadGroup",
      "LimitKind": "ConcurrentRequests",
      "Properties": {
        "MaxConcurrentRequests": 100
      }
    }
  ]
} ```

Output

Alter the request queuing policy

Turn on request queuing for the default workload group, while keeping its request limits policy and request rate limit policies unchanged.

.alter-merge workload_group default ```
{
  "RequestQueuingPolicy": {
      "IsEnabled": true
  }
} ```

Output

Alter the request rate limits enforcement policy

Turn on request rate limits enforcement policy for the default workload group, while keeping all of its other policies unchanged.

.alter-merge workload_group default ```
{
  "RequestRateLimitsEnforcementpolicy": {
      "QueriesEnforcementLevel": "QueryHead",
      "CommandsEnforcementLevel": "Cluster"
  }
} ```

Output

Alter the query consistency policy

Specify the applicable option for the query consistency model.

.alter-merge workload_group default ```
{
  "QueryConsistencyPolicy": {
     "QueryConsistency": {
        "IsRelaxable": true,
        "Value": "Weak"
     }
  }
} ```

Output

Related content

• Workload groups
• .create-or-alter workload_group
• .drop workload_group
• .show workload_group