Job interface

Package:

@azure/arm-databoxedge

A device job.

Extends

ProxyResource

Properties

currentStage	Current stage of the update operation.
downloadProgress	The download progress.
endTime	The UTC date and time at which the job completed.
error	The error details.
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.
percentComplete	The percentage of the job that is complete.
refreshedEntityId	ARM ID of the entity that was refreshed.
startTime	The UTC date and time at which the job started.
status	The current status of the job.
totalRefreshErrors	Total number of errors encountered during the refresh process.

Inherited Properties

id	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	The name of the resource
systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Property Details

currentStage

Current stage of the update operation.

currentStage?: string

Property Value

string

downloadProgress

The download progress.

downloadProgress?: UpdateDownloadProgress

Property Value

UpdateDownloadProgress

endTime

The UTC date and time at which the job completed.

endTime?: Date

Property Value

Date

error

The error details.

error?: JobErrorDetails

Property Value

JobErrorDetails

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

UpdateInstallProgress

jobType

The type of the job.

jobType?: string

Property Value

string

percentComplete

The percentage of the job that is complete.

percentComplete?: number

Property Value

number

refreshedEntityId

ARM ID of the entity that was refreshed.

refreshedEntityId?: string

Property Value

string

startTime

The UTC date and time at which the job started.

startTime?: Date

Property Value

Date

status

The current status of the job.

status?: string

Property Value

string

totalRefreshErrors

Total number of errors encountered during the refresh process.

totalRefreshErrors?: number

Property Value

number

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

id?: string

Property Value

string

Inherited From ProxyResource.id

name

The name of the resource

name?: string

Property Value

string

Inherited From ProxyResource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

systemData?: SystemData

Property Value

SystemData

Inherited From ProxyResource.systemData

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

type?: string

Property Value

string

Inherited From ProxyResource.type