Compartir a través de

Jobs interface

  • Reference
Package:
@azure/arm-sql

Interface representing a Jobs.

Methods

createOrUpdate(string, string, string, string, Job, JobsCreateOrUpdateOptionalParams)

Creates or updates a job.
delete(string, string, string, string, JobsDeleteOptionalParams)

Deletes a job.
get(string, string, string, string, JobsGetOptionalParams)

Gets a job.
listByAgent(string, string, string, JobsListByAgentOptionalParams)

Gets a list of jobs.

Method Details

createOrUpdate(string, string, string, string, Job, JobsCreateOrUpdateOptionalParams)

Creates or updates a job.

function createOrUpdate(resourceGroupName: string, serverName: string, jobAgentName: string, jobName: string, parameters: Job, options?: JobsCreateOrUpdateOptionalParams): Promise<Job>

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.

parameters
Job

The requested job state.

options
JobsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<Job>

delete(string, string, string, string, JobsDeleteOptionalParams)

Deletes a job.

function delete(resourceGroupName: string, serverName: string, jobAgentName: string, jobName: string, options?: JobsDeleteOptionalParams): 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 to delete.

options
JobsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, string, JobsGetOptionalParams)

Gets a job.

function get(resourceGroupName: string, serverName: string, jobAgentName: string, jobName: string, options?: JobsGetOptionalParams): Promise<Job>

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
JobsGetOptionalParams

The options parameters.

Returns

Promise<Job>

listByAgent(string, string, string, JobsListByAgentOptionalParams)

Gets a list of jobs.

function listByAgent(resourceGroupName: string, serverName: string, jobAgentName: string, options?: JobsListByAgentOptionalParams): PagedAsyncIterableIterator<Job, Job[], 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
JobsListByAgentOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Job, Job[], PageSettings>