Job interface

Package:

@azure/arm-databoxedge

A device job.

Properties

currentStage	Current stage of the update operation. NOTE: This property will not be serialized. It can only be populated by the server.
downloadProgress	The download progress. NOTE: This property will not be serialized. It can only be populated by the server.
endTime	The UTC date and time at which the job completed. NOTE: This property will not be serialized. It can only be populated by the server.
error	The error details. NOTE: This property will not be serialized. It can only be populated by the server.
errorManifestFile	Local share/remote container relative path to the error manifest file of the refresh. NOTE: This property will not be serialized. It can only be populated by the server.
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.)
id	The path ID that uniquely identifies the object. NOTE: This property will not be serialized. It can only be populated by the server.
installProgress	The install progress. NOTE: This property will not be serialized. It can only be populated by the server.
jobType	The type of the job. NOTE: This property will not be serialized. It can only be populated by the server.
name	The name of the object. NOTE: This property will not be serialized. It can only be populated by the server.
percentComplete	The percentage of the job that is complete. NOTE: This property will not be serialized. It can only be populated by the server.
refreshedEntityId	ARM ID of the entity that was refreshed. NOTE: This property will not be serialized. It can only be populated by the server.
startTime	The UTC date and time at which the job started. NOTE: This property will not be serialized. It can only be populated by the server.
status	The current status of the job. NOTE: This property will not be serialized. It can only be populated by the server.
totalRefreshErrors	Total number of errors encountered during the refresh process. NOTE: This property will not be serialized. It can only be populated by the server.
type	The hierarchical type of the object. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

currentStage

Current stage of the update operation. NOTE: This property will not be serialized. It can only be populated by the server.

currentStage?: string

Property Value

string

downloadProgress

The download progress. NOTE: This property will not be serialized. It can only be populated by the server.

downloadProgress?: UpdateDownloadProgress

Property Value

UpdateDownloadProgress

endTime

The UTC date and time at which the job completed. NOTE: This property will not be serialized. It can only be populated by the server.

endTime?: Date

Property Value

Date

error

The error details. NOTE: This property will not be serialized. It can only be populated by the server.

error?: JobErrorDetails

Property Value

JobErrorDetails

errorManifestFile

Local share/remote container relative path to the error manifest file of the refresh. NOTE: This property will not be serialized. It can only be populated by the server.

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

id

The path ID that uniquely identifies the object. NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

installProgress

The install progress. NOTE: This property will not be serialized. It can only be populated by the server.

installProgress?: UpdateInstallProgress

Property Value

UpdateInstallProgress

jobType

The type of the job. NOTE: This property will not be serialized. It can only be populated by the server.

jobType?: string

Property Value

string

name

The name of the object. NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

percentComplete

The percentage of the job that is complete. NOTE: This property will not be serialized. It can only be populated by the server.

percentComplete?: number

Property Value

number

refreshedEntityId

ARM ID of the entity that was refreshed. NOTE: This property will not be serialized. It can only be populated by the server.

refreshedEntityId?: string

Property Value

string

startTime

The UTC date and time at which the job started. NOTE: This property will not be serialized. It can only be populated by the server.

startTime?: Date

Property Value

Date

status

The current status of the job. NOTE: This property will not be serialized. It can only be populated by the server.

status?: string

Property Value

string

totalRefreshErrors

Total number of errors encountered during the refresh process. NOTE: This property will not be serialized. It can only be populated by the server.

totalRefreshErrors?: number

Property Value

number

type

The hierarchical type of the object. NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string