Package version:

Interface JobSteps

Interface representing a JobSteps.

Hierarchy

JobSteps

Index

Methods

createOrUpdate delete get getByVersion listByJob listByVersion

Methods

createOrUpdate

createOrUpdate(resourceGroupName: string, serverName: string, jobAgentName: string, jobName: string, stepName: string, parameters: JobStep, options?: JobStepsCreateOrUpdateOptionalParams): Promise<JobStep>
Creates or updates a job step. This will implicitly create a new job version.
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serverName: string
  
  The name of the server.
- jobAgentName: string
  
  The name of the job agent.
- jobName: string
  
  The name of the job.
- stepName: string
  
  The name of the job step.
- parameters: JobStep
  
  The requested state of the job step.
- Optional options: JobStepsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<JobStep>
- Defined in operationsInterfaces/jobSteps.ts:109

delete

delete(resourceGroupName: string, serverName: string, jobAgentName: string, jobName: string, stepName: string, options?: JobStepsDeleteOptionalParams): Promise<void>
Deletes a job step. This will implicitly create a new job version.
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serverName: string
  
  The name of the server.
- jobAgentName: string
  
  The name of the job agent.
- jobName: string
  
  The name of the job.
- stepName: string
  
  The name of the job step to delete.
- Optional options: JobStepsDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/jobSteps.ts:128

get

get(resourceGroupName: string, serverName: string, jobAgentName: string, jobName: string, stepName: string, options?: JobStepsGetOptionalParams): Promise<JobStep>
Gets a job step in a job's current version.
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serverName: string
  
  The name of the server.
- jobAgentName: string
  
  The name of the job agent.
- jobName: string
  
  The name of the job.
- stepName: string
  
  The name of the job step.
- Optional options: JobStepsGetOptionalParams
  
  The options parameters.
Returns Promise<JobStep>
- Defined in operationsInterfaces/jobSteps.ts:90

getByVersion

getByVersion(resourceGroupName: string, serverName: string, jobAgentName: string, jobName: string, jobVersion: number, stepName: string, options?: JobStepsGetByVersionOptionalParams): Promise<JobStep>
Gets the specified version of a job step.
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serverName: string
  
  The name of the server.
- jobAgentName: string
  
  The name of the job agent.
- jobName: string
  
  The name of the job.
- jobVersion: number
  
  The version of the job to get.
- stepName: string
  
  The name of the job step.
- Optional options: JobStepsGetByVersionOptionalParams
  
  The options parameters.
Returns Promise<JobStep>
- Defined in operationsInterfaces/jobSteps.ts:71

listByJob

listByJob(resourceGroupName: string, serverName: string, jobAgentName: string, jobName: string, options?: JobStepsListByJobOptionalParams): PagedAsyncIterableIterator<JobStep>
Gets all job steps for a job's current version.
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serverName: string
  
  The name of the server.
- jobAgentName: string
  
  The name of the job agent.
- jobName: string
  
  The name of the job to get.
- Optional options: JobStepsListByJobOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<JobStep>
- Defined in operationsInterfaces/jobSteps.ts:53

listByVersion

listByVersion(resourceGroupName: string, serverName: string, jobAgentName: string, jobName: string, jobVersion: number, options?: JobStepsListByVersionOptionalParams): PagedAsyncIterableIterator<JobStep>
Gets all job steps in the specified job version.
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serverName: string
  
  The name of the server.
- jobAgentName: string
  
  The name of the job agent.
- jobName: string
  
  The name of the job to get.
- jobVersion: number
  
  The version of the job to get.
- Optional options: JobStepsListByVersionOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<JobStep>
- Defined in operationsInterfaces/jobSteps.ts:36

Interface JobSteps

Hierarchy

Index

Methods

Methods

createOrUpdate

Parameters

resourceGroupName: string

serverName: string

jobAgentName: string

jobName: string

stepName: string

parameters: JobStep

Optional options: JobStepsCreateOrUpdateOptionalParams

Returns Promise<JobStep>

delete

Parameters

resourceGroupName: string

serverName: string

jobAgentName: string

jobName: string

stepName: string

Optional options: JobStepsDeleteOptionalParams

Returns Promise<void>

get

Parameters

resourceGroupName: string

serverName: string

jobAgentName: string

jobName: string

stepName: string

Optional options: JobStepsGetOptionalParams

Returns Promise<JobStep>

getByVersion

Parameters

resourceGroupName: string

serverName: string

jobAgentName: string

jobName: string

jobVersion: number

stepName: string

Optional options: JobStepsGetByVersionOptionalParams

Returns Promise<JobStep>

listByJob

Parameters

resourceGroupName: string

serverName: string

jobAgentName: string

jobName: string

Optional options: JobStepsListByJobOptionalParams

Returns PagedAsyncIterableIterator<JobStep>

listByVersion

Parameters

resourceGroupName: string

serverName: string

jobAgentName: string

jobName: string

jobVersion: number

Optional options: JobStepsListByVersionOptionalParams

Returns PagedAsyncIterableIterator<JobStep>

Settings

Member Visibility

Theme

`Optional` options: JobStepsCreateOrUpdateOptionalParams

`Optional` options: JobStepsDeleteOptionalParams

`Optional` options: JobStepsGetOptionalParams

`Optional` options: JobStepsGetByVersionOptionalParams

`Optional` options: JobStepsListByJobOptionalParams

`Optional` options: JobStepsListByVersionOptionalParams