SALES: 1-800-867-1380
Expand Minimize

Set-AzureSchedulerStorageQueueJob

[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]

Set-AzureSchedulerStorageQueueJob

Updates a scheduler job that has a storage action.

Syntax

Parameter Set: Recurring
Set-AzureSchedulerStorageQueueJob [[-Interval] <Int32> ] [[-Frequency] <String> ] [[-EndTime] <DateTime> ] [[-ExecutionCount] <Int32> ] [[-JobState] <String> ] [[-ErrorActionHeaders] <Hashtable> ] [-PassThru] [ <CommonParameters>]

Parameter Set: 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] [ <CommonParameters>]




Detailed Description

This topic describes the cmdlet in the 0.8.7 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.

Parameters

-EndTime<DateTime>

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.


Aliases

none

Required?

false

Position?

12

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ErrorActionHeaders<Hashtable>

Specifies headers as a hash table.


Aliases

none

Required?

false

Position?

18

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-ErrorActionMethod<String>

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

-- GET
-- PUT
-- POST
-- HEAD
-- DELETE


Aliases

none

Required?

false

Position?

15

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ErrorActionQueueMessageBody<String>

Specifies the body for Storage job actions.


Aliases

none

Required?

false

Position?

22

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ErrorActionRequestBody<String>

Specifies the body for PUT and POST job actions.


Aliases

none

Required?

false

Position?

17

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ErrorActionSASToken<String>

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


Aliases

none

Required?

false

Position?

21

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-ErrorActionStorageAccount<String>

Specifies the name of the Storage account.


Aliases

none

Required?

false

Position?

19

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-ErrorActionStorageQueue<String>

Specifies the name of the Storage queue.


Aliases

none

Required?

false

Position?

20

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-ErrorActionURI<Uri>

Specifies the URI for the error job action.


Aliases

none

Required?

false

Position?

16

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ExecutionCount<Int32>

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


Aliases

none

Required?

false

Position?

13

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Frequency<String>

Specifies the maximum frequency for this scheduler job.


Aliases

none

Required?

false

Position?

11

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Interval<Int32>

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


Aliases

none

Required?

false

Position?

10

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-JobCollectionName<String>

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


Aliases

none

Required?

true

Position?

2

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-JobName<String>

Specifies the name of the scheduler job to update.


Aliases

none

Required?

true

Position?

3

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-JobState<String>

Specifies the state for the scheduler job.


Aliases

none

Required?

false

Position?

14

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Location<String>

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


Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-SASToken<String>

Specifies the SAS token for the Storage queue.


Aliases

none

Required?

false

Position?

6

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-StartTime<DateTime>

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


Aliases

none

Required?

false

Position?

9

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-StorageQueueAccount<String>

Specifies the Storage account name.


Aliases

none

Required?

false

Position?

4

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-StorageQueueMessage<String>

Specifies the queue message for the Storage job.


Aliases

none

Required?

false

Position?

7

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-StorageQueueName<String>

Specifies the name of the Storage queue.


Aliases

none

Required?

false

Position?

5

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see  about_CommonParameters (http://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

Examples

Example 1: Update a Storage queue message

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


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

Example 2: Enable a Storage queue job

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.


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

Related topics

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft