Retention Policies - Create Or Replace

Service:

Durable Task Scheduler

API Version:

2025-04-01-preview

Create or Update a Retention Policy

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

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
schedulerName	path	True	string pattern: ^[a-zA-Z0-9-]{3,64}$	The name of the Scheduler
subscriptionId	path	True	string (uuid)	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Request Body

Name	Type	Description
properties	RetentionPolicyProperties	The resource-specific properties for this resource.

Responses

Name	Type	Description
200 OK	RetentionPolicy	Resource 'RetentionPolicy' update operation succeeded
201 Created	RetentionPolicy	Resource 'RetentionPolicy' create operation succeeded Headers Azure-AsyncOperation: string Retry-After: integer
Other Status Codes	ErrorResponse	Validation error: required parameters are missing

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

RetentionPolicies_CreateOrReplace_MaximumSet

Sample request

HTTP

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

{
  "properties": {
    "retentionPolicies": [
      {
        "retentionPeriodInDays": 30
      },
      {
        "retentionPeriodInDays": 10,
        "orchestrationState": "Failed"
      }
    ]
  }
}

Java

import com.azure.resourcemanager.durabletask.fluent.models.RetentionPolicyInner;
import com.azure.resourcemanager.durabletask.models.PurgeableOrchestrationState;
import com.azure.resourcemanager.durabletask.models.RetentionPolicyDetails;
import com.azure.resourcemanager.durabletask.models.RetentionPolicyProperties;
import java.util.Arrays;

