< Back

New-AzureRmSchedulerHttpJob

Thu Apr 04, 2019 5:40 am

NAME New-AzureRmSchedulerHttpJob



SYNOPSIS

Creates an HTTP job.





SYNTAX

New-AzureRmSchedulerHttpJob [-DefaultProfile <IAzureContextContainer>] [-EndTime <DateTime>] [-ErrorActionType {Http | Https | StorageQueue |

ServiceBusQueue | ServiceBusTopic}] [-ExecutionCount <Int32>] [-Frequency {Minute | Hour | Day | Week | Month}] [-Headers <Hashtable>]

[-HttpAuthenticationType {None | ClientCertificate | ActiveDirectoryOAuth | Basic}] [-Interval <Int32>] -JobCollectionName <String> -JobName

<String> [-JobState {Enabled | Disabled}] -Method {GET | PUT | POST | DELETE} [-RequestBody <String>] -ResourceGroupName <String> [-StartTime

<DateTime>] -Uri <Uri> [-Confirm] [-WhatIf] [<CommonParameters>]





DESCRIPTION

The New-AzureRmSchedulerHttpJob cmdlet creates an HTTP job in Azure Scheduler.



This cmdlet supports dynamic parameters based on the ErrorActionType and HttpAuthenticationType parameters. 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.





PARAMETERS

-DefaultProfile <IAzureContextContainer>

The credentials, account, tenant, and subscription used for communication with azure.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-EndTime <DateTime>

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



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-ErrorActionType <String>

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



- Http



- Https



- StorageQueue



- ServiceBusQueue



- ServiceBusTopic



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-ExecutionCount <Int32>

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



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Frequency <String>

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



- Minute



- Hour



- Day



- Week



- Month



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Headers <Hashtable>

Specifies a hash table that contains headers.



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-HttpAuthenticationType <String>

Specifies the HTTP authentication type. The acceptable values for this parameter are:



- None



- ClientCertificate



- ActiveDirectoryOAuth



- Basic



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Interval <Int32>

Specifies an interval of recurrence for the job.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-JobCollectionName <String>

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



Required? true

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-JobName <String>

Specifies a name for the job.



Required? true

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-JobState <String>

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



- Enabled



- Disabled



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Method <String>

Specifies the method for the action types for the job. The acceptable values for this parameter are:



- GET



- PUT



- POST



- DELETE



Required? true

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-RequestBody <String>

Specifies the value of the body for PUT and POST job actions.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-ResourceGroupName <String>

Specifies the resource group to which the job belongs.



Required? true

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-StartTime <DateTime>

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



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Uri <Uri>

Specifies a URI for the job action.



Required? true

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Confirm [<SwitchParameter>]

Prompts you for confirmation before running the cmdlet.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]

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



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

None

This cmdlet does not accept any input.





OUTPUTS

Microsoft.Azure.Commands.Scheduler.Models.PSSchedulerJobDefinition







NOTES









1:















RELATED LINKS

Online Version: https://docs.microsoft.com/en-us/powers ... lerhttpjob

New-AzureRmSchedulerJobCollection

New-AzureRmSchedulerServiceBusQueueJob

New-AzureRmSchedulerServiceBusTopicJob

New-AzureRmSchedulerStorageQueueJob

Set-AzureRmSchedulerHttpJob

Set-AzureRmSchedulerJobCollection

Set-AzureRmSchedulerServiceBusQueueJob

Set-AzureRmSchedulerServiceBusTopicJob

Set-AzureRmSchedulerStorageQueueJob