Workload Groups - Create Or Update

Dienst:: SQL Database

API-Version:: 2023-08-01

Erstellt oder aktualisiert eine Workloadgruppe.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
databaseName	path	True	string	Der Name der Datenbank.
resourceGroupName	path	True	string	Der Name der Ressourcengruppe, die die Ressource enthält. Sie können diesen Wert aus der Azure Resource Manager-API oder dem Portal abrufen.
serverName	path	True	string	Der Name des Servers.
subscriptionId	path	True	string	Die Abonnement-ID, die ein Azure-Abonnement identifiziert.
workloadGroupName	path	True	string	Der Name der Workloadgruppe.
api-version	query	True	string	Die API-Version, die für die Anforderung verwendet werden soll.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
properties.maxResourcePercent	True	integer (int32)	Die Ressourcen für die Workload-Gruppenobergrenze.
properties.minResourcePercent	True	integer (int32)	Die Ressourcen für die Workloadgruppe mit minimalem Prozentsatz.
properties.minResourcePercentPerRequest	True	number (double)	Der Prozentsatz der Arbeitsauslastungsgruppenanforderung für den Mindestzuteilungsprozentsatz.
properties.importance		string	Die Wichtigkeitsstufe der Arbeitsauslastungsgruppe.
properties.maxResourcePercentPerRequest		number (double)	Die Workloadgruppe fordert den maximalen Grant-Prozentsatz an.
properties.queryExecutionTimeout		integer (int32)	Timeout für die Ausführung der Workload-Gruppenabfrage.

Antworten

Name	Typ	Beschreibung
200 OK	WorkloadGroup	Die Workloadgruppe wurde erfolgreich aktualisiert.
201 Created	WorkloadGroup	Die Workloadgruppe wurde erfolgreich erstellt.
202 Accepted		Erstellen oder Aktualisieren für die akzeptierte Workloadgruppe. Header Location: string
Other Status Codes	ErrorResponse	Fehlerantworten: *** 400 ManagedInstanceStoppingOrStopped – Konfliktierender Vorgang, der während der Instanz beendet/beendet wird 400 ManagedInstanceStarting – Konfliktierender Vorgang, der während der Instanz im Startzustand liegt 400 FeatureDisabledOnSelectedEdition – Der Benutzer hat versucht, ein Feature zu verwenden, das in der aktuellen Datenbankedition deaktiviert ist. 400 OperationNotAllowedOnPausedDatabase – Vorgang ist für eine angehaltene Datenbank nicht zulässig. 400 InvalidWorkloadGroupNameParameter – Ungültiger Workloadgruppenname 400 InvalidMinResourcePercentParameter – Ungültige Min.-Ressource prozent für diese Workloadgruppe. 400 InvalidMinResourcePercentPerRequestParameter – Ungültige Min.-Ressource pro Abfrage für diese Workloadgruppe. 400 InvalidMaxResourcePercentParameter – Ungültige maximale Ressourcenprozent, die für diese Workloadgruppe zugewiesen werden soll. 400 InvalidMaxResourcePerCentPerRequestParameter – Ungültige maximale Ressourcenprozent pro Abfrage für diese Workloadgruppe. 400 InvalidImportanceParameter – Wichtigkeit muss eine der folgenden Zeichenfolgen sein: Niedrig, Below_Normal, Normal, Above_Normal, Hoch. 400 InvalidQueryExecutionTimeoutParameter – Ungültiger Zeitüberschreitungswert für die Abfrageausführung für diese Workloadgruppe. 400 InvalidResourceRequestBody – Die Ressourcen- oder Ressourceneigenschaften im Anforderungstext sind leer oder ungültig. 404 ServerNotInSubscriptionResourceGroup – Der angegebene Server ist in der angegebenen Ressourcengruppe und dem angegebenen Abonnement nicht vorhanden. 404 SubscriptionDoesNotHaveServer – Der angeforderte Server wurde nicht gefunden. 404 DatabaseDoesNotExist – Der Benutzer hat einen Datenbanknamen angegeben, der in dieser Serverinstanz nicht vorhanden ist. 404 ResourceNotFound – Die angeforderte Ressource wurde nicht gefunden. 404 OperationIdNotFound – Der Vorgang mit der ID ist nicht vorhanden. 409 ConflictingSystemOperationInProgress – Ein Systemwartungsvorgang wird für die Datenbank ausgeführt, und weitere Vorgänge müssen warten, bis sie abgeschlossen ist. 409 ConflictingDatabaseOperation – Es gibt bereits einige Vorgänge in der Datenbank, und der aktuelle Vorgang sollte warten, bis er abgeschlossen ist. 409 CannotCancelOperation – Der Verwaltungsvorgang befindet sich in einem Zustand, der nicht abgebrochen werden kann. 409 OperationCancelled – Der Vorgang wurde vom Benutzer abgebrochen. 409 OperationInterrupted – Der Vorgang für die Ressource konnte nicht abgeschlossen werden, weil er durch einen anderen Vorgang in derselben Ressource unterbrochen wurde. 429 SubscriptionTooManyCreateUpdateRequests – Anforderungen über max. Anforderungen hinaus, die von verfügbaren Ressourcen verarbeitet werden können. 429 SubscriptionTooManyRequests – Anforderungen über max. Anforderungen hinaus, die von verfügbaren Ressourcen verarbeitet werden können. 500 OperationTimedOut – Timeout des Vorgangs und automatisches Zurücksetzen. Versuchen Sie den Vorgang erneut. 503 DatabaseUnavailable – Fehler beim Vorgang, weil die Datenbank nicht verfügbar ist. 503 TooManyRequests – Anforderungen über max. Anforderungen hinaus, die von verfügbaren Ressourcen verarbeitet werden können. 503 TooManyRequests – Anforderungen über max. Anforderungen hinaus, die von verfügbaren Ressourcen verarbeitet werden können. 504 RequestTimeout – Serviceanforderung hat das zulässige Timeout überschritten.

