Workload Groups - Create Or Update

Serviço:

SQL Database

Versão da API:

2025-01-01

Cria ou atualiza um grupo de carga de trabalho.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/workloadGroups/{workloadGroupName}?api-version=2025-01-01

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
databaseName	path	True	string	O nome do banco de dados.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
serverName	path	True	string	O nome do servidor.
subscriptionId	path	True	string (uuid)	A ID da assinatura de destino. O valor deve ser uma UUID.
workloadGroupName	path	True	string	O nome do grupo de carga de trabalho.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
properties.maxResourcePercent	True	integer (int32)	O recurso de percentual de limite do grupo de carga de trabalho.
properties.minResourcePercent	True	integer (int32)	O recurso de porcentagem mínima do grupo de carga de trabalho.
properties.minResourcePercentPerRequest	True	number (double)	O grupo de carga de trabalho solicita um percentual mínimo de concessão.
properties.importance		string	O nível de importância do grupo de carga de trabalho.
properties.maxResourcePercentPerRequest		number (double)	O grupo de carga de trabalho solicita o percentual máximo de concessão.
properties.queryExecutionTimeout		integer (int32)	O tempo limite de execução da consulta do grupo de carga de trabalho.

Respostas

Nome	Tipo	Description
200 OK	WorkloadGroup	Operação de atualização do recurso 'WorkloadGroup' foi bem-sucedida
201 Created	WorkloadGroup	Recurso 'WorkloadGroup' criar operação bem-sucedida Cabeçalhos Location: string Retry-After: integer
202 Accepted		Operação de recurso aceita. Cabeçalhos Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Segurança

azure_auth

Azure Active Directory OAuth2 Flow.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

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.

Solicitação de exemplo

HTTP

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=2025-01-01

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

Java

import com.azure.resourcemanager.sql.fluent.models.WorkloadGroupInner;

/**
 * Samples for WorkloadGroups CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-01-01/CreateOrUpdateWorkloadGroupMax.json
     */
    /**
     * Sample code: Create a workload group with all properties specified.
     * 
     * @param manager Entry point to SqlServerManager.
     */
    public static void
        createAWorkloadGroupWithAllPropertiesSpecified(com.azure.resourcemanager.sql.SqlServerManager manager) {
        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),
            com.azure.core.util.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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.sql import SqlManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-sql
# USAGE
    python create_or_update_workload_group_max.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = SqlManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.workload_groups.begin_create_or_update(
        resource_group_name="Default-SQL-SouthEastAsia",
        server_name="testsvr",
        database_name="testdb",
        workload_group_name="smallrc",
        parameters={
            "properties": {
                "importance": "normal",
                "maxResourcePercent": 100,
                "maxResourcePercentPerRequest": 3,
                "minResourcePercent": 0,
                "minResourcePercentPerRequest": 3,
                "queryExecutionTimeout": 0,
            }
        },
    ).result()
    print(response)


# x-ms-original-file: 2025-01-01/CreateOrUpdateWorkloadGroupMax.json
if __name__ == "__main__":
    main()

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

JavaScript

const { SqlManagementClient } = require("@azure/arm-sql");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to creates or updates a workload group.
 *
 * @summary creates or updates a workload group.
 * x-ms-original-file: 2025-01-01/CreateOrUpdateWorkloadGroupMax.json
 */
