Set-AzureSchedulerHttpJob
Updates a scheduler job that has an HTTP 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
Set-AzureSchedulerHttpJob
-Location <String>
-JobCollectionName <String>
-JobName <String>
[-Method <String>]
[-URI <Uri>]
[-RequestBody <String>]
[-StartTime <DateTime>]
[-Interval <Int32>]
[-Frequency <String>]
[-ExecutionCount <Int32>]
[-EndTime <DateTime>]
[-JobState <String>]
[-Headers <Hashtable>]
[-ErrorActionMethod <String>]
[-ErrorActionURI <Uri>]
[-ErrorActionRequestBody <String>]
[-ErrorActionHeaders <Hashtable>]
[-ErrorActionStorageAccount <String>]
[-ErrorActionStorageQueue <String>]
[-ErrorActionSASToken <String>]
[-ErrorActionQueueMessageBody <String>]
[-HttpAuthenticationType <String>]
[-ClientCertificatePfx <Object>]
[-ClientCertificatePassword <String>]
[-PassThru]
[-Profile <AzureSMProfile>]
[<CommonParameters>] Set-AzureSchedulerHttpJob
[-RequestBody <String>]
[-JobState <String>]
[-Headers <Hashtable>]
[-ErrorActionHeaders <Hashtable>]
[-PassThru]
[-Profile <AzureSMProfile>]
[<CommonParameters>] Set-AzureSchedulerHttpJob
[-Interval <Int32>]
[-Frequency <String>]
[-ExecutionCount <Int32>]
[-EndTime <DateTime>]
[-JobState <String>]
[-Headers <Hashtable>]
[-ErrorActionHeaders <Hashtable>]
[-PassThru]
[-Profile <AzureSMProfile>]
[<CommonParameters>] Set-AzureSchedulerHttpJob
[-JobState <String>]
[-Headers <Hashtable>]
[-ErrorActionHeaders <Hashtable>]
-HttpAuthenticationType <String>
[-ClientCertificatePfx <Object>]
[-ClientCertificatePassword <String>]
[-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-AzureSchedulerHttpJob cmdlet updates a scheduler job that has an HTTP action.
Examples
Example 1: Change the state of a job to Disabled
PS C:\> Set-AzureSchedulerHttpJob -Location "North Central US" -JobCollectionName "JobCollection01" -JobName "Job01" -JobState "Disabled"This command changes the state of the job named Job01 to Disabled. That job is part of the job collection named JobColleciton01 for the specified location.
Example 2: Update the URI of a job
PS C:\> Set-AzureSchedulerHttpJob -Location "North Central US" -JobCollectionName "JobCollection02" -JobName "Job37" -URI http://www.contoso.comThis command updates the URI of the job named Job01 to be http://www.contoso.com.
Parameters
-ClientCertificatePassword
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ClientCertificatePfx
| Type: | Object |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-EndTime
Specifies a time, as a DateTime object, for the scheduler to stop initiating jobs.
To obtain a DateTime object, use the Get-Date cmdlet.
For more information, type Get-Help Get-Date.
| Type: | DateTime |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ErrorActionHeaders
Specifies headers as a hashtable.
| Type: | Hashtable |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ErrorActionMethod
Specifies the method for HTTP and HTTPS action types. Valid values are:
- GET
- PUT
- POST
- HEAD
- DELETE
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ErrorActionQueueMessageBody
Specifies the body for storage job actions.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ErrorActionRequestBody
Specifies the body for PUT and POST job actions.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ErrorActionSASToken
Specifies the Shared Access Signature (SAS) token for the storage queue.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ErrorActionStorageAccount
Specifies the name of the storage account.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ErrorActionStorageQueue
Specifies the name of the storage queue.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ErrorActionURI
Specifies the URI for the error job action.
| Type: | Uri |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ExecutionCount
Specifies the number occurrences of a job that run. By default, a job recurs indefinitely.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Frequency
Specifies the maximum frequency for this scheduler job.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Headers
Specifies the headers as a hash table.
| Type: | Hashtable |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-HttpAuthenticationType
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Interval
Specifies the interval of recurrence at the frequency specified by using the Frequency parameter.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-JobCollectionName
Specifies the name of the collection that contains the scheduler job to modify.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-JobName
Specifies the name of scheduler job to modify.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-JobState
Specifies the state for the scheduler job.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | 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
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Method
Specifies the method for HTTP and HTTPS action types. Valid values are:
- GET
- PUT
- POST
- HEAD
- DELETE
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| 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.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | 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.
| Type: | AzureSMProfile |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-RequestBody
Specifies the body for PUT and POST job actions.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-StartTime
Specifies a time, as a DateTime object, for the job to start.
| Type: | DateTime |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-URI
Specifies a URI for a job action.
| Type: | Uri |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |