JobResponse | @azure/arm-iothub

The properties of the Job Response object.

Hierarchy

JobResponse

Index

Properties

Optional endTimeUtc

endTimeUtc: Date

The time the job stopped processing. NOTE: This property will not be serialized. It can only be populated by the server.

Optional failureReason

failureReason: undefined | string

If status == failed, this string containing the reason for the failure. NOTE: This property will not be serialized. It can only be populated by the server.

Optional jobId

jobId: undefined | string

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

Optional parentJobId

parentJobId: undefined | string

The job identifier of the parent job, if any. NOTE: This property will not be serialized. It can only be populated by the server.

Optional startTimeUtc

startTimeUtc: Date

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

Optional status

status: JobStatus

The status of the job. Possible values include: 'unknown', 'enqueued', 'running', 'completed', 'failed', 'cancelled' NOTE: This property will not be serialized. It can only be populated by the server.

Optional statusMessage

statusMessage: undefined | string

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

Optional type

type: JobType

The type of the job. Possible values include: 'unknown', 'export', 'import', 'backup', 'readDeviceProperties', 'writeDeviceProperties', 'updateDeviceConfiguration', 'rebootDevice', 'factoryResetDevice', 'firmwareUpdate' NOTE: This property will not be serialized. It can only be populated by the server.