JobExecutions interface

  • Reference
Package:
@azure/arm-sql

Interface representing a JobExecutions.

Methods

beginCreate(string, string, string, string, JobExecutionsCreateOptionalParams)

Starts an elastic job execution.
beginCreateAndWait(string, string, string, string, JobExecutionsCreateOptionalParams)

Starts an elastic job execution.
beginCreateOrUpdate(string, string, string, string, string, JobExecutionsCreateOrUpdateOptionalParams)

Creates or updates a job execution.
beginCreateOrUpdateAndWait(string, string, string, string, string, JobExecutionsCreateOrUpdateOptionalParams)

Creates or updates a job execution.
cancel(string, string, string, string, string, JobExecutionsCancelOptionalParams)

Requests cancellation of a job execution.
get(string, string, string, string, string, JobExecutionsGetOptionalParams)

Gets a job execution.
listByAgent(string, string, string, JobExecutionsListByAgentOptionalParams)

Lists all executions in a job agent.
listByJob(string, string, string, string, JobExecutionsListByJobOptionalParams)

Lists a job's executions.

Method Details

beginCreate(string, string, string, string, JobExecutionsCreateOptionalParams)

Starts an elastic job execution.

function beginCreate(resourceGroupName: string, serverName: string, jobAgentName: string, jobName: string, options?: JobExecutionsCreateOptionalParams): Promise<SimplePollerLike<OperationState<JobExecution>, JobExecution>>

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.

options
JobExecutionsCreateOptionalParams

The options parameters.

Returns

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

beginCreateAndWait(string, string, string, string, JobExecutionsCreateOptionalParams)

Starts an elastic job execution.

function beginCreateAndWait(resourceGroupName: string, serverName: string, jobAgentName: string, jobName: string, options?: JobExecutionsCreateOptionalParams): Promise<JobExecution>

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.

options
JobExecutionsCreateOptionalParams

The options parameters.

Returns

Promise<JobExecution>

beginCreateOrUpdate(string, string, string, string, string, JobExecutionsCreateOrUpdateOptionalParams)

Creates or updates a job execution.

function beginCreateOrUpdate(resourceGroupName: string, serverName: string, jobAgentName: string, jobName: string, jobExecutionId: string, options?: JobExecutionsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<JobExecution>, JobExecution>>

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.

options
JobExecutionsCreateOrUpdateOptionalParams

The options parameters.

Returns

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

beginCreateOrUpdateAndWait(string, string, string, string, string, JobExecutionsCreateOrUpdateOptionalParams)

Creates or updates a job execution.

function beginCreateOrUpdateAndWait(resourceGroupName: string, serverName: string, jobAgentName: string, jobName: string, jobExecutionId: string, options?: JobExecutionsCreateOrUpdateOptionalParams): Promise<JobExecution>

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.

options
JobExecutionsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<JobExecution>

cancel(string, string, string, string, string, JobExecutionsCancelOptionalParams)

Requests cancellation of a job execution.

function cancel(resourceGroupName: string, serverName: string, jobAgentName: string, jobName: string, jobExecutionId: string, options?: JobExecutionsCancelOptionalParams): Promise<void>

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.

options
JobExecutionsCancelOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, string, string, JobExecutionsGetOptionalParams)

Gets a job execution.

function get(resourceGroupName: string, serverName: string, jobAgentName: string, jobName: string, jobExecutionId: string, options?: JobExecutionsGetOptionalParams): Promise<JobExecution>

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

options
JobExecutionsGetOptionalParams

The options parameters.

Returns

Promise<JobExecution>

listByAgent(string, string, string, JobExecutionsListByAgentOptionalParams)

Lists all executions in a job agent.

function listByAgent(resourceGroupName: string, serverName: string, jobAgentName: string, options?: JobExecutionsListByAgentOptionalParams): PagedAsyncIterableIterator<JobExecution, JobExecution[], PageSettings>

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.

options
JobExecutionsListByAgentOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<JobExecution, JobExecution[], PageSettings>

listByJob(string, string, string, string, JobExecutionsListByJobOptionalParams)

Lists a job's executions.

function listByJob(resourceGroupName: string, serverName: string, jobAgentName: string, jobName: string, options?: JobExecutionsListByJobOptionalParams): PagedAsyncIterableIterator<JobExecution, JobExecution[], PageSettings>

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.

options
JobExecutionsListByJobOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<JobExecution, JobExecution[], PageSettings>