/**
 * Samples for RetentionPolicies CreateOrReplace.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-04-01-preview/RetentionPolicies_CreateOrReplace_MaximumSet_Gen.json
     */
    /**
     * Sample code: RetentionPolicies_CreateOrReplace_MaximumSet.
     * 
     * @param manager Entry point to DurableTaskManager.
     */
    public static void
        retentionPoliciesCreateOrReplaceMaximumSet(com.azure.resourcemanager.durabletask.DurableTaskManager manager) {
        manager.retentionPolicies().createOrReplace("rgdurabletask", "testscheduler",
            new RetentionPolicyInner().withProperties(new RetentionPolicyProperties()
                .withRetentionPolicies(Arrays.asList(new RetentionPolicyDetails().withRetentionPeriodInDays(30),
                    new RetentionPolicyDetails().withRetentionPeriodInDays(10)
                        .withOrchestrationState(PurgeableOrchestrationState.FAILED)))),
            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_create_or_replace_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.begin_create_or_replace(
        resource_group_name="rgdurabletask",
        scheduler_name="testscheduler",
        resource={
            "properties": {
                "retentionPolicies": [
                    {"retentionPeriodInDays": 30},
                    {"orchestrationState": "Failed", "retentionPeriodInDays": 10},
                ]
            }
        },
    ).result()
    print(response)


# x-ms-original-file: 2025-04-01-preview/RetentionPolicies_CreateOrReplace_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/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/RetentionPolicies_CreateOrReplace_MaximumSet_Gen.json
func ExampleRetentionPoliciesClient_BeginCreateOrReplace() {
	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)
	}
	poller, err := clientFactory.NewRetentionPoliciesClient().BeginCreateOrReplace(ctx, "rgdurabletask", "testscheduler", armdurabletask.RetentionPolicy{
		Properties: &armdurabletask.RetentionPolicyProperties{
			RetentionPolicies: []*armdurabletask.RetentionPolicyDetails{
				{
					RetentionPeriodInDays: to.Ptr[int32](30),
				},
				{
					RetentionPeriodInDays: to.Ptr[int32](10),
					OrchestrationState:    to.Ptr(armdurabletask.PurgeableOrchestrationStateFailed),
				},
			},
		},
	}, 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.RetentionPoliciesClientCreateOrReplaceResponse{
	// 	RetentionPolicy: &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}()),
	// 		},
	// 	},
	// }
}

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 create or Update a Retention Policy
 *
 * @summary create or Update a Retention Policy
 * x-ms-original-file: 2025-04-01-preview/RetentionPolicies_CreateOrReplace_MaximumSet_Gen.json
 */
async function retentionPoliciesCreateOrReplaceMaximumSet() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "194D3C1E-462F-4738-9025-092A628C06EB";
  const client = new DurableTaskClient(credential, subscriptionId);
  const result = await client.retentionPolicies.createOrReplace("rgdurabletask", "testscheduler", {
    properties: {
      retentionPolicies: [
        { retentionPeriodInDays: 30 },
        { retentionPeriodInDays: 10, orchestrationState: "Failed" },
      ],
    },
  });
  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/RetentionPolicies_CreateOrReplace_MaximumSet_Gen.json
// this example is just showing the usage of "RetentionPolicy_CreateOrReplace" 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 DurableTaskRetentionPolicyResource created on azure
// for more information of creating DurableTaskRetentionPolicyResource, please refer to the document of DurableTaskRetentionPolicyResource
string subscriptionId = "194D3C1E-462F-4738-9025-092A628C06EB";
string resourceGroupName = "rgdurabletask";
string schedulerName = "testscheduler";
ResourceIdentifier durableTaskRetentionPolicyResourceId = DurableTaskRetentionPolicyResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, schedulerName);
DurableTaskRetentionPolicyResource durableTaskRetentionPolicy = client.GetDurableTaskRetentionPolicyResource(durableTaskRetentionPolicyResourceId);

// invoke the operation
DurableTaskRetentionPolicyData data = new DurableTaskRetentionPolicyData
{
    Properties = new DurableTaskRetentionPolicyProperties
    {
        RetentionPolicies = {new DurableTaskRetentionPolicyDetails(30), new DurableTaskRetentionPolicyDetails(10)
        {
        OrchestrationState = DurableTaskPurgeableOrchestrationState.Failed,
        }},
    },
};
ArmOperation<DurableTaskRetentionPolicyResource> lro = await durableTaskRetentionPolicy.CreateOrUpdateAsync(WaitUntil.Completed, data);
DurableTaskRetentionPolicyResource 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
DurableTaskRetentionPolicyData 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

Sample response

Status code:

200

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

Status code:

201

Azure-AsyncOperation: https://contoso.com/operationstatus

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

Definitions

Name	Description
createdByType	The type of identity that created the resource.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
ProvisioningState	The status of the current operation
PurgeableOrchestrationState	Purgeable orchestration state to be used in retention policies
RetentionPolicy	A retention policy resource belonging to the scheduler
RetentionPolicyDetails	The properties of a retention policy
RetentionPolicyProperties	The retention policy settings for the resource
systemData	Metadata pertaining to creation and last modification of the resource.

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

ProvisioningState

Enumeration

The status of the current operation

Value	Description
Succeeded	Resource has been created.
Failed	Resource creation failed.
Canceled	Resource creation was canceled.
Provisioning	The resource is being provisioned
Updating	The resource is updating
Deleting	The resource is being deleted
Accepted	The resource create request has been accepted

PurgeableOrchestrationState

Enumeration

Purgeable orchestration state to be used in retention policies

Value	Description
Completed	The orchestration is completed
Failed	The orchestration is failed
Terminated	The orchestration is terminated
Canceled	The orchestration is canceled

RetentionPolicy

Object

A retention policy resource belonging to the scheduler

Name	Type	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties	RetentionPolicyProperties	The resource-specific properties for this resource.
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

RetentionPolicyDetails

Object

The properties of a retention policy

Name	Type	Description
orchestrationState	PurgeableOrchestrationState	The orchestration state to which this policy applies. If omitted, the policy applies to all purgeable orchestration states.
retentionPeriodInDays	integer (int32)	The retention period in days after which the orchestration will be purged automatically

RetentionPolicyProperties

Object

The retention policy settings for the resource

Name	Type	Description
provisioningState	ProvisioningState	The status of the last operation
retentionPolicies	RetentionPolicyDetails[]	The orchestration retention policies

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string (date-time)	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.