Remove-AzureSqlJob

  • Reference
Module:
ElasticDatabaseJobs

Removes a job and its job run history from the system.

Syntax

Remove-AzureSqlJob
      -JobName <String[]>
      [[-AzureSqlJobConnection] <AzureSqlJobConnection>]
      [<CommonParameters>]

Description

The Remove-AzureSqlJob cmdlet removes a job and its job run history from the system.

Job and job run history deletion takes place asynchronously. Any active jobs will not be automatically canceled by the system. If you want to cancel an active job, use the Stop-AzureSqlJobExecution cmdlet. The job and job execution history will be deleted following the completion of any active job executions of the job.

Examples

Example 1: Remove a job and its job execution history

PS C:\>Remove-AzureSqlJob -JobName "MyJob"

This command removes the job named MyJob and its job execution history.

Parameters

-AzureSqlJobConnection

Specifies the connection state object for the job. You can get the connection state object through the New-AzureSqlJobConnection cmdlet. If you do not specify this parameter, the connection state is used from a prior call to the Use-AzureSqlJobConnection cmdlet.

Type:AzureSqlJobConnection
Position:1
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-JobName

Specifies the name of the job.

Type:String[]
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False