Share via

Microsoft.DurableTask schedulers/retentionPolicies

Bicep resource definition

The schedulers/retentionPolicies resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DurableTask/schedulers/retentionPolicies resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.DurableTask/schedulers/retentionPolicies@2025-11-01' = {
  parent: resourceSymbolicName
  name: 'default'
  properties: {
    retentionPolicies: [
      {
        orchestrationState: 'string'
        retentionPeriodInDays: int
      }
    ]
  }
}

Property Values

Microsoft.DurableTask/schedulers/retentionPolicies

Name Description Value
name The resource name 'default' (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.		 Symbolic name for resource of type: schedulers
properties The resource-specific properties for this resource. RetentionPolicyProperties

RetentionPolicyDetails

Name Description Value
orchestrationState The orchestration state to which this policy applies. If omitted, the policy applies to all purgeable orchestration states. 'Canceled'
'Completed'
'Failed'
'Terminated'
retentionPeriodInDays The retention period in days after which the orchestration will be purged automatically int (required)

RetentionPolicyProperties

Name Description Value
retentionPolicies The orchestration retention policies RetentionPolicyDetails[]

ARM template resource definition

The schedulers/retentionPolicies resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DurableTask/schedulers/retentionPolicies resource, add the following JSON to your template.

{
  "type": "Microsoft.DurableTask/schedulers/retentionPolicies",
  "apiVersion": "2025-11-01",
  "name": "string",
  "properties": {
    "retentionPolicies": [
      {
        "orchestrationState": "string",
        "retentionPeriodInDays": "int"
      }
    ]
  }
}

Property Values

Microsoft.DurableTask/schedulers/retentionPolicies

Name Description Value
apiVersion The api version '2025-11-01'
name The resource name 'default' (required)
properties The resource-specific properties for this resource. RetentionPolicyProperties
type The resource type 'Microsoft.DurableTask/schedulers/retentionPolicies'

RetentionPolicyDetails

Name Description Value
orchestrationState The orchestration state to which this policy applies. If omitted, the policy applies to all purgeable orchestration states. 'Canceled'
'Completed'
'Failed'
'Terminated'
retentionPeriodInDays The retention period in days after which the orchestration will be purged automatically int (required)

RetentionPolicyProperties

Name Description Value
retentionPolicies The orchestration retention policies RetentionPolicyDetails[]

Usage Examples

Terraform (AzAPI provider) resource definition

The schedulers/retentionPolicies resource type can be deployed with operations that target:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DurableTask/schedulers/retentionPolicies resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DurableTask/schedulers/retentionPolicies@2025-11-01"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      retentionPolicies = [
        {
          orchestrationState = "string"
          retentionPeriodInDays = int
        }
      ]
    }
  }
}

Property Values

Microsoft.DurableTask/schedulers/retentionPolicies

Name Description Value
name The resource name 'default' (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: schedulers
properties The resource-specific properties for this resource. RetentionPolicyProperties
type The resource type "Microsoft.DurableTask/schedulers/retentionPolicies@2025-11-01"

RetentionPolicyDetails

Name Description Value
orchestrationState The orchestration state to which this policy applies. If omitted, the policy applies to all purgeable orchestration states. 'Canceled'
'Completed'
'Failed'
'Terminated'
retentionPeriodInDays The retention period in days after which the orchestration will be purged automatically int (required)

RetentionPolicyProperties

Name Description Value
retentionPolicies The orchestration retention policies RetentionPolicyDetails[]
  • Last updated on