Share via

Job interface

  • Reference
Package:
@azure/arm-automation

Definition of the job.

Extends
ProxyResource

Properties

creationTime

Gets or sets the creation time of the job.
endTime

Gets or sets the end time of the job.
exception

Gets or sets the exception of the job.
jobId

Gets or sets the id of the job.
lastModifiedTime

Gets or sets the last modified time of the job.
lastStatusModifiedTime

Gets or sets the last status modified time of the job.
parameters

Gets or sets the parameters of the job.
provisioningState

The current provisioning state of the job. Possible values include: 'Failed', 'Succeeded', 'Suspended', 'Processing'
runbook

Gets or sets the runbook.
runOn

Gets or sets the runOn which specifies the group name where the job is to be executed.
startedBy

Gets or sets the job started by.
startTime

Gets or sets the start time of the job.
status

Gets or sets the status of the job. Possible values include: 'New', 'Activating', 'Running', 'Completed', 'Failed', 'Stopped', 'Blocked', 'Suspended', 'Disconnected', 'Suspending', 'Stopping', 'Resuming', 'Removing'
statusDetails

Gets or sets the status details of the job.

Inherited Properties

id

Fully qualified resource Id for the resource NOTE: This property will not be serialized. It can only be populated by the server.
name

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

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

Property Details

creationTime

Gets or sets the creation time of the job.

creationTime?: Date

Property Value

Date

endTime

Gets or sets the end time of the job.

endTime?: Date

Property Value

Date

exception

Gets or sets the exception of the job.

exception?: string

Property Value

string

jobId

Gets or sets the id of the job.

jobId?: string

Property Value

string

lastModifiedTime

Gets or sets the last modified time of the job.

lastModifiedTime?: Date

Property Value

Date

lastStatusModifiedTime

Gets or sets the last status modified time of the job.

lastStatusModifiedTime?: Date

Property Value

Date

parameters

Gets or sets the parameters of the job.

parameters?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

provisioningState

The current provisioning state of the job. Possible values include: 'Failed', 'Succeeded', 'Suspended', 'Processing'

provisioningState?: JobProvisioningState

Property Value

JobProvisioningState

runbook

Gets or sets the runbook.

runbook?: RunbookAssociationProperty

Property Value

RunbookAssociationProperty

runOn

Gets or sets the runOn which specifies the group name where the job is to be executed.

runOn?: string

Property Value

string

startedBy

Gets or sets the job started by.

startedBy?: string

Property Value

string

startTime

Gets or sets the start time of the job.

startTime?: Date

Property Value

Date

status

Gets or sets the status of the job. Possible values include: 'New', 'Activating', 'Running', 'Completed', 'Failed', 'Stopped', 'Blocked', 'Suspended', 'Disconnected', 'Suspending', 'Stopping', 'Resuming', 'Removing'

status?: JobStatus

Property Value

JobStatus

statusDetails

Gets or sets the status details of the job.

statusDetails?: string

Property Value

string

Inherited Property Details

id

Fully qualified resource Id for the resource NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From ProxyResource.id

name

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

name?: string

Property Value

string

Inherited From ProxyResource.name

type

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

type?: string

Property Value

string

Inherited From ProxyResource.type