retention_policies

Creates, updates, deletes, gets or lists a retention_policies resource.

Overview

Name	retention_policies
Type	Resource
Id	azure.durable_task.retention_policies

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
provisioningState	string	The status of the last operation. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", and "Accepted". (Succeeded, Failed, Canceled, Provisioning, Updating, Deleting, Accepted)
retentionPolicies	array	The orchestration retention policies.
systemData	object	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".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, scheduler_name, subscription_id		Get a Retention Policy.
create_or_replace	insert	resource_group_name, scheduler_name, subscription_id		Create or Update a Retention Policy.
update	update	resource_group_name, scheduler_name, subscription_id		Update a Retention Policy.
create_or_replace	replace	resource_group_name, scheduler_name, subscription_id		Create or Update a Retention Policy.
delete	delete	resource_group_name, scheduler_name, subscription_id		Delete a Retention Policy.
list_by_scheduler	exec	resource_group_name, scheduler_name, subscription_id		List Retention Policies.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
scheduler_name	string	The name of the Scheduler. Required.
subscription_id	string

SELECT examples

get

Get a Retention Policy.

SELECT
id,
name,
provisioningState,
retentionPolicies,
systemData,
type
FROM azure.durable_task.retention_policies
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND scheduler_name = '{{ scheduler_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_replace

Create or Update a Retention Policy.

INSERT INTO azure.durable_task.retention_policies (
properties,
resource_group_name,
scheduler_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ scheduler_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: retention_policies
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the retention_policies resource.
  - name: scheduler_name
    value: "{{ scheduler_name }}"
    description: Required parameter for the retention_policies resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the retention_policies resource.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      provisioningState: "{{ provisioningState }}"
      retentionPolicies:
        - retentionPeriodInDays: {{ retentionPeriodInDays }}
          orchestrationState: "{{ orchestrationState }}"

UPDATE examples

update

Update a Retention Policy.

UPDATE azure.durable_task.retention_policies
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND scheduler_name = '{{ scheduler_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

REPLACE examples

create_or_replace

Create or Update a Retention Policy.

REPLACE azure.durable_task.retention_policies
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND scheduler_name = '{{ scheduler_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Delete a Retention Policy.

DELETE FROM azure.durable_task.retention_policies
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND scheduler_name = '{{ scheduler_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

list_by_scheduler

List Retention Policies.

EXEC azure.durable_task.retention_policies.list_by_scheduler 
@resource_group_name='{{ resource_group_name }}' --required, 
@scheduler_name='{{ scheduler_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;