Set-AzureSqlJobExecutionPolicy

  • Reference
Module:
ElasticDatabaseJobs

Sets a job execution policy.

Syntax

Set-AzureSqlJobExecutionPolicy
   -ExecutionPolicyName <String[]>
   [-JobExecutionTimeout <TimeSpan>]
   [-InitialRetryInterval <TimeSpan>]
   [-RetryIntervalBackoffCoefficient <Single>]
   [-MaximumRetryInterval <TimeSpan>]
   [-MaximumAttempts <Int32>]
   [[-AzureSqlJobConnection] <AzureSqlJobConnection>]
   [<CommonParameters>]

Description

The Set-AzureSqlJobExecutionPolicy cmdlet sets a job execution policy.

Examples

Example 1: Update an existing execution policy

PS C:\>Set-AzureSqlJobExecutionPolicy -ExecutionPolicyName myCustomExecutionPolicyName -JobExecutionTimeout ([System.TimeSpan]::FromHours(2))
ExecutionPolicyName             : myCustomExecutionPolicyName
JobExecutionTimeout             : 02:00:00
InitialRetryInterval            : 00:00:01
RetryIntervalBackoffCoefficient : 1
MaximumRetryInterval            : 00:00:30
MaximumAttempts                 : 100

This command updates an existing execution policy.

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

-ExecutionPolicyName

Specifies the execution policy name.

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

-InitialRetryInterval

Specifies the time interval to use between job tasks following a job task execution failure.

Type:TimeSpan
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-JobExecutionTimeout

Specifies the timeout to enforce for overall job time.

Type:TimeSpan
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-MaximumAttempts

Specifies the total number of job task execution retry attempts within a job.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-MaximumRetryInterval

Specifies the maximum time to allow to pass between retry attempts.

Type:TimeSpan
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-RetryIntervalBackoffCoefficient

Specifies the coefficient used to calculate the next interval between retries. The following formula is used: (Initial Retry Interval) * Math.pow((Interval Backoff Coefficient), (Number of Retries) - 2).

Type:Single
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False