Microsoft.DurableTask (preview:2025-04-01)

2025/04/15 • 4 updated methods

RetentionPolicies_ListByScheduler (updated)
Description :  List Retention Policies
Reference :  Link ¶

⚶ Changes

{
  "#id": "RetentionPolicies_ListByScheduler",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "retentionPolicies": {
                  "$properties": [
                    {
                      "#name": "orchestrationState",
                      "Enum": {
                        "new": [
                          [
                            "Completed",
                            "The orchestration is completed"
                          ],
                          [
                            "Failed",
                            "The orchestration is failed"
                          ],
                          [
                            "Terminated",
                            "The orchestration is terminated"
                          ],
                          [
                            "Canceled",
                            "The orchestration is canceled"
                          ]
                        ],
                        "old": [
                          [
                            "Completed",
                            "The orchestration is completed"
                          ],
                          [
                            "Failed",
                            "The orchestration is failed"
                          ],
                          [
                            "Terminated",
                            "The orchestration is terminated"
                          ],
                          [
                            "Canceled",
                            "The orchestration is terminated"
                          ]
                        ]
                      }
                    }
                  ]
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DurableTask/schedulers/{schedulerName}/retentionPolicies
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
schedulerName:
{
Description: The name of the Scheduler ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The RetentionPolicy items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation ,
Enum:
{
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 ,
}
,
Required: False ,
}
enum ,
retentionPolicies:
{
Description: The orchestration retention policies ,
Required: False ,
}
[
{
retentionPeriodInDays:
{
Description: The retention period in days after which the orchestration will be purged automatically ,
Format: int32 ,
Required: True ,
}
integer ,
orchestrationState:
{
Description: The orchestration state to which this policy applies. If omitted, the policy applies to all purgeable orchestration states. ,
Enum:
{
Completed: The orchestration is completed ,
Failed: The orchestration is failed ,
Terminated: The orchestration is terminated ,
Canceled: The orchestration is canceled ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
RetentionPolicies_Get (updated)
Description :  Get a Retention Policy
Reference :  Link ¶

⚶ Changes

{
  "#id": "RetentionPolicies_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "retentionPolicies": {
              "$properties": [
                {
                  "#name": "orchestrationState",
                  "Enum": {
                    "new": [
                      [
                        "Completed",
                        "The orchestration is completed"
                      ],
                      [
                        "Failed",
                        "The orchestration is failed"
                      ],
                      [
                        "Terminated",
                        "The orchestration is terminated"
                      ],
                      [
                        "Canceled",
                        "The orchestration is canceled"
                      ]
                    ],
                    "old": [
                      [
                        "Completed",
                        "The orchestration is completed"
                      ],
                      [
                        "Failed",
                        "The orchestration is failed"
                      ],
                      [
                        "Terminated",
                        "The orchestration is terminated"
                      ],
                      [
                        "Canceled",
                        "The orchestration is terminated"
                      ]
                    ]
                  }
                }
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DurableTask/schedulers/{schedulerName}/retentionPolicies/default
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
schedulerName:
{
Description: The name of the Scheduler ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation ,
Enum:
{
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 ,
}
,
Required: False ,
}
enum ,
retentionPolicies:
{
Description: The orchestration retention policies ,
Required: False ,
}
[
{
retentionPeriodInDays:
{
Description: The retention period in days after which the orchestration will be purged automatically ,
Format: int32 ,
Required: True ,
}
integer ,
orchestrationState:
{
Description: The orchestration state to which this policy applies. If omitted, the policy applies to all purgeable orchestration states. ,
Enum:
{
Completed: The orchestration is completed ,
Failed: The orchestration is failed ,
Terminated: The orchestration is terminated ,
Canceled: The orchestration is canceled ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
RetentionPolicies_CreateOrReplace (updated)
Description :  Create or Update a Retention Policy
Reference :  Link ¶

⚶ Changes

{
  "#id": "RetentionPolicies_CreateOrReplace",
  "$parameters": {
    "resource": {
      "$properties": {
        "properties": [
          {
            "retentionPolicies": {
              "$properties": [
                {
                  "#name": "orchestrationState",
                  "Enum": {
                    "new": [
                      [
                        "Completed",
                        "The orchestration is completed"
                      ],
                      [
                        "Failed",
                        "The orchestration is failed"
                      ],
                      [
                        "Terminated",
                        "The orchestration is terminated"
                      ],
                      [
                        "Canceled",
                        "The orchestration is canceled"
                      ]
                    ],
                    "old": [
                      [
                        "Completed",
                        "The orchestration is completed"
                      ],
                      [
                        "Failed",
                        "The orchestration is failed"
                      ],
                      [
                        "Terminated",
                        "The orchestration is terminated"
                      ],
                      [
                        "Canceled",
                        "The orchestration is terminated"
                      ]
                    ]
                  }
                }
              ]
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "retentionPolicies": {
              "$properties": [
                {
                  "#name": "orchestrationState",
                  "Enum": {
                    "new": [
                      [
                        "Completed",
                        "The orchestration is completed"
                      ],
                      [
                        "Failed",
                        "The orchestration is failed"
                      ],
                      [
                        "Terminated",
                        "The orchestration is terminated"
                      ],
                      [
                        "Canceled",
                        "The orchestration is canceled"
                      ]
                    ],
                    "old": [
                      [
                        "Completed",
                        "The orchestration is completed"
                      ],
                      [
                        "Failed",
                        "The orchestration is failed"
                      ],
                      [
                        "Terminated",
                        "The orchestration is terminated"
                      ],
                      [
                        "Canceled",
                        "The orchestration is terminated"
                      ]
                    ]
                  }
                }
              ]
            }
          }
        ]
      }
    },
    "201": {
      "$properties": {
        "properties": [
          {
            "retentionPolicies": {
              "$properties": [
                {
                  "#name": "orchestrationState",
                  "Enum": {
                    "new": [
                      [
                        "Completed",
                        "The orchestration is completed"
                      ],
                      [
                        "Failed",
                        "The orchestration is failed"
                      ],
                      [
                        "Terminated",
                        "The orchestration is terminated"
                      ],
                      [
                        "Canceled",
                        "The orchestration is canceled"
                      ]
                    ],
                    "old": [
                      [
                        "Completed",
                        "The orchestration is completed"
                      ],
                      [
                        "Failed",
                        "The orchestration is failed"
                      ],
                      [
                        "Terminated",
                        "The orchestration is terminated"
                      ],
                      [
                        "Canceled",
                        "The orchestration is terminated"
                      ]
                    ]
                  }
                }
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DurableTask/schedulers/{schedulerName}/retentionPolicies/default
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
schedulerName:
{
Description: The name of the Scheduler ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation ,
Enum:
{
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 ,
}
,
Required: False ,
}
enum ,
retentionPolicies:
{
Description: The orchestration retention policies ,
Required: False ,
}
[
{
retentionPeriodInDays:
{
Description: The retention period in days after which the orchestration will be purged automatically ,
Format: int32 ,
Required: True ,
}
integer ,
orchestrationState:
{
Description: The orchestration state to which this policy applies. If omitted, the policy applies to all purgeable orchestration states. ,
Enum:
{
Completed: The orchestration is completed ,
Failed: The orchestration is failed ,
Terminated: The orchestration is terminated ,
Canceled: The orchestration is canceled ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation ,
Enum:
{
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 ,
}
,
Required: False ,
}
enum ,
retentionPolicies:
{
Description: The orchestration retention policies ,
Required: False ,
}
[
{
retentionPeriodInDays:
{
Description: The retention period in days after which the orchestration will be purged automatically ,
Format: int32 ,
Required: True ,
}
integer ,
orchestrationState:
{
Description: The orchestration state to which this policy applies. If omitted, the policy applies to all purgeable orchestration states. ,
Enum:
{
Completed: The orchestration is completed ,
Failed: The orchestration is failed ,
Terminated: The orchestration is terminated ,
Canceled: The orchestration is canceled ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: A retention policy resource belonging to the scheduler ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation ,
Enum:
{
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 ,
}
,
Required: False ,
}
enum ,
retentionPolicies:
{
Description: The orchestration retention policies ,
Required: False ,
}
[
{
retentionPeriodInDays:
{
Description: The retention period in days after which the orchestration will be purged automatically ,
Format: int32 ,
Required: True ,
}
integer ,
orchestrationState:
{
Description: The orchestration state to which this policy applies. If omitted, the policy applies to all purgeable orchestration states. ,
Enum:
{
Completed: The orchestration is completed ,
Failed: The orchestration is failed ,
Terminated: The orchestration is terminated ,
Canceled: The orchestration is canceled ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
RetentionPolicies_Update (updated)
Description :  Update a Retention Policy
Reference :  Link ¶

⚶ Changes

{
  "#id": "RetentionPolicies_Update",
  "$parameters": {
    "properties": {
      "$properties": {
        "properties": [
          {
            "retentionPolicies": {
              "$properties": [
                {
                  "#name": "orchestrationState",
                  "Enum": {
                    "new": [
                      [
                        "Completed",
                        "The orchestration is completed"
                      ],
                      [
                        "Failed",
                        "The orchestration is failed"
                      ],
                      [
                        "Terminated",
                        "The orchestration is terminated"
                      ],
                      [
                        "Canceled",
                        "The orchestration is canceled"
                      ]
                    ],
                    "old": [
                      [
                        "Completed",
                        "The orchestration is completed"
                      ],
                      [
                        "Failed",
                        "The orchestration is failed"
                      ],
                      [
                        "Terminated",
                        "The orchestration is terminated"
                      ],
                      [
                        "Canceled",
                        "The orchestration is terminated"
                      ]
                    ]
                  }
                }
              ]
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "retentionPolicies": {
              "$properties": [
                {
                  "#name": "orchestrationState",
                  "Enum": {
                    "new": [
                      [
                        "Completed",
                        "The orchestration is completed"
                      ],
                      [
                        "Failed",
                        "The orchestration is failed"
                      ],
                      [
                        "Terminated",
                        "The orchestration is terminated"
                      ],
                      [
                        "Canceled",
                        "The orchestration is canceled"
                      ]
                    ],
                    "old": [
                      [
                        "Completed",
                        "The orchestration is completed"
                      ],
                      [
                        "Failed",
                        "The orchestration is failed"
                      ],
                      [
                        "Terminated",
                        "The orchestration is terminated"
                      ],
                      [
                        "Canceled",
                        "The orchestration is terminated"
                      ]
                    ]
                  }
                }
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DurableTask/schedulers/{schedulerName}/retentionPolicies/default
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
schedulerName:
{
Description: The name of the Scheduler ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation ,
Enum:
{
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 ,
}
,
Required: False ,
}
enum ,
retentionPolicies:
{
Description: The orchestration retention policies ,
Required: False ,
}
[
{
retentionPeriodInDays:
{
Description: The retention period in days after which the orchestration will be purged automatically ,
Format: int32 ,
Required: True ,
}
integer ,
orchestrationState:
{
Description: The orchestration state to which this policy applies. If omitted, the policy applies to all purgeable orchestration states. ,
Enum:
{
Completed: The orchestration is completed ,
Failed: The orchestration is failed ,
Terminated: The orchestration is terminated ,
Canceled: The orchestration is canceled ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation ,
Enum:
{
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 ,
}
,
Required: False ,
}
enum ,
retentionPolicies:
{
Description: The orchestration retention policies ,
Required: False ,
}
[
{
retentionPeriodInDays:
{
Description: The retention period in days after which the orchestration will be purged automatically ,
Format: int32 ,
Required: True ,
}
integer ,
orchestrationState:
{
Description: The orchestration state to which this policy applies. If omitted, the policy applies to all purgeable orchestration states. ,
Enum:
{
Completed: The orchestration is completed ,
Failed: The orchestration is failed ,
Terminated: The orchestration is terminated ,
Canceled: The orchestration is canceled ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}