Beispiele

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

Beispiel für eine Antwort

Statuscode:: 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"
}

Statuscode:: 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"
}

Statuscode:: 202

Create a workload group with the required properties specified.

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:: 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"
}

Statuscode:: 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"
}

Statuscode:: 202

Definitionen

Name	Beschreibung
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
WorkloadGroup	Workloadgruppenvorgänge für ein Data Warehouse

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

WorkloadGroup

Objekt

Workloadgruppenvorgänge für ein Data Warehouse

Name	Typ	Beschreibung
id	string	Ressourcen-ID.
name	string	Ressourcenname.
properties.importance	string	Die Wichtigkeitsstufe der Arbeitsauslastungsgruppe.
properties.maxResourcePercent	integer (int32)	Die Ressourcen für die Workload-Gruppenobergrenze.
properties.maxResourcePercentPerRequest	number (double)	Die Workloadgruppe fordert den maximalen Grant-Prozentsatz an.
properties.minResourcePercent	integer (int32)	Die Ressourcen für die Workloadgruppe mit minimalem Prozentsatz.
properties.minResourcePercentPerRequest	number (double)	Der Prozentsatz der Arbeitsauslastungsgruppenanforderung für den Mindestzuteilungsprozentsatz.
properties.queryExecutionTimeout	integer (int32)	Timeout für die Ausführung der Workload-Gruppenabfrage.
type	string	Ressourcentyp.

Freigeben über

Workload Groups - Create Or Update

URI-Parameter

Anforderungstext

Antworten

Beispiele

Create a workload group with all properties specified.

Beispielanforderung

Beispiel für eine Antwort

Create a workload group with the required properties specified.

Beispielanforderung

Beispiel für eine Antwort

Definitionen

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

WorkloadGroup