JobStep interface

A job step.

Extends

Properties

action

The action payload of the job step.

credential

The resource ID of the job credential that will be used to connect to the targets.

executionOptions

Execution options for the job step.

output

Output destination properties of the job step.

stepId

The job step's index within the job. If not specified when creating the job step, it will be created as the last step. If not specified when updating the job step, the step id is not modified.

targetGroup

The resource ID of the target group that the job step will be executed on.

Inherited Properties

id

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

name

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

type

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

Property Details

action

The action payload of the job step.

action?: JobStepAction

Property Value

credential

The resource ID of the job credential that will be used to connect to the targets.

credential?: string

Property Value

string

executionOptions

Execution options for the job step.

executionOptions?: JobStepExecutionOptions

Property Value

output

Output destination properties of the job step.

output?: JobStepOutput

Property Value

stepId

The job step's index within the job. If not specified when creating the job step, it will be created as the last step. If not specified when updating the job step, the step id is not modified.

stepId?: number

Property Value

number

targetGroup

The resource ID of the target group that the job step will be executed on.

targetGroup?: string

Property Value

string

Inherited Property Details

id

Resource ID. 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

Resource name. 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

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

type?: string

Property Value

string

Inherited From ProxyResource.type