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	vaultName, resourceGroupName, subscriptionId, jobName	api-version	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
jobName	string	Name of the job to cancel.
resourceGroupName	string	The name of the resource group where the recovery services vault is present.
subscriptionId	string	The subscription Id.
vaultName	string	The name of the recovery services vault.
api-version	string	Client Api Version.

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 
@vaultName='{{ vaultName }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@jobName='{{ jobName }}' --required, 
@api-version='{{ api-version }}'
;