async function createAWorkloadGroupWithAllPropertiesSpecified() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-1111-2222-3333-444444444444";
  const client = new SqlManagementClient(credential, subscriptionId);
  const result = await client.workloadGroups.createOrUpdate(
    "Default-SQL-SouthEastAsia",
    "testsvr",
    "testdb",
    "smallrc",
    {
      importance: "normal",
      maxResourcePercent: 100,
      maxResourcePercentPerRequest: 3,
      minResourcePercent: 0,
      minResourcePercentPerRequest: 3,
      queryExecutionTimeout: 0,
    },
  );
  console.log(result);
}

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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/SQL/stable/2025-01-01/examples/CreateOrUpdateWorkloadGroupMax.json
// this example is just showing the usage of "WorkloadGroups_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this WorkloadGroupResource created on azure
// for more information of creating WorkloadGroupResource, please refer to the document of WorkloadGroupResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "Default-SQL-SouthEastAsia";
string serverName = "testsvr";
string databaseName = "testdb";
string workloadGroupName = "smallrc";
ResourceIdentifier workloadGroupResourceId = WorkloadGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, databaseName, workloadGroupName);
WorkloadGroupResource workloadGroup = client.GetWorkloadGroupResource(workloadGroupResourceId);

// invoke the operation
WorkloadGroupData data = new WorkloadGroupData
{
    MinResourcePercent = 0,
    MaxResourcePercent = 100,
    MinResourcePercentPerRequest = 3,
    MaxResourcePercentPerRequest = 3,
    Importance = "normal",
    QueryExecutionTimeout = 0,
};
ArmOperation<WorkloadGroupResource> lro = await workloadGroup.UpdateAsync(WaitUntil.Completed, data);
WorkloadGroupResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
WorkloadGroupData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

Resposta de exemplo

Código de status:

200

{
  "name": "smallrc",
  "type": "Microsoft.Sql/servers/databases/workloadGroups",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb/workloadGroups/smallrc",
  "properties": {
    "importance": "normal",
    "maxResourcePercent": 100,
    "maxResourcePercentPerRequest": 3,
    "minResourcePercent": 0,
    "minResourcePercentPerRequest": 3,
    "queryExecutionTimeout": 0
  }
}

Código de status:

201

{
  "name": "smallrc",
  "type": "Microsoft.Sql/servers/databases/workloadGroups",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb/workloadGroups/smallrc",
  "properties": {
    "importance": "normal",
    "maxResourcePercent": 100,
    "maxResourcePercentPerRequest": 3,
    "minResourcePercent": 0,
    "minResourcePercentPerRequest": 3,
    "queryExecutionTimeout": 0
  }
}

Código de status:

202

Create a workload group with the required properties specified.

Solicitação de exemplo

HTTP

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=2025-01-01

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

Java

import com.azure.resourcemanager.sql.fluent.models.WorkloadGroupInner;

/**
 * Samples for WorkloadGroups CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-01-01/CreateOrUpdateWorkloadGroupMin.json
     */
    /**
     * Sample code: Create a workload group with the required properties specified.
     * 
     * @param manager Entry point to SqlServerManager.
     */
    public static void
        createAWorkloadGroupWithTheRequiredPropertiesSpecified(com.azure.resourcemanager.sql.SqlServerManager manager) {
        manager.serviceClient().getWorkloadGroups().createOrUpdate(
            "Default-SQL-SouthEastAsia", "testsvr", "testdb", "smallrc", new WorkloadGroupInner()
                .withMinResourcePercent(0).withMaxResourcePercent(100).withMinResourcePercentPerRequest(3.0),
            com.azure.core.util.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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.sql import SqlManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-sql
# USAGE
    python create_or_update_workload_group_min.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = SqlManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.workload_groups.begin_create_or_update(
        resource_group_name="Default-SQL-SouthEastAsia",
        server_name="testsvr",
        database_name="testdb",
        workload_group_name="smallrc",
        parameters={
            "properties": {"maxResourcePercent": 100, "minResourcePercent": 0, "minResourcePercentPerRequest": 3}
        },
    ).result()
    print(response)


# x-ms-original-file: 2025-01-01/CreateOrUpdateWorkloadGroupMin.json
if __name__ == "__main__":
    main()

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

JavaScript

const { SqlManagementClient } = require("@azure/arm-sql");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to creates or updates a workload group.
 *
 * @summary creates or updates a workload group.
 * x-ms-original-file: 2025-01-01/CreateOrUpdateWorkloadGroupMin.json
 */
async function createAWorkloadGroupWithTheRequiredPropertiesSpecified() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-1111-2222-3333-444444444444";
  const client = new SqlManagementClient(credential, subscriptionId);
  const result = await client.workloadGroups.createOrUpdate(
    "Default-SQL-SouthEastAsia",
    "testsvr",
    "testdb",
    "smallrc",
    { maxResourcePercent: 100, minResourcePercent: 0, minResourcePercentPerRequest: 3 },
  );
  console.log(result);
}

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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/SQL/stable/2025-01-01/examples/CreateOrUpdateWorkloadGroupMin.json
// this example is just showing the usage of "WorkloadGroups_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this WorkloadGroupResource created on azure
// for more information of creating WorkloadGroupResource, please refer to the document of WorkloadGroupResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "Default-SQL-SouthEastAsia";
string serverName = "testsvr";
string databaseName = "testdb";
string workloadGroupName = "smallrc";
ResourceIdentifier workloadGroupResourceId = WorkloadGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, databaseName, workloadGroupName);
WorkloadGroupResource workloadGroup = client.GetWorkloadGroupResource(workloadGroupResourceId);

