job_runs

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

Overview

Name	job_runs
Type	Resource
Id	azure.storage_mover.job_runs

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.
agentName	string	Name of the Agent assigned to this run.
agentResourceId	string	Fully qualified resource id of the Agent assigned to this run.
bytesExcluded	integer	Bytes of data that will not be transferred, as they are excluded by user configuration.
bytesFailed	integer	Bytes of data that were attempted to transfer and failed.
bytesNoTransferNeeded	integer	Bytes of data that will not be transferred, as they are already found on target (e.g. mirror mode).
bytesScanned	integer	Bytes of data scanned so far in source.
bytesTransferred	integer	Bytes of data successfully transferred to target.
bytesUnsupported	integer	Bytes of data that will not be transferred, as they are unsupported on target.
error	object	Error details.
executionEndTime	string (date-time)	End time of the run. Null if Agent has not reported that the job has ended.
executionStartTime	string (date-time)	Start time of the run. Null if no Agent reported that the job has started.
itemsExcluded	integer	Number of items that will not be transferred, as they are excluded by user configuration.
itemsFailed	integer	Number of items that were attempted to transfer and failed.
itemsNoTransferNeeded	integer	Number of items that will not be transferred, as they are already found on target (e.g. mirror mode).
itemsScanned	integer	Number of items scanned so far in source.
itemsTransferred	integer	Number of items successfully transferred to target.
itemsUnsupported	integer	Number of items that will not be transferred, as they are unsupported on target.
jobDefinitionProperties	object	Copy of parent Job Definition's properties at time of Job Run creation.
lastStatusUpdate	string (date-time)	The last updated time of the Job Run.
provisioningState	string	The provisioning state of this resource. Known values are: "Succeeded", "Canceled", "Failed", and "Deleting". (Succeeded, Canceled, Failed, Deleting)
scanStatus	string	The status of Agent's scanning of source. Known values are: "NotStarted", "Scanning", and "Completed". (NotStarted, Scanning, Completed)
scheduledExecutionTime	string (date-time)	Scheduled execution time. Null if Trigger type is manual.
sourceName	string	Name of source Endpoint resource. This resource may no longer exist.
sourceProperties	object	Copy of source Endpoint resource's properties at time of Job Run creation.
sourceResourceId	string	Fully qualified resource id of source Endpoint. This id may no longer exist.
status	string	The state of the job execution. Known values are: "Queued", "Started", "Running", "CancelRequested", "Canceling", "Canceled", "Failed", "Succeeded", and "PausedByBandwidthManagement". (Queued, Started, Running, CancelRequested, Canceling, Canceled, Failed, Succeeded, PausedByBandwidthManagement)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
targetName	string	Name of target Endpoint resource. This resource may no longer exist.
targetProperties	object	Copy of Endpoint resource's properties at time of Job Run creation.
targetResourceId	string	Fully qualified resource id of of Endpoint. This id may no longer exist.
triggerType	string	Trigger type for the job run. Default is manual. Known values are: "Manual" and "Scheduled". (Manual, Scheduled)
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
warnings	array	Warning details.

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.
agentName	string	Name of the Agent assigned to this run.
agentResourceId	string	Fully qualified resource id of the Agent assigned to this run.
bytesExcluded	integer	Bytes of data that will not be transferred, as they are excluded by user configuration.
bytesFailed	integer	Bytes of data that were attempted to transfer and failed.
bytesNoTransferNeeded	integer	Bytes of data that will not be transferred, as they are already found on target (e.g. mirror mode).
bytesScanned	integer	Bytes of data scanned so far in source.
bytesTransferred	integer	Bytes of data successfully transferred to target.
bytesUnsupported	integer	Bytes of data that will not be transferred, as they are unsupported on target.
error	object	Error details.
executionEndTime	string (date-time)	End time of the run. Null if Agent has not reported that the job has ended.
executionStartTime	string (date-time)	Start time of the run. Null if no Agent reported that the job has started.
itemsExcluded	integer	Number of items that will not be transferred, as they are excluded by user configuration.
itemsFailed	integer	Number of items that were attempted to transfer and failed.
itemsNoTransferNeeded	integer	Number of items that will not be transferred, as they are already found on target (e.g. mirror mode).
itemsScanned	integer	Number of items scanned so far in source.
itemsTransferred	integer	Number of items successfully transferred to target.
itemsUnsupported	integer	Number of items that will not be transferred, as they are unsupported on target.
jobDefinitionProperties	object	Copy of parent Job Definition's properties at time of Job Run creation.
lastStatusUpdate	string (date-time)	The last updated time of the Job Run.
provisioningState	string	The provisioning state of this resource. Known values are: "Succeeded", "Canceled", "Failed", and "Deleting". (Succeeded, Canceled, Failed, Deleting)
scanStatus	string	The status of Agent's scanning of source. Known values are: "NotStarted", "Scanning", and "Completed". (NotStarted, Scanning, Completed)
scheduledExecutionTime	string (date-time)	Scheduled execution time. Null if Trigger type is manual.
sourceName	string	Name of source Endpoint resource. This resource may no longer exist.
sourceProperties	object	Copy of source Endpoint resource's properties at time of Job Run creation.
sourceResourceId	string	Fully qualified resource id of source Endpoint. This id may no longer exist.
status	string	The state of the job execution. Known values are: "Queued", "Started", "Running", "CancelRequested", "Canceling", "Canceled", "Failed", "Succeeded", and "PausedByBandwidthManagement". (Queued, Started, Running, CancelRequested, Canceling, Canceled, Failed, Succeeded, PausedByBandwidthManagement)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
targetName	string	Name of target Endpoint resource. This resource may no longer exist.
targetProperties	object	Copy of Endpoint resource's properties at time of Job Run creation.
targetResourceId	string	Fully qualified resource id of of Endpoint. This id may no longer exist.
triggerType	string	Trigger type for the job run. Default is manual. Known values are: "Manual" and "Scheduled". (Manual, Scheduled)
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
warnings	array	Warning details.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, storage_mover_name, project_name, job_definition_name, job_run_name, subscription_id		Gets a Job Run resource.
list	select	resource_group_name, storage_mover_name, project_name, job_definition_name, subscription_id		Lists all Job Runs in a Job Definition.

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_definition_name	string	The name of the Job Definition resource. Required.
job_run_name	string	The name of the Job Run resource. Required.
project_name	string	The name of the Project resource. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
storage_mover_name	string	The name of the Storage Mover resource. Required.
subscription_id	string

