New-AzureRmSchedulerHttpJob

Reference

Module:: AzureRM.Scheduler

Creates an HTTP job.

Warning

The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.

Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.

Syntax

New-AzureRmSchedulerHttpJob
   -ResourceGroupName <String>
   -JobCollectionName <String>
   -JobName <String>
   -Method <String>
   -Uri <Uri>
   [-RequestBody <String>]
   [-Headers <Hashtable>]
   [-HttpAuthenticationType <String>]
   [-StartTime <DateTime>]
   [-Interval <Int32>]
   [-Frequency <String>]
   [-EndTime <DateTime>]
   [-ExecutionCount <Int32>]
   [-JobState <String>]
   [-ErrorActionType <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<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

-Confirm

Prompts you for confirmation before running the cmdlet.

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

-DefaultProfile

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

Type:	IAzureContextContainer
Aliases:	AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Required:	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:	Nullable<T>[DateTime]
Position:	Named
Default value:	None
Required:	False
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
Accepted values:	Http, Https, StorageQueue, ServiceBusQueue, ServiceBusTopic
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-ExecutionCount

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

Type:	Nullable<T>[Int32]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Frequency

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

Minute
Hour
Day
Week
Month

Type:	String
Accepted values:	Minute, Hour, Day, Week, Month
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Headers

Specifies a hash table that contains headers.

Type:	Hashtable
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-HttpAuthenticationType

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

None
ClientCertificate
ActiveDirectoryOAuth
Basic

Type:	String
Accepted values:	None, ClientCertificate, ActiveDirectoryOAuth, Basic
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Interval

Specifies an interval of recurrence for the job.

Type:	Nullable<T>[Int32]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-JobCollectionName

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

Type:	String
Aliases:	Name, ResourceName
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-JobName

Specifies a name for the job.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-JobState

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

Enabled
Disabled

Type:	String
Accepted values:	Enabled, Disabled
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-Method

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

GET
PUT
POST
DELETE

Type:	String
Accepted values:	GET, PUT, POST, DELETE
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-RequestBody

Specifies the value of 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

-ResourceGroupName

Specifies the resource group to which the job belongs.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-StartTime

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

Type:	Nullable<T>[DateTime]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Uri

Specifies a URI for the job action.

Type:	Uri
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
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
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

String

Hashtable

Outputs

PSSchedulerJobDefinition