Job Class

A device job.

Variables are only populated by the server, and will be ignored when sending a request.

Constructor

Job(*, folder: str | None = None, **kwargs: Any)

Keyword-Only Parameters

Name	Description
folder	str 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.). Default value: None

Variables

Name	Description
id	str The path ID that uniquely identifies the object.
name	str The name of the object.
type	str The hierarchical type of the object.
status	str or JobStatus The current status of the job. Known values are: "Invalid", "Running", "Succeeded", "Failed", "Canceled", "Paused", and "Scheduled".
start_time	datetime The UTC date and time at which the job started.
end_time	datetime The UTC date and time at which the job completed.
percent_complete	int The percentage of the job that is complete.
error	JobErrorDetails The error details.
job_type	str or JobType The type of the job. Known values are: "Invalid", "ScanForUpdates", "DownloadUpdates", "InstallUpdates", "RefreshShare", and "RefreshContainer".
current_stage	str or UpdateOperationStage 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".
download_progress	UpdateDownloadProgress The download progress.
install_progress	UpdateInstallProgress The install progress.
total_refresh_errors	int Total number of errors encountered during the refresh process.
error_manifest_file	str Local share/remote container relative path to the error manifest file of the refresh.
refreshed_entity_id	str ARM ID of the entity that was refreshed.
folder	str 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.).