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
- list
| Name | Datatype | Description |
|---|---|---|
id | string | Resource Id represents the complete path to the resource. |
name | string | Resource name associated with the resource. |
properties | object | AzureBackupJobResource properties |
systemData | object | Metadata pertaining to creation and last modification of the resource. |
type | string | Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/... |
| Name | Datatype | Description |
|---|---|---|
id | string | Resource Id represents the complete path to the resource. |
name | string | Resource name associated with the resource. |
properties | object | AzureBackupJobResource properties |
systemData | object | Metadata pertaining to creation and last modification of the resource. |
type | string | Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/... |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | subscriptionId, resourceGroupName, vaultName, jobId | Gets a job with id in a backup vault | |
list | select | subscriptionId, resourceGroupName, vaultName | 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 |
|---|---|---|
jobId | string | The Job ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). |
resourceGroupName | string | The name of the resource group. The name is case insensitive. |
subscriptionId | string (uuid) | The ID of the target subscription. The value must be an UUID. |
vaultName | string | The name of the backup vault. |
SELECT examples
- get
- list
Gets a job with id in a backup vault
SELECT
id,
name,
properties,
systemData,
type
FROM azure.data_protection.jobs
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND vaultName = '{{ vaultName }}' -- required
AND jobId = '{{ jobId }}' -- required
;
Returns list of jobs belonging to a backup vault
SELECT
id,
name,
properties,
systemData,
type
FROM azure.data_protection.jobs
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND vaultName = '{{ vaultName }}' -- required
;