JobProperties interface

The properties for the job.

Properties

currentStage

Current stage of the update operation.

downloadProgress

The download progress.

errorManifestFile

Local share/remote container relative path to the error manifest file of the refresh.

folder

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

The install progress.

jobType

The type of the job.

refreshedEntityId

ARM ID of the entity that was refreshed.

totalRefreshErrors

Total number of errors encountered during the refresh process.

Property Details

currentStage

Current stage of the update operation.

currentStage?: string

Property Value

string

downloadProgress

The download progress.

downloadProgress?: UpdateDownloadProgress

Property Value

errorManifestFile

Local share/remote container relative path to the error manifest file of the refresh.

errorManifestFile?: string

Property Value

string

folder

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.)

folder?: string

Property Value

string

installProgress

The install progress.

installProgress?: UpdateInstallProgress

Property Value

jobType

The type of the job.

jobType?: string

Property Value

string

refreshedEntityId

ARM ID of the entity that was refreshed.

refreshedEntityId?: string

Property Value

string

totalRefreshErrors

Total number of errors encountered during the refresh process.

totalRefreshErrors?: number

Property Value

number