Set-​Azure​Rm​Scheduler​Storage​Queue​Job

Modifies a storage queue job.

Syntax

Set-AzureRmSchedulerStorageQueueJob
   -ResourceGroupName <String>
   -JobCollectionName <String>
   -JobName <String>
   [-StorageQueueAccount <String>]
   [-StorageQueueName <String>]
   [-StorageSASToken <String>]
   [-StorageQueueMessage <String>]
   [-StartTime <DateTime>]
   [-Interval <Int32>]
   [-Frequency <String>]
   [-EndTime <DateTime>]
   [-ExecutionCount <Int32>]
   [-JobState <String>]
   [-ErrorActionType <String>]
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Set-AzureRmSchedulerStorageQueueJob cmdlet modifies a storage queue job in Azure Scheduler.

This cmdlet supports dynamic parameters based on the ErrorActionType parameter. Dynamic parameters become available based on other parameter values.

To discover the names of dynamic parameters after you specify the other parameters, type a hyphen (-), and then press the Tab key repeatedly to cycle through the available parameters. If you omit a required parameter, the cmdlet prompts you for the value.

Examples

1:

Required Parameters

-JobCollectionName

Specifies the name of the job collection to which the job belongs.

Type:String
Aliases:Name, ResourceName
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-JobName

Specifies the name of the job that this cmdlet modifies.

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-ResourceGroupName

Specifies the resource group to which the job belongs.

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Optional Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False
-EndTime

Specifies an end time, as a DateTime object, for the job. To obtain a DateTime object, use the Get-Date cmdlet.

Type:DateTime
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ErrorActionType

Specifies an error action setting for the job. The acceptable values for this parameter are:- Http

  • Https
  • StorageQueue
  • ServiceBusQueue
  • ServiceBusTopic
Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-ExecutionCount

Specifies how many times the job runs. By default, a job recurs indefinitely.

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

Specifies a frequency for the job. The acceptable values for this parameter are:- Minute

  • Hour
  • Day
  • Week
  • Month
Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-InformationAction

Specifies how this cmdlet responds to an information event.The acceptable values for this parameter are:- Continue

  • Ignore
  • Inquire
  • SilentlyContinue
  • Stop
  • Suspend
Type:ActionPreference
Aliases:infa
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-InformationVariable

Specifies an information variable.

Type:String
Aliases:iv
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Interval

Specifies an interval of recurrence for the job.

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

Specifies the state of the job. The acceptable values for this parameter are:- Enabled

  • Disabled
Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-StartTime

Specifies the start time, as a DateTime object, for the job.

Type:DateTime
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-StorageQueueAccount

Specifies a storage account name.

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-StorageQueueMessage

Specifies a queue message for storage job.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-StorageQueueName

Specifies a storage queue name.

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-StorageSASToken

Specifies a shared access signature token for a storage queue.

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False