Job Class

A device job.

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

Inheritance
msrest.serialization.Model
Job

Constructor

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

Parameters

Name Description
folder
Required
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.).

Keyword-Only Parameters

Name Description
folder
Required

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

The current status of the job. Possible values include: "Invalid", "Running", "Succeeded", "Failed", "Canceled", "Paused", "Scheduled".

start_time

The UTC date and time at which the job started.

end_time

The UTC date and time at which the job completed.

percent_complete
int

The percentage of the job that is complete.

error

The error details.

job_type

The type of the job. Possible values include: "Invalid", "ScanForUpdates", "DownloadUpdates", "InstallUpdates", "RefreshShare", "RefreshContainer".

current_stage

Current stage of the update operation. Possible values include: "Unknown", "Initial", "ScanStarted", "ScanComplete", "ScanFailed", "DownloadStarted", "DownloadComplete", "DownloadFailed", "InstallStarted", "InstallComplete", "InstallFailed", "RebootInitiated", "Success", "Failure", "RescanStarted", "RescanComplete", "RescanFailed".

download_progress

The download progress.

install_progress

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.