job_cancellations

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

Overview

Name	job_cancellations
Type	Resource
Id	azure.recovery_services_backup.job_cancellations

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
trigger	exec	vault_name, resource_group_name, job_name, subscription_id		Cancels a job. This is an asynchronous operation. To know the status of the cancellation, call GetCancelOperationResult API.

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
job_name	string	Name of the job whose details are to be fetched. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
vault_name	string	The name of the VaultResource. Required.

Lifecycle Methods

trigger

Cancels a job. This is an asynchronous operation. To know the status of the cancellation, call GetCancelOperationResult API.

EXEC azure.recovery_services_backup.job_cancellations.trigger 
@vault_name='{{ vault_name }}' --required, 
@resource_group_name='{{ resource_group_name }}' --required, 
@job_name='{{ job_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;