Package version:

Interface Jobs

Interface representing a Jobs.

Hierarchy

Jobs

Index

Methods

createOrUpdate delete get listByAgent

Methods

createOrUpdate

createOrUpdate(resourceGroupName: string, serverName: string, jobAgentName: string, jobName: string, parameters: Job, options?: JobsCreateOrUpdateOptionalParams): Promise<Job>
Creates or updates a 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.
- Optional options: JobsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<Job>
- Defined in operationsInterfaces/jobs.ts:63

delete

delete(resourceGroupName: string, serverName: string, jobAgentName: string, jobName: string, options?: JobsDeleteOptionalParams): Promise<void>
Deletes a 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 delete.
- Optional options: JobsDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/jobs.ts:80

get

get(resourceGroupName: string, serverName: string, jobAgentName: string, jobName: string, options?: JobsGetOptionalParams): Promise<Job>
Gets a 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.
- Optional options: JobsGetOptionalParams
  
  The options parameters.
Returns Promise<Job>
- Defined in operationsInterfaces/jobs.ts:46

listByAgent

listByAgent(resourceGroupName: string, serverName: string, jobAgentName: string, options?: JobsListByAgentOptionalParams): PagedAsyncIterableIterator<Job>
Gets a list of jobs.
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: JobsListByAgentOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<Job>
- Defined in operationsInterfaces/jobs.ts:31

Generated using TypeDoc