backup_jobs

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

Overview

Name	backup_jobs
Type	Resource
Id	azure.recovery_services_backup.backup_jobs

Fields

The following fields are returned by SELECT queries:

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	ActivityId of job.
backupManagementType	string	Backup management type to execute the current job. Known values are: "Invalid", "AzureIaasVM", "MAB", "DPM", "AzureBackupServer", "AzureSql", "AzureStorage", "AzureWorkload", and "DefaultBackup". (Invalid, AzureIaasVM, MAB, DPM, AzureBackupServer, AzureSql, AzureStorage, AzureWorkload, DefaultBackup)
eTag	string	Optional ETag.
endTime	string (date-time)	The end time.
entityFriendlyName	string	Friendly name of the entity on which the current job is executing.
jobType	string	This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. Required. Default value is None.
location	string	The geo-location where the resource lives.
operation	string	The operation name.
startTime	string (date-time)	The start time.
status	string	Job status.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
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
list	select	vault_name, resource_group_name, subscription_id	$filter, $skipToken	Provides a pageable list of jobs.

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.
subscription_id	string
vault_name	string	The name of the VaultResource. Required.
$filter	string	OData filter options. Default value is None.
$skipToken	string	skipToken Filter. Default value is None.

SELECT examples

list

Provides a pageable list of jobs.

SELECT
id,
name,
activityId,
backupManagementType,
eTag,
endTime,
entityFriendlyName,
jobType,
location,
operation,
startTime,
status,
systemData,
tags,
type
FROM azure.recovery_services_backup.backup_jobs
WHERE vault_name = '{{ vault_name }}' -- required
AND resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
AND $skipToken = '{{ $skipToken }}'
;