Package version:

Interface JobExecutions

Interface representing a JobExecutions.

Hierarchy

JobExecutions

Index

Methods

beginCreate beginCreateAndWait beginCreateOrUpdate beginCreateOrUpdateAndWait cancel get listByAgent listByJob

Methods

beginCreate

beginCreate(resourceGroupName: string, serverName: string, jobAgentName: string, jobName: string, options?: JobExecutionsCreateOptionalParams): Promise<SimplePollerLike<OperationState<JobExecution>, JobExecution>>
Starts an elastic job execution.
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: JobExecutionsCreateOptionalParams
  
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<JobExecution>, JobExecution>>
- Defined in operationsInterfaces/jobExecutions.ts:84

beginCreateAndWait

beginCreateAndWait(resourceGroupName: string, serverName: string, jobAgentName: string, jobName: string, options?: JobExecutionsCreateOptionalParams): Promise<JobExecution>
Starts an elastic job execution.
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: JobExecutionsCreateOptionalParams
  
  The options parameters.
Returns Promise<JobExecution>
- Defined in operationsInterfaces/jobExecutions.ts:105

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, serverName: string, jobAgentName: string, jobName: string, jobExecutionId: string, options?: JobExecutionsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<JobExecution>, JobExecution>>
Creates or updates a job execution.
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.
- jobExecutionId: string
  
  The job execution id to create the job execution under.
- Optional options: JobExecutionsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<JobExecution>, JobExecution>>
- Defined in operationsInterfaces/jobExecutions.ts:140

beginCreateOrUpdateAndWait

beginCreateOrUpdateAndWait(resourceGroupName: string, serverName: string, jobAgentName: string, jobName: string, jobExecutionId: string, options?: JobExecutionsCreateOrUpdateOptionalParams): Promise<JobExecution>
Creates or updates a job execution.
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.
- jobExecutionId: string
  
  The job execution id to create the job execution under.
- Optional options: JobExecutionsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<JobExecution>
- Defined in operationsInterfaces/jobExecutions.ts:163

cancel

cancel(resourceGroupName: string, serverName: string, jobAgentName: string, jobName: string, jobExecutionId: string, options?: JobExecutionsCancelOptionalParams): Promise<void>
Requests cancellation of a job execution.
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.
- jobExecutionId: string
  
  The id of the job execution to cancel.
- Optional options: JobExecutionsCancelOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/jobExecutions.ts:67

get

get(resourceGroupName: string, serverName: string, jobAgentName: string, jobName: string, jobExecutionId: string, options?: JobExecutionsGetOptionalParams): Promise<JobExecution>
Gets a job execution.
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.
- jobExecutionId: string
  
  The id of the job execution
- Optional options: JobExecutionsGetOptionalParams
  
  The options parameters.
Returns Promise<JobExecution>
- Defined in operationsInterfaces/jobExecutions.ts:122

listByAgent

listByAgent(resourceGroupName: string, serverName: string, jobAgentName: string, options?: JobExecutionsListByAgentOptionalParams): PagedAsyncIterableIterator<JobExecution>
Lists all executions in a job agent.
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.
- Optional options: JobExecutionsListByAgentOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<JobExecution>
- Defined in operationsInterfaces/jobExecutions.ts:35

listByJob

listByJob(resourceGroupName: string, serverName: string, jobAgentName: string, jobName: string, options?: JobExecutionsListByJobOptionalParams): PagedAsyncIterableIterator<JobExecution>
Lists a job's executions.
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: JobExecutionsListByJobOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<JobExecution>
- Defined in operationsInterfaces/jobExecutions.ts:50

Interface JobExecutions

Hierarchy

Index

Methods

Methods

beginCreate

Parameters

resourceGroupName: string

serverName: string

jobAgentName: string

jobName: string

Optional options: JobExecutionsCreateOptionalParams

Returns Promise<SimplePollerLike<OperationState<JobExecution>, JobExecution>>

beginCreateAndWait

Parameters

resourceGroupName: string

serverName: string

jobAgentName: string

jobName: string

Optional options: JobExecutionsCreateOptionalParams

Returns Promise<JobExecution>

beginCreateOrUpdate

Parameters

resourceGroupName: string

serverName: string

jobAgentName: string

jobName: string

jobExecutionId: string

Optional options: JobExecutionsCreateOrUpdateOptionalParams

Returns Promise<SimplePollerLike<OperationState<JobExecution>, JobExecution>>

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

serverName: string

jobAgentName: string

jobName: string

jobExecutionId: string

Optional options: JobExecutionsCreateOrUpdateOptionalParams

Returns Promise<JobExecution>

cancel

Parameters

resourceGroupName: string

serverName: string

jobAgentName: string

jobName: string

jobExecutionId: string

Optional options: JobExecutionsCancelOptionalParams

Returns Promise<void>

get

Parameters

resourceGroupName: string

serverName: string

jobAgentName: string

jobName: string

jobExecutionId: string

Optional options: JobExecutionsGetOptionalParams

Returns Promise<JobExecution>

listByAgent

Parameters

resourceGroupName: string

serverName: string

jobAgentName: string

Optional options: JobExecutionsListByAgentOptionalParams

Returns PagedAsyncIterableIterator<JobExecution>

listByJob

Parameters

resourceGroupName: string

serverName: string

jobAgentName: string

jobName: string

Optional options: JobExecutionsListByJobOptionalParams

Returns PagedAsyncIterableIterator<JobExecution>

Settings

Member Visibility

Theme

`Optional` options: JobExecutionsCreateOptionalParams

`Optional` options: JobExecutionsCreateOptionalParams

`Optional` options: JobExecutionsCreateOrUpdateOptionalParams

`Optional` options: JobExecutionsCreateOrUpdateOptionalParams

`Optional` options: JobExecutionsCancelOptionalParams

`Optional` options: JobExecutionsGetOptionalParams

`Optional` options: JobExecutionsListByAgentOptionalParams

`Optional` options: JobExecutionsListByJobOptionalParams