Share via

az durabletask retention-policy

Note

This reference is part of the durabletask extension for the Azure CLI (version 2.70.0 or higher). The extension will automatically install the first time you run an az durabletask retention-policy command. Learn more about extensions.

Manage Retention Policy.

Commands

Name Description Type Status
az durabletask retention-policy create

Create a Retention Policy on a Durabletask Scheduler.

 Extension GA
az durabletask retention-policy delete

Delete a Retention Policy on a Durabletask Scheduler.

 Extension GA
az durabletask retention-policy show

Get a Retention Policy.

 Extension GA
az durabletask retention-policy wait

Place the CLI in a waiting state until a condition is met.

 Extension GA

az durabletask retention-policy create

Create a Retention Policy on a Durabletask Scheduler.

az durabletask retention-policy create --resource-group
                                       --scheduler-name
                                       [--canceled-days]
                                       [--completed-days]
                                       [--default-days]
                                       [--failed-days]
                                       [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                       [--terminated-days]

Examples

Create a new retention policy for a scheduler with a default retention period of 30 days.

az durabletask retention-policy create -g "example-rg" --scheduler-name "example-scheduler" --retention-days 30

Required Parameters

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--scheduler-name

The name of the Scheduler.

Optional Parameters

--canceled-days -x

The number of days to retain canceled orchestrations.

--completed-days -c

The number of days to retain completed orchestrations.

--default-days -d

The number of days to retain orchestrations.

--failed-days -f

The number of days to retain failed orchestrations.

--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--terminated-days -t

The number of days to retain terminated orchestrations.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az durabletask retention-policy delete

Delete a Retention Policy on a Durabletask Scheduler.

az durabletask retention-policy delete [--ids]
                                       [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                       [--resource-group]
                                       [--scheduler-name]
                                       [--subscription]
                                       [--yes]

Examples

Delete a Retention Policy on a Scheduler

az durabletask retention-policy delete -g "example-rg" --scheduler-name "example-scheduler"

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--scheduler-name

The name of the Scheduler.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--yes -y

Do not prompt for confirmation.

Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az durabletask retention-policy show

Get a Retention Policy.

az durabletask retention-policy show [--ids]
                                     [--resource-group]
                                     [--scheduler-name]
                                     [--subscription]

Examples

Show details of a specific retention policy on a Scheduler.

az durabletask retention-policy show -g "example-rg" --scheduler-name "example-scheduler"

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--scheduler-name

The name of the Scheduler.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az durabletask retention-policy wait

Place the CLI in a waiting state until a condition is met.

az durabletask retention-policy wait [--created]
                                     [--custom]
                                     [--deleted]
                                     [--exists]
                                     [--ids]
                                     [--interval]
                                     [--resource-group]
                                     [--scheduler-name]
                                     [--subscription]
                                     [--timeout]
                                     [--updated]

Optional Parameters

--created

Wait until created with 'provisioningState' at 'Succeeded'.

Default value: False
--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Wait until deleted.

Default value: False
--exists

Wait until the resource exists.

Default value: False
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--interval

Polling interval in seconds.

Default value: 30
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--scheduler-name

The name of the Scheduler.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--timeout

Maximum wait in seconds.

Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.