Schedulers - Update

服务:

Durable Task Scheduler

API 版本:

2025-04-01-preview

更新计划程序

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DurableTask/schedulers/{schedulerName}?api-version=2025-04-01-preview

URI 参数

名称	在	必需	类型	说明
resourceGroupName	path	True	string minLength: 1 maxLength: 90	资源组的名称。 此名称不区分大小写。
schedulerName	path	True	string pattern: ^[a-zA-Z0-9-]{3,64}$	计划程序的名称
subscriptionId	path	True	string (uuid)	目标订阅的 ID。 该值必须是 UUID。
api-version	query	True	string minLength: 1	用于此操作的 API 版本。

请求正文

名称	类型	说明
properties	SchedulerPropertiesUpdate	此资源的资源特定属性。
tags	object	资源标记。

响应

名称	类型	说明
200 OK	Scheduler	Azure作已成功完成。
202 Accepted		接受资源更新请求。 标头 Location: string Retry-After: integer
Other Status Codes	ErrorResponse	验证错误：缺少所需的参数

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

Schedulers_Update

示例请求

HTTP

PATCH https://management.azure.com/subscriptions/EE9BD735-67CE-4A90-89C4-439D3F6A4C93/resourceGroups/rgopenapi/providers/Microsoft.DurableTask/schedulers/testscheduler?api-version=2025-04-01-preview

{
  "tags": {
    "hello": "world"
  },
  "properties": {
    "ipAllowlist": [
      "10.0.0.0/8"
    ],
    "sku": {
      "name": "Dedicated",
      "capacity": 3
    }
  }
}

Java

import com.azure.resourcemanager.durabletask.models.Scheduler;
import com.azure.resourcemanager.durabletask.models.SchedulerPropertiesUpdate;
import com.azure.resourcemanager.durabletask.models.SchedulerSkuUpdate;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for Schedulers Update.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-04-01-preview/Schedulers_Update.json
     */
    /**
     * Sample code: Schedulers_Update.
     * 
     * @param manager Entry point to DurableTaskManager.
     */
    public static void schedulersUpdate(com.azure.resourcemanager.durabletask.DurableTaskManager manager) {
        Scheduler resource = manager.schedulers()
            .getByResourceGroupWithResponse("rgopenapi", "testscheduler", com.azure.core.util.Context.NONE).getValue();
        resource.update().withTags(mapOf("hello", "world"))
            .withProperties(new SchedulerPropertiesUpdate().withIpAllowlist(Arrays.asList("10.0.0.0/8"))
                .withSku(new SchedulerSkuUpdate().withName("Dedicated").withCapacity(3)))
            .apply();
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

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.durabletask import DurableTaskMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-durabletask
# USAGE
    python schedulers_update.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 = DurableTaskMgmtClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.schedulers.begin_update(
        resource_group_name="rgopenapi",
        scheduler_name="testscheduler",
        properties={
            "properties": {"ipAllowlist": ["10.0.0.0/8"], "sku": {"capacity": 3, "name": "Dedicated"}},
            "tags": {"hello": "world"},
        },
    ).result()
    print(response)


# x-ms-original-file: 2025-04-01-preview/Schedulers_Update.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

Go

package armdurabletask_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/durabletask/armdurabletask"
)

