Workload Groups - Create Or Update

서비스:

SQL Database

API 버전:

2025-01-01

워크로드 그룹을 만들거나 업데이트합니다.

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
databaseName	path	True	string	데이터베이스의 이름입니다.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	리소스 그룹의 이름입니다. 이름은 대소문자를 구분하지 않습니다.
serverName	path	True	string	서버의 이름입니다.
subscriptionId	path	True	string (uuid)	대상 구독의 ID입니다. 값은 UUID여야 합니다.
workloadGroupName	path	True	string	워크로드 그룹의 이름입니다.
api-version	query	True	string minLength: 1	이 작업에 사용할 API 버전입니다.

요청 본문

Name	필수	형식	Description
properties.maxResourcePercent	True	integer (int32)	워크로드 그룹 상한 백분율 리소스입니다.
properties.minResourcePercent	True	integer (int32)	워크로드 그룹 최소 백분율 리소스입니다.
properties.minResourcePercentPerRequest	True	number (double)	작업 그룹 요청 최소 허용 비율입니다.
properties.importance		string	워크로드 그룹 중요도 수준입니다.
properties.maxResourcePercentPerRequest		number (double)	워크로드 그룹 요청 최대 허용 비율입니다.
properties.queryExecutionTimeout		integer (int32)	워크로드 그룹 쿼리 실행 시간 제한입니다.

응답

Name	형식	Description
200 OK	WorkloadGroup	리소스 'WorkloadGroup' 업데이트 작업이 성공했습니다
201 Created	WorkloadGroup	리소스 'WorkloadGroup' create 작업 성공 헤더 Location: string Retry-After: integer
202 Accepted		자원 작업이 허용되었습니다. 헤더 Location: string Retry-After: integer
Other Status Codes	ErrorResponse	예기치 않은 오류 응답입니다.

보안

azure_auth

Azure Active Directory OAuth2 Flow.

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name	Description
user_impersonation	사용자 계정 가장

예제

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.

샘플 요청

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

샘플 응답

상태 코드:

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

상태 코드:

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

상태 코드:

202

Create a workload group with the required properties specified.

샘플 요청

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

샘플 응답

상태 코드:

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

상태 코드:

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

상태 코드:

202

정의

Name	Description
createdByType	리소스를 만든 ID의 형식입니다.
ErrorAdditionalInfo	리소스 관리 오류 추가 정보입니다.
ErrorDetail	오류 세부 정보입니다.
ErrorResponse	오류 응답
systemData	리소스의 생성 및 마지막 수정과 관련된 메타데이터입니다.
WorkloadGroup	데이터 웨어하우스에 대한 워크로드 그룹 작업

createdByType

열거형

리소스를 만든 ID의 형식입니다.

값	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

리소스 관리 오류 추가 정보입니다.

Name	형식	Description
info	object	추가 정보입니다.
type	string	추가 정보 유형입니다.

ErrorDetail

Object

오류 세부 정보입니다.

Name	형식	Description
additionalInfo	ErrorAdditionalInfo[]	오류 추가 정보입니다.
code	string	오류 코드입니다.
details	ErrorDetail[]	오류 세부 정보입니다.
message	string	오류 메시지입니다.
target	string	오류 대상입니다.

ErrorResponse

Object

오류 응답

Name	형식	Description
error	ErrorDetail	오류 개체입니다.

systemData

Object

리소스의 생성 및 마지막 수정과 관련된 메타데이터입니다.

Name	형식	Description
createdAt	string (date-time)	리소스 만들기의 타임스탬프(UTC)입니다.
createdBy	string	리소스를 만든 ID입니다.
createdByType	createdByType	리소스를 만든 ID의 형식입니다.
lastModifiedAt	string (date-time)	리소스 마지막 수정의 타임스탬프(UTC)
lastModifiedBy	string	리소스를 마지막으로 수정한 ID입니다.
lastModifiedByType	createdByType	리소스를 마지막으로 수정한 ID의 형식입니다.

WorkloadGroup

Object

데이터 웨어하우스에 대한 워크로드 그룹 작업

Name	형식	Description
id	string (arm-id)	리소스에 대한 정규화된 리소스 ID입니다. 예: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	리소스의 이름
properties.importance	string	워크로드 그룹 중요도 수준입니다.
properties.maxResourcePercent	integer (int32)	워크로드 그룹 상한 백분율 리소스입니다.
properties.maxResourcePercentPerRequest	number (double)	워크로드 그룹 요청 최대 허용 비율입니다.
properties.minResourcePercent	integer (int32)	워크로드 그룹 최소 백분율 리소스입니다.
properties.minResourcePercentPerRequest	number (double)	작업 그룹 요청 최소 허용 비율입니다.
properties.queryExecutionTimeout	integer (int32)	워크로드 그룹 쿼리 실행 시간 제한입니다.
systemData	systemData	Azure Resource Manager 메타데이터에 createdBy 및 modifiedBy 정보가 포함되어 있습니다.
type	string	리소스의 형식입니다. 예를 들어, "Microsoft. 컴퓨트/가상 머신" 또는 "Microsoft." 저장소/저장소 계정"