// invoke the operation
WorkloadGroupData data = new WorkloadGroupData
{
    MinResourcePercent = 0,
    MaxResourcePercent = 100,
    MinResourcePercentPerRequest = 3,
};
ArmOperation<WorkloadGroupResource> lro = await workloadGroup.UpdateAsync(WaitUntil.Completed, data);
WorkloadGroupResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
WorkloadGroupData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

Resposta de exemplo

Código de status:

200

{
  "name": "smallrc",
  "type": "Microsoft.Sql/servers/databases/workloadGroups",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb/workloadGroups/smallrc",
  "properties": {
    "importance": "normal",
    "maxResourcePercent": 100,
    "maxResourcePercentPerRequest": 3,
    "minResourcePercent": 0,
    "minResourcePercentPerRequest": 3,
    "queryExecutionTimeout": 0
  }
}

Código de status:

201

{
  "name": "smallrc",
  "type": "Microsoft.Sql/servers/databases/workloadGroups",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb/workloadGroups/smallrc",
  "properties": {
    "importance": "normal",
    "maxResourcePercent": 100,
    "maxResourcePercentPerRequest": 3,
    "minResourcePercent": 0,
    "minResourcePercentPerRequest": 3,
    "queryExecutionTimeout": 0
  }
}

Código de status:

202

Definições

Nome	Description
createdByType	O tipo de identidade que criou o recurso.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
systemData	Metadados relativos à criação e última modificação do recurso.
WorkloadGroup	Operações de grupo de carga de trabalho para um data warehouse

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Objeto

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

systemData

Objeto

Metadados relativos à criação e última modificação do recurso.

Nome	Tipo	Description
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

WorkloadGroup

Objeto

Operações de grupo de carga de trabalho para um data warehouse

Nome	Tipo	Description
id	string (arm-id)	ID de recurso totalmente qualificada para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	O nome do recurso
properties.importance	string	O nível de importância do grupo de carga de trabalho.
properties.maxResourcePercent	integer (int32)	O recurso de percentual de limite do grupo de carga de trabalho.
properties.maxResourcePercentPerRequest	number (double)	O grupo de carga de trabalho solicita o percentual máximo de concessão.
properties.minResourcePercent	integer (int32)	O recurso de porcentagem mínima do grupo de carga de trabalho.
properties.minResourcePercentPerRequest	number (double)	O grupo de carga de trabalho solicita um percentual mínimo de concessão.
properties.queryExecutionTimeout	integer (int32)	O tempo limite de execução da consulta do grupo de carga de trabalho.
systemData	systemData	Metadados do Azure Resource Manager contendo informações createdBy e modifiedBy.
type	string	O tipo do recurso. Por exemplo, "Microsoft. Compute/virtualMachines" ou "Microsoft. ContasArmazenamento/Armazenamento"