jobs

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

Overview

Name	jobs
Type	Resource
Id	azure.data_box_edge.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.
currentStage	string	Current stage of the update operation. Known values are: "Unknown", "Initial", "ScanStarted", "ScanComplete", "ScanFailed", "DownloadStarted", "DownloadComplete", "DownloadFailed", "InstallStarted", "InstallComplete", "InstallFailed", "RebootInitiated", "Success", "Failure", "RescanStarted", "RescanComplete", and "RescanFailed". (Unknown, Initial, ScanStarted, ScanComplete, ScanFailed, DownloadStarted, DownloadComplete, DownloadFailed, InstallStarted, InstallComplete, InstallFailed, RebootInitiated, Success, Failure, RescanStarted, RescanComplete, RescanFailed)
downloadProgress	object	The download progress.
endTime	string (date-time)	The UTC date and time at which the job completed.
error	object	The error details.
errorManifestFile	string	Local share/remote container relative path to the error manifest file of the refresh.
folder	string	If only subfolders need to be refreshed, then the subfolder path inside the share or container. (The path is empty if there are no subfolders.).
installProgress	object	The install progress.
jobType	string	The type of the job. Known values are: "Invalid", "ScanForUpdates", "DownloadUpdates", "InstallUpdates", "RefreshShare", "RefreshContainer", "Backup", "Restore", and "TriggerSupportPackage". (Invalid, ScanForUpdates, DownloadUpdates, InstallUpdates, RefreshShare, RefreshContainer, Backup, Restore, TriggerSupportPackage)
percentComplete	integer	The percentage of the job that is complete.
refreshedEntityId	string	ARM ID of the entity that was refreshed.
startTime	string (date-time)	The UTC date and time at which the job started.
status	string	The current status of the job. Known values are: "Invalid", "Running", "Succeeded", "Failed", "Canceled", "Paused", and "Scheduled". (Invalid, Running, Succeeded, Failed, Canceled, Paused, Scheduled)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
totalRefreshErrors	integer	Total number of errors encountered during the refresh process.
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
get	select	device_name, name, resource_group_name, subscription_id		Gets the details of a specified job on a Data Box Edge/Data Box Gateway device. Gets the details of a specified job on a Data Box Edge/Data Box Gateway device.

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
device_name	string	The device name. Required.
name	string	The job name. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Gets the details of a specified job on a Data Box Edge/Data Box Gateway device. Gets the details of a specified job on a Data Box Edge/Data Box Gateway device.

SELECT
id,
name,
currentStage,
downloadProgress,
endTime,
error,
errorManifestFile,
folder,
installProgress,
jobType,
percentComplete,
refreshedEntityId,
startTime,
status,
systemData,
totalRefreshErrors,
type
FROM azure.data_box_edge.jobs
WHERE device_name = '{{ device_name }}' -- required
AND name = '{{ name }}' -- required
AND resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;