jobs

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

Overview

Name	jobs
Type	Resource
Id	azure.data_protection.jobs

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.
activityID	string	Job Activity Id. Required.
backupInstanceFriendlyName	string	Name of the Backup Instance. Required.
backupInstanceId	string	ARM ID of the Backup Instance.
dataSourceId	string	ARM ID of the DataSource. Required.
dataSourceLocation	string	Location of the DataSource. Required.
dataSourceName	string	User Friendly Name of the DataSource. Required.
dataSourceSetName	string	Data Source Set Name of the DataSource.
dataSourceType	string	Type of DataSource. Required.
destinationDataStoreName	string	:vartype destination_data_store_name: str
duration	string	Total run time of the job. ISO 8601 format.
endTime	string (date-time)	EndTime of the job(in UTC).
errorDetails	array	A List, detailing the errors related to the job.
etag	string	:vartype etag: str
extendedInfo	object	Extended Information about the job.
isUserTriggered	boolean	Indicated that whether the job is adhoc(true) or scheduled(false). Required.
operation	string	It indicates the type of Job i.e. Backup:full/log/diff ;Restore:ALR/OLR; Tiering:Backup/Archive ; Management:ConfigureProtection/UnConfigure. Required.
operationCategory	string	It indicates the type of Job i.e. Backup/Restore/Tiering/Management. Required.
policyId	string	ARM ID of the policy.
policyName	string	Name of the policy.
progressEnabled	boolean	Indicated whether progress is enabled for the job. Required.
progressUrl	string	Url which contains job's progress.
rehydrationPriority	string	Priority to be used for rehydration.
restoreType	string	It indicates the sub type of operation i.e. in case of Restore it can be ALR/OLR.
sourceDataStoreName	string	:vartype source_data_store_name: str
sourceResourceGroup	string	Resource Group Name of the Datasource. Required.
sourceSubscriptionID	string	SubscriptionId corresponding to the DataSource. Required.
startTime	string (date-time)	StartTime of the job(in UTC). Required.
status	string	Status of the job like InProgress/Completed/Failed/Cancelled/CompletedWithWarnings/Cancelling/Paused. Required.
subscriptionId	string	Subscription Id of the corresponding backup vault. Required.
supportedActions	array	List of supported actions. Required.
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".
vaultName	string	Name of the vault. Required.

list

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.
activityID	string	Job Activity Id. Required.
backupInstanceFriendlyName	string	Name of the Backup Instance. Required.
backupInstanceId	string	ARM ID of the Backup Instance.
dataSourceId	string	ARM ID of the DataSource. Required.
dataSourceLocation	string	Location of the DataSource. Required.
dataSourceName	string	User Friendly Name of the DataSource. Required.
dataSourceSetName	string	Data Source Set Name of the DataSource.
dataSourceType	string	Type of DataSource. Required.
destinationDataStoreName	string	:vartype destination_data_store_name: str
duration	string	Total run time of the job. ISO 8601 format.
endTime	string (date-time)	EndTime of the job(in UTC).
errorDetails	array	A List, detailing the errors related to the job.
etag	string	:vartype etag: str
extendedInfo	object	Extended Information about the job.
isUserTriggered	boolean	Indicated that whether the job is adhoc(true) or scheduled(false). Required.
operation	string	It indicates the type of Job i.e. Backup:full/log/diff ;Restore:ALR/OLR; Tiering:Backup/Archive ; Management:ConfigureProtection/UnConfigure. Required.
operationCategory	string	It indicates the type of Job i.e. Backup/Restore/Tiering/Management. Required.
policyId	string	ARM ID of the policy.
policyName	string	Name of the policy.
progressEnabled	boolean	Indicated whether progress is enabled for the job. Required.
progressUrl	string	Url which contains job's progress.
rehydrationPriority	string	Priority to be used for rehydration.
restoreType	string	It indicates the sub type of operation i.e. in case of Restore it can be ALR/OLR.
sourceDataStoreName	string	:vartype source_data_store_name: str
sourceResourceGroup	string	Resource Group Name of the Datasource. Required.
sourceSubscriptionID	string	SubscriptionId corresponding to the DataSource. Required.
startTime	string (date-time)	StartTime of the job(in UTC). Required.
status	string	Status of the job like InProgress/Completed/Failed/Cancelled/CompletedWithWarnings/Cancelling/Paused. Required.
subscriptionId	string	Subscription Id of the corresponding backup vault. Required.
supportedActions	array	List of supported actions. Required.
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".
vaultName	string	Name of the vault. Required.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, vault_name, job_id, subscription_id		Gets a job with id in a backup vault.
list	select	resource_group_name, vault_name, subscription_id		Returns list of jobs belonging to a backup vault.

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_id	string	The Job ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). 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 backup vault. Required.

SELECT examples

get

Gets a job with id in a backup vault.

SELECT
id,
name,
activityID,
backupInstanceFriendlyName,
backupInstanceId,
dataSourceId,
dataSourceLocation,
dataSourceName,
dataSourceSetName,
dataSourceType,
destinationDataStoreName,
duration,
endTime,
errorDetails,
etag,
extendedInfo,
isUserTriggered,
operation,
operationCategory,
policyId,
policyName,
progressEnabled,
progressUrl,
rehydrationPriority,
restoreType,
sourceDataStoreName,
sourceResourceGroup,
sourceSubscriptionID,
startTime,
status,
subscriptionId,
supportedActions,
systemData,
type,
vaultName
FROM azure.data_protection.jobs
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND vault_name = '{{ vault_name }}' -- required
AND job_id = '{{ job_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Returns list of jobs belonging to a backup vault.

SELECT
id,
name,
activityID,
backupInstanceFriendlyName,
backupInstanceId,
dataSourceId,
dataSourceLocation,
dataSourceName,
dataSourceSetName,
dataSourceType,
destinationDataStoreName,
duration,
endTime,
errorDetails,
etag,
extendedInfo,
isUserTriggered,
operation,
operationCategory,
policyId,
policyName,
progressEnabled,
progressUrl,
rehydrationPriority,
restoreType,
sourceDataStoreName,
sourceResourceGroup,
sourceSubscriptionID,
startTime,
status,
subscriptionId,
supportedActions,
systemData,
type,
vaultName
FROM azure.data_protection.jobs
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND vault_name = '{{ vault_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;