SELECT examples

get

Gets a Job Run resource.

SELECT
id,
name,
agentName,
agentResourceId,
bytesExcluded,
bytesFailed,
bytesNoTransferNeeded,
bytesScanned,
bytesTransferred,
bytesUnsupported,
error,
executionEndTime,
executionStartTime,
itemsExcluded,
itemsFailed,
itemsNoTransferNeeded,
itemsScanned,
itemsTransferred,
itemsUnsupported,
jobDefinitionProperties,
lastStatusUpdate,
provisioningState,
scanStatus,
scheduledExecutionTime,
sourceName,
sourceProperties,
sourceResourceId,
status,
systemData,
targetName,
targetProperties,
targetResourceId,
triggerType,
type,
warnings
FROM azure.storage_mover.job_runs
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND storage_mover_name = '{{ storage_mover_name }}' -- required
AND project_name = '{{ project_name }}' -- required
AND job_definition_name = '{{ job_definition_name }}' -- required
AND job_run_name = '{{ job_run_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Lists all Job Runs in a Job Definition.

SELECT
id,
name,
agentName,
agentResourceId,
bytesExcluded,
bytesFailed,
bytesNoTransferNeeded,
bytesScanned,
bytesTransferred,
bytesUnsupported,
error,
executionEndTime,
executionStartTime,
itemsExcluded,
itemsFailed,
itemsNoTransferNeeded,
itemsScanned,
itemsTransferred,
itemsUnsupported,
jobDefinitionProperties,
lastStatusUpdate,
provisioningState,
scanStatus,
scheduledExecutionTime,
sourceName,
sourceProperties,
sourceResourceId,
status,
systemData,
targetName,
targetProperties,
targetResourceId,
triggerType,
type,
warnings
FROM azure.storage_mover.job_runs
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND storage_mover_name = '{{ storage_mover_name }}' -- required
AND project_name = '{{ project_name }}' -- required
AND job_definition_name = '{{ job_definition_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;