Workload Groups - Create Or Update

Referência

Serviço:: SQL Database

Versão da API:: 2023-08-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=2023-08-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	O nome do grupo de recursos que contém o recurso. Você pode obter esse valor na API do Azure Resource Manager ou no portal.
serverName	path	True	string	O nome do servidor.
subscriptionId	path	True	string	A ID da assinatura que identifica uma assinatura do Azure.
workloadGroupName	path	True	string	O nome do grupo de carga de trabalho.
api-version	query	True	string	A versão da API a ser usada para a solicitaçã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	Atualizou com êxito o grupo de carga de trabalho.
201 Created	WorkloadGroup	Criou com êxito o grupo de carga de trabalho.
202 Accepted		Criar ou atualizar para o grupo de carga de trabalho aceito. Cabeçalhos Location: string
Other Status Codes	ErrorResponse	Respostas de erro: *** 400 ManagedInstanceStoppingOrStopped – Operação conflitante enviada enquanto a instância está no estado de parada/parada 400 ManagedInstanceStarting – Operação conflitante enviada enquanto a instância está no estado inicial 400 FeatureDisabledOnSelectedEdition – O usuário tentou usar um recurso que está desabilitado na edição atual do banco de dados. 400 OperationNotAllowedOnPausedDatabase – A operação não é permitida em um banco de dados pausado. 400 InvalidWorkloadGroupNameParameter - Nome inválido do grupo de carga de trabalho 400 InvalidMinResourcePercentParameter – Percentual de recursos mínimo inválido para esse grupo de carga de trabalho. 400 InvalidMinResourcePercentPerRequestParameter – percentual de recurso mínimo inválido por consulta para esse grupo de carga de trabalho. 400 InvalidMaxResourcePercentParameter – Percentual de recurso máximo inválido para alocar para esse grupo de carga de trabalho. 400 InvalidMaxResourcePercentPerRequestParameter – porcentagem máxima inválida de recursos por consulta para esse grupo de carga de trabalho. 400 InvalidImportanceParameter – A importância deve ser uma das seguintes cadeias de caracteres: Baixa, Below_Normal, Normal, Above_Normal, Alta. 400 InvalidQueryExecutionTimeoutParameter – valor de tempo limite de execução de consulta inválido para esse grupo de carga de trabalho. 400 InvalidResourceRequestBody - As propriedades de recurso ou recurso no corpo da solicitação estão vazias ou inválidas. 404 ServerNotInSubscriptionResourceGroup – O servidor especificado não existe no grupo de recursos e na assinatura especificados. 404 SubscriptionDoesNotHaveServer – O servidor solicitado não foi encontrado 404 DatabaseDoesNotExist – O usuário especificou um nome de banco de dados que não existe nesta instância do servidor. 404 ResourceNotFound – O recurso solicitado não foi encontrado. 404 OperationIdNotFound – A operação com id não existe. 409 ConflictingSystemOperationInProgress – Uma operação de manutenção do sistema está em andamento no banco de dados e outras operações precisam aguardar até que ele seja concluído. 409 ConflictingDatabaseOperation – Já existe alguma operação no banco de dados e a operação atual deve aguardar até que ela seja concluída. 409 CannotCancelOperation – A operação de gerenciamento está em um estado que não pode ser cancelado. 409 OperationCancelled – A operação foi cancelada pelo usuário. 409 OperationInterrupted – A operação no recurso não pôde ser concluída porque foi interrompida por outra operação no mesmo recurso. 429 SubscriptionTooManyCreateUpdateRequests – Solicitações além do máximo de solicitações que podem ser processadas por recursos disponíveis. 429 SubscriptionTooManyRequests – Solicitações além das solicitações máximas que podem ser processadas por recursos disponíveis. 500 OperationTimedOut – A operação atingiu o tempo limite e foi revertida automaticamente. Tente novamente a operação. 503 DatabaseUnavailable – A operação falhou porque o banco de dados não está disponível. 503 TooManyRequests – Solicitações além das solicitações máximas que podem ser processadas por recursos disponíveis. 503 TooManyRequests – Solicitações além das solicitações máximas que podem ser processadas por recursos disponíveis. 504 RequestTimeout – A solicitação de serviço excedeu o tempo limite permitido.

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.

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

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/stable/2023-08-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 SqlDatabaseResource created on azure
// for more information of creating SqlDatabaseResource, please refer to the document of SqlDatabaseResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "Default-SQL-SouthEastAsia";
string serverName = "testsvr";
string databaseName = "testdb";
ResourceIdentifier sqlDatabaseResourceId = SqlDatabaseResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, databaseName);
SqlDatabaseResource sqlDatabase = client.GetSqlDatabaseResource(sqlDatabaseResourceId);

// get the collection of this WorkloadGroupResource
WorkloadGroupCollection collection = sqlDatabase.GetWorkloadGroups();

// invoke the operation
string workloadGroupName = "smallrc";
WorkloadGroupData data = new WorkloadGroupData
{
    MinResourcePercent = 0,
    MaxResourcePercent = 100,
    MinResourcePercentPerRequest = 3,
    MaxResourcePercentPerRequest = 3,
    Importance = "normal",
    QueryExecutionTimeout = 0,
};
ArmOperation<WorkloadGroupResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, workloadGroupName, 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

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

Código de status:: 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"
}

Código de status:: 202

Create a workload group with the required properties specified.

Solicitação de exemplo

HTTP
dotnet

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

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/stable/2023-08-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 SqlDatabaseResource created on azure
// for more information of creating SqlDatabaseResource, please refer to the document of SqlDatabaseResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "Default-SQL-SouthEastAsia";
string serverName = "testsvr";
string databaseName = "testdb";
ResourceIdentifier sqlDatabaseResourceId = SqlDatabaseResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, databaseName);
SqlDatabaseResource sqlDatabase = client.GetSqlDatabaseResource(sqlDatabaseResourceId);

// get the collection of this WorkloadGroupResource
WorkloadGroupCollection collection = sqlDatabase.GetWorkloadGroups();

// invoke the operation
string workloadGroupName = "smallrc";
WorkloadGroupData data = new WorkloadGroupData
{
    MinResourcePercent = 0,
    MaxResourcePercent = 100,
    MinResourcePercentPerRequest = 3,
};
ArmOperation<WorkloadGroupResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, workloadGroupName, 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

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

Código de status:: 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"
}

Código de status:: 202

Definições

Nome	Description
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
WorkloadGroup	Operações de grupo de carga de trabalho para um data warehouse

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.

WorkloadGroup

Objeto

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

Nome	Tipo	Description
id	string	ID do recurso.
name	string	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.
type	string	Tipo de recurso.

Compartilhar via

Workload Groups - Create Or Update

Parâmetros de URI

Corpo da solicitação

Respostas

Exemplos

Create a workload group with all properties specified.

Solicitação de exemplo

Resposta de exemplo

Create a workload group with the required properties specified.

Solicitação de exemplo

Resposta de exemplo

Definições

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

WorkloadGroup