JobStep interface

Package:
@azure/arm-sql

A job step.

Extends
ProxyResource

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

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

action

The action payload of the job step.

action?: JobStepAction

Property Value

JobStepAction

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

JobStepExecutionOptions

output

Output destination properties of the job step.

output?: JobStepOutput

Property Value

JobStepOutput

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

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