// Generated from example definition: 2025-04-01-preview/Schedulers_Update.json
func ExampleSchedulersClient_BeginUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdurabletask.NewClientFactory("EE9BD735-67CE-4A90-89C4-439D3F6A4C93", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewSchedulersClient().BeginUpdate(ctx, "rgopenapi", "testscheduler", armdurabletask.SchedulerUpdate{
		Tags: map[string]*string{
			"hello": to.Ptr("world"),
		},
		Properties: &armdurabletask.SchedulerPropertiesUpdate{
			IPAllowlist: []*string{
				to.Ptr("10.0.0.0/8"),
			},
			SKU: &armdurabletask.SchedulerSKUUpdate{
				Name:     to.Ptr("Dedicated"),
				Capacity: to.Ptr[int32](3),
			},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armdurabletask.SchedulersClientUpdateResponse{
	// 	Scheduler: &armdurabletask.Scheduler{
	// 		Location: to.Ptr("northcentralus"),
	// 		Properties: &armdurabletask.SchedulerProperties{
	// 			ProvisioningState: to.Ptr(armdurabletask.ProvisioningStateSucceeded),
	// 			Endpoint: to.Ptr("https://test.northcentralus.1.durabletask.io"),
	// 			IPAllowlist: []*string{
	// 				to.Ptr("10.0.0.0/8"),
	// 			},
	// 			SKU: &armdurabletask.SchedulerSKU{
	// 				Name: to.Ptr("Dedicated"),
	// 				Capacity: to.Ptr[int32](3),
	// 				RedundancyState: to.Ptr(armdurabletask.RedundancyStateZone),
	// 			},
	// 		},
	// 		Tags: map[string]*string{
	// 			"department": to.Ptr("research"),
	// 			"development": to.Ptr("true"),
	// 			"hello": to.Ptr("world"),
	// 		},
	// 		ID: to.Ptr("/subscriptions/EE9BD735-67CE-4A90-89C4-439D3F6A4C93/resourceGroups/rgopenapi/providers/Microsoft.DurableTask/schedulers/testscheduler"),
	// 		Name: to.Ptr("testscheduler"),
	// 		Type: to.Ptr("Microsoft.DurableTask/schedulers"),
	// 		SystemData: &armdurabletask.SystemData{
	// 			CreatedBy: to.Ptr("tenmbevaunjzikxowqexrsx"),
	// 			CreatedByType: to.Ptr(armdurabletask.CreatedByTypeUser),
	// 			CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2024-04-17T15:34:17.365Z"); return t}()),
	// 			LastModifiedBy: to.Ptr("xfvdcegtj"),
	// 			LastModifiedByType: to.Ptr(armdurabletask.CreatedByTypeUser),
	// 			LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2024-04-17T15:34:17.366Z"); return t}()),
	// 		},
	// 	},
	// }
}

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 { DurableTaskClient } = require("@azure/arm-durabletask");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to update a Scheduler
 *
 * @summary update a Scheduler
 * x-ms-original-file: 2025-04-01-preview/Schedulers_Update.json
 */
async function schedulersUpdate() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "EE9BD735-67CE-4A90-89C4-439D3F6A4C93";
  const client = new DurableTaskClient(credential, subscriptionId);
  const result = await client.schedulers.update("rgopenapi", "testscheduler", {
    tags: { hello: "world" },
    properties: {
      ipAllowlist: ["10.0.0.0/8"],
      sku: { name: "Dedicated", capacity: 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.DurableTask.Models;
using Azure.ResourceManager.DurableTask;

// Generated from example definition: 2025-04-01-preview/Schedulers_Update.json
// this example is just showing the usage of "Scheduler_Update" 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 DurableTaskSchedulerResource created on azure
// for more information of creating DurableTaskSchedulerResource, please refer to the document of DurableTaskSchedulerResource
string subscriptionId = "EE9BD735-67CE-4A90-89C4-439D3F6A4C93";
string resourceGroupName = "rgopenapi";
string schedulerName = "testscheduler";
ResourceIdentifier durableTaskSchedulerResourceId = DurableTaskSchedulerResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, schedulerName);
DurableTaskSchedulerResource durableTaskScheduler = client.GetDurableTaskSchedulerResource(durableTaskSchedulerResourceId);

// invoke the operation
DurableTaskSchedulerPatch patch = new DurableTaskSchedulerPatch
{
    Properties = new DurableTaskSchedulerPatchProperties
    {
        IPAllowlist = { "10.0.0.0/8" },
        Sku = new DurableTaskSchedulerSkuUpdate
        {
            Name = "Dedicated",
            Capacity = 3,
        },
    },
    Tags =
    {
    ["hello"] = "world"
    },
};
ArmOperation<DurableTaskSchedulerResource> lro = await durableTaskScheduler.UpdateAsync(WaitUntil.Completed, patch);
DurableTaskSchedulerResource 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
DurableTaskSchedulerData 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

{
  "location": "northcentralus",
  "properties": {
    "provisioningState": "Succeeded",
    "endpoint": "https://test.northcentralus.1.durabletask.io",
    "ipAllowlist": [
      "10.0.0.0/8"
    ],
    "sku": {
      "name": "Dedicated",
      "capacity": 3,
      "redundancyState": "Zone"
    }
  },
  "tags": {
    "department": "research",
    "development": "true",
    "hello": "world"
  },
  "id": "/subscriptions/EE9BD735-67CE-4A90-89C4-439D3F6A4C93/resourceGroups/rgopenapi/providers/Microsoft.DurableTask/schedulers/testscheduler",
  "name": "testscheduler",
  "type": "Microsoft.DurableTask/schedulers",
  "systemData": {
    "createdBy": "tenmbevaunjzikxowqexrsx",
    "createdByType": "User",
    "createdAt": "2024-04-17T15:34:17.365Z",
    "lastModifiedBy": "xfvdcegtj",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-04-17T15:34:17.366Z"
  }
}

状态代码:

202

location: https://contoso.com/operationstatus

定义

名称	说明
createdByType	创建资源的标识的类型。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
ProvisioningState	当前作的状态
RedundancyState	资源冗余的状态
Scheduler	持久任务计划程序资源
SchedulerProperties	计划程序的详细信息
SchedulerPropertiesUpdate	要更新的计划程序资源属性
SchedulerSku	分配给此持久任务计划器的 SKU（库存单位）
SchedulerSkuUpdate	要更新的 SKU（库存单位）属性
SchedulerUpdate	计划程序资源的更新请求模型
systemData	与创建和上次修改资源相关的元数据。

createdByType

枚举

创建资源的标识的类型。

值	说明
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Object

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetail

Object

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

Object

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。

ProvisioningState

枚举

当前作的状态

值	说明
Accepted	已接受资源创建请求
Canceled	资源创建已取消。
Deleting	正在删除资源
Failed	资源创建失败。
Provisioning	正在预配资源
Succeeded	已创建资源。
Updating	资源正在更新

RedundancyState

枚举

资源冗余的状态

值	说明
None	资源不冗余
Zone	资源是区域冗余的

Scheduler

Object

持久任务计划程序资源

名称	类型	说明
id	string (arm-id)	资源的完全限定资源 ID。 例如“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”
location	string	资源所在的地理位置
name	string	资源的名称
properties	SchedulerProperties	此资源的资源特定属性。
systemData	systemData	包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。
tags	object	资源标记。
type	string	资源的类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

SchedulerProperties

Object

计划程序的详细信息

名称	类型	说明
endpoint	string	持久任务计划程序 URL
ipAllowlist	string[]	持久任务计划程序 IP 允许列表。 值可以是 IPv4、IPv6 或 CIDR
provisioningState	ProvisioningState	上次作的状态
sku	SchedulerSku	持久任务计划程序 SKU

SchedulerPropertiesUpdate

Object

要更新的计划程序资源属性

名称	类型	说明
endpoint	string	持久任务计划程序 URL
ipAllowlist	string[]	持久任务计划程序 IP 允许列表。 值可以是 IPv4、IPv6 或 CIDR
provisioningState	ProvisioningState	上次作的状态
sku	SchedulerSkuUpdate	持久任务计划程序 SKU

SchedulerSku

Object

分配给此持久任务计划器的 SKU（库存单位）

名称	类型	说明
capacity	integer (int32)	SKU 容量。 这允许横向扩展/缩小资源并影响区域冗余
name	string	SKU 的名称
redundancyState	RedundancyState	指示当前 SKU 配置是否为区域冗余

SchedulerSkuUpdate

Object

要更新的 SKU（库存单位）属性

名称	类型	说明
capacity	integer (int32)	SKU 容量。 这允许横向扩展/缩小资源并影响区域冗余
name	string	SKU 的名称
redundancyState	RedundancyState	指示当前 SKU 配置是否为区域冗余

SchedulerUpdate

Object

计划程序资源的更新请求模型

名称	类型	说明
properties	SchedulerPropertiesUpdate	此资源的资源特定属性。
tags	object	资源标记。

systemData

Object

与创建和上次修改资源相关的元数据。

名称	类型	说明
createdAt	string (date-time)	资源创建时间戳（UTC）。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识的类型。
lastModifiedAt	string (date-time)	上次修改的资源时间戳（UTC）
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	createdByType	上次修改资源的标识的类型。