Edit

Share via

Set-AzureSchedulerStorageQueueJob

Module:
Azure Module

Updates a scheduler job that has a storage action.

Note

The cmdlets referenced in this documentation are for managing legacy Azure resources that use Azure Service Manager (ASM) APIs. This legacy PowerShell module isn't recommended when creating new resources since ASM is scheduled for retirement. For more information, see Azure Service Manager retirement.

The Az PowerShell module is the recommended PowerShell module for managing Azure Resource Manager (ARM) resources with PowerShell.

Syntax

Required 

Set-AzureSchedulerStorageQueueJob
    -Location <String>
    -JobCollectionName <String>
    -JobName <String>
    [-StorageQueueAccount <String>]
    [-StorageQueueName <String>]
    [-SASToken <String>]
    [-StorageQueueMessage <String>]
    [-StartTime <DateTime>]
    [-Interval <Int32>]
    [-Frequency <String>]
    [-EndTime <DateTime>]
    [-ExecutionCount <Int32>]
    [-JobState <String>]
    [-ErrorActionMethod <String>]
    [-ErrorActionURI <Uri>]
    [-ErrorActionRequestBody <String>]
    [-ErrorActionHeaders <Hashtable>]
    [-ErrorActionStorageAccount <String>]
    [-ErrorActionStorageQueue <String>]
    [-ErrorActionSASToken <String>]
    [-ErrorActionQueueMessageBody <String>]
    [-PassThru]
    [-Profile <AzureSMProfile>]
    [<CommonParameters>]

Recurring 

Set-AzureSchedulerStorageQueueJob
    [-Interval <Int32>]
    [-Frequency <String>]
    [-EndTime <DateTime>]
    [-ExecutionCount <Int32>]
    [-JobState <String>]
    [-ErrorActionHeaders <Hashtable>]
    [-PassThru]
    [-Profile <AzureSMProfile>]
    [<CommonParameters>]

Description

This topic describes the cmdlet in the 0.8.10 version of the Microsoft Azure PowerShell module. To get the version of the module you're using, in the Azure PowerShell console, type (Get-Module -Name Azure).Version.

The Set-AzureSchedulerStorageQueueJob cmdlet updates a scheduler job that has an Azure Storage action.

Examples

Example 1: Update a Storage queue message

PS C:\> Set-AzureSchedulerStorageQueueJob -Location "North Central US" -JobCollectionName "JobCollection01 -JobName "Job12" -StorageQueueMessage "Updated message"

This command updates the queue message for the Storage job named Job12. The command specifies the job collection name and the location.

Example 2: Enable a Storage queue job

PS C:\> Set-AzureSchedulerStorageQueueJob -Location "North Central US" -JobCollectionName "JobCollection02" -JobName "Job16" -JobState "Enabled"

This command enables the job named Job16. The command changes the state of the job to Enabled by specifying that value for the JobState parameter.

Parameters

-EndTime

Specifies a time, as a DateTime object, for the scheduler to stop initiating the job. To obtain a DateTime object, use the Get-Date cmdlet. For more information, type Get-Help Get-Date.

Parameter properties

Type:DateTime
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ErrorActionHeaders

Specifies headers as a hash table.

Parameter properties

Type:Hashtable
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-ErrorActionMethod

Specifies the method for HTTP and HTTPS action types. Valid values are:

  • GET
  • PUT
  • POST
  • HEAD
  • DELETE

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Required
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ErrorActionQueueMessageBody

Specifies the body for Storage job actions.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Required
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ErrorActionRequestBody

Specifies the body for PUT and POST job actions.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Required
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ErrorActionSASToken

Specifies the Shared Access Signature (SAS) token for the Storage queue.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Required
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-ErrorActionStorageAccount

Specifies the name of the Storage account.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Required
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-ErrorActionStorageQueue

Specifies the name of the Storage queue.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Required
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-ErrorActionURI

Specifies the URI for the error job action.

Parameter properties

Type:Uri
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Required
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ExecutionCount

Specifies the number occurrences of a job that run. By default, a job recurs indefinitely.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Frequency

Specifies the maximum frequency for this scheduler job.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Interval

Specifies the interval of recurrence at the frequency specified by using the Frequency parameter.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-JobCollectionName

Specifies the name of the collection to contain the scheduler job.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Required
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-JobName

Specifies the name of the scheduler job to update.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Required
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-JobState

Specifies the state for the scheduler job.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-Location

Specifies the name of the location that hosts the cloud service. Valid values are:

  • Anywhere Asia
  • Anywhere Europe
  • Anywhere US
  • East Asia
  • East US
  • North Central US
  • North Europe
  • South Central US
  • Southeast Asia
  • West Europe
  • West US

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Required
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PassThru

Indicates that this cmdlet returns an object representing the item on which it operates. By default, this cmdlet does not generate any output.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Profile

Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.

Parameter properties

Type:AzureSMProfile
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SASToken

Specifies the SAS token for the Storage queue.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Required
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-StartTime

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

Parameter properties

Type:DateTime
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Required
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-StorageQueueAccount

Specifies the Storage account name.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Required
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-StorageQueueMessage

Specifies the queue message for the Storage job.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Required
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-StorageQueueName

Specifies the name of the Storage queue.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Required
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.