Retention Policies - List By Scheduler

服务:

Durable Task Scheduler

API 版本:

2025-04-01-preview

列出保留策略

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DurableTask/schedulers/{schedulerName}/retentionPolicies?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 版本。

响应

名称	类型	说明
200 OK	RetentionPolicyListResult	Azure 操作已成功完成。
Other Status Codes	ErrorResponse	意外的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

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

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

RetentionPolicies_ListByScheduler_MaximumSet

示例请求

HTTP

GET https://management.azure.com/subscriptions/194D3C1E-462F-4738-9025-092A628C06EB/resourceGroups/rgdurabletask/providers/Microsoft.DurableTask/schedulers/myscheduler/retentionPolicies?api-version=2025-04-01-preview

Java

/**
 * Samples for RetentionPolicies ListByScheduler.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-04-01-preview/RetentionPolicies_ListByScheduler_MaximumSet_Gen.json
     */
    /**
     * Sample code: RetentionPolicies_ListByScheduler_MaximumSet.
     * 
     * @param manager Entry point to DurableTaskManager.
     */
    public static void
        retentionPoliciesListBySchedulerMaximumSet(com.azure.resourcemanager.durabletask.DurableTaskManager manager) {
        manager.retentionPolicies().listByScheduler("rgdurabletask", "myscheduler", 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.durabletask import DurableTaskMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-durabletask
# USAGE
    python retention_policies_list_by_scheduler_maximum_set_gen.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.retention_policies.list_by_scheduler(
        resource_group_name="rgdurabletask",
        scheduler_name="myscheduler",
    )
    for item in response:
        print(item)


# x-ms-original-file: 2025-04-01-preview/RetentionPolicies_ListByScheduler_MaximumSet_Gen.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/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/durabletask/armdurabletask"
)

// Generated from example definition: 2025-04-01-preview/RetentionPolicies_ListByScheduler_MaximumSet_Gen.json
func ExampleRetentionPoliciesClient_NewListBySchedulerPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdurabletask.NewClientFactory("194D3C1E-462F-4738-9025-092A628C06EB", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewRetentionPoliciesClient().NewListBySchedulerPager("rgdurabletask", "myscheduler", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page = armdurabletask.RetentionPoliciesClientListBySchedulerResponse{
		// 	RetentionPolicyListResult: armdurabletask.RetentionPolicyListResult{
		// 		Value: []*armdurabletask.RetentionPolicy{
		// 			{
		// 				Properties: &armdurabletask.RetentionPolicyProperties{
		// 					ProvisioningState: to.Ptr(armdurabletask.ProvisioningStateSucceeded),
		// 					RetentionPolicies: []*armdurabletask.RetentionPolicyDetails{
		// 						{
		// 							RetentionPeriodInDays: to.Ptr[int32](30),
		// 						},
		// 						{
		// 							RetentionPeriodInDays: to.Ptr[int32](10),
		// 							OrchestrationState: to.Ptr(armdurabletask.PurgeableOrchestrationStateFailed),
		// 						},
		// 					},
		// 				},
		// 				ID: to.Ptr("/subscriptions/194D3C1E-462F-4738-9025-092A628C06EB/resourceGroups/rgdurabletask/providers/Microsoft.DurableTask/schedulers/testscheduler/retentionPolicies/default"),
		// 				Name: to.Ptr("default"),
		// 				Type: to.Ptr("Microsoft.DurableTask/schedulers/retentionPolicies"),
		// 				SystemData: &armdurabletask.SystemData{
		// 					CreatedBy: to.Ptr("zshkmc"),
		// 					CreatedByType: to.Ptr(armdurabletask.CreatedByTypeUser),
		// 					CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2025-03-31T23:34:09.612Z"); return t}()),
		// 					LastModifiedBy: to.Ptr("ivqrae"),
		// 					LastModifiedByType: to.Ptr(armdurabletask.CreatedByTypeUser),
		// 					LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2025-03-31T23:34:09.612Z"); return t}()),
		// 				},
		// 			},
		// 		},
		// 		NextLink: to.Ptr("https://microsoft.com/ai"),
		// 	},
		// }
	}
}

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 list Retention Policies
 *
 * @summary list Retention Policies
 * x-ms-original-file: 2025-04-01-preview/RetentionPolicies_ListByScheduler_MaximumSet_Gen.json
 */
async function retentionPoliciesListBySchedulerMaximumSet() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "194D3C1E-462F-4738-9025-092A628C06EB";
  const client = new DurableTaskClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.retentionPolicies.listByScheduler(
    "rgdurabletask",
    "myscheduler",
  )) {
    resArray.push(item);
  }

  console.log(resArray);
}

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

示例响应

状态代码:

200

{
  "value": [
    {
      "properties": {
        "provisioningState": "Succeeded",
        "retentionPolicies": [
          {
            "retentionPeriodInDays": 30
          },
          {
            "retentionPeriodInDays": 10,
            "orchestrationState": "Failed"
          }
        ]
      },
      "id": "/subscriptions/194D3C1E-462F-4738-9025-092A628C06EB/resourceGroups/rgdurabletask/providers/Microsoft.DurableTask/schedulers/testscheduler/retentionPolicies/default",
      "name": "default",
      "type": "Microsoft.DurableTask/schedulers/retentionPolicies",
      "systemData": {
        "createdBy": "zshkmc",
        "createdByType": "User",
        "createdAt": "2025-03-31T23:34:09.612Z",
        "lastModifiedBy": "ivqrae",
        "lastModifiedByType": "User",
        "lastModifiedAt": "2025-03-31T23:34:09.612Z"
      }
    }
  ],
  "nextLink": "https://microsoft.com/ai"
}

定义

名称	说明
createdByType	创建资源的标识的类型。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
ProvisioningState	当前作的状态
PurgeableOrchestrationState	在保留策略中使用的可清除业务流程状态
RetentionPolicy	属于计划程序的保留策略资源
RetentionPolicyDetails	保留策略的属性
RetentionPolicyListResult	RetentionPolicy 列表作的响应。
RetentionPolicyProperties	资源的保留策略设置
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	资源正在更新

PurgeableOrchestrationState

枚举

在保留策略中使用的可清除业务流程状态

值	说明
Canceled	业务流程已取消
Completed	业务流程已完成
Failed	业务流程失败
Terminated	业务流程已终止

RetentionPolicy

Object

属于计划程序的保留策略资源

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

RetentionPolicyDetails

Object

保留策略的属性

名称	类型	说明
orchestrationState	PurgeableOrchestrationState	此策略应用到的业务流程状态。 如果省略，则策略适用于所有可清除的业务流程状态。
retentionPeriodInDays	integer (int32)	业务流程自动清除的保留期（以天为单位）

RetentionPolicyListResult

Object

RetentionPolicy 列表作的响应。

名称	类型	说明
nextLink	string (uri)	指向下一页项的链接
value	RetentionPolicy[]	此页上的 RetentionPolicy 项

RetentionPolicyProperties

Object

资源的保留策略设置

名称	类型	说明
provisioningState	ProvisioningState	上次作的状态
retentionPolicies	RetentionPolicyDetails[]	业务流程保留策略

systemData

Object

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

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