Skip to content

Latest commit

 

History

History
373 lines (293 loc) · 8.13 KB

New-AzureRmSchedulerHttpJob.md

File metadata and controls

373 lines (293 loc) · 8.13 KB
Raw
external help file Module Name ms.assetid online version schema
Microsoft.Azure.Commands.Scheduler.dll-Help.xml
AzureRM.Scheduler
E00D42D6-707A-479E-9964-C5B80D3DAA6A
2.0.0

New-AzureRmSchedulerHttpJob

SYNOPSIS

Creates an HTTP job.

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.

EXAMPLES

PARAMETERS

-DefaultProfile

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

Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer
Parameter Sets: (All)
Aliases: AzureRmContext, AzureCredential

Required: False
Position: Named
Default value: None
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: System.Nullable`1[System.DateTime]
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
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: System.String
Parameter Sets: (All)
Aliases:
Accepted values: Http, Https, StorageQueue, ServiceBusQueue, ServiceBusTopic

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-ExecutionCount

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

Type: System.Nullable`1[System.Int32]
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
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: System.String
Parameter Sets: (All)
Aliases:
Accepted values: Minute, Hour, Day, Week, Month

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

-Headers

Specifies a hash table that contains headers.

Type: System.Collections.Hashtable
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-HttpAuthenticationType

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

  • None
  • ClientCertificate
  • ActiveDirectoryOAuth
  • Basic
Type: System.String
Parameter Sets: (All)
Aliases:
Accepted values: None, ClientCertificate, ActiveDirectoryOAuth, Basic

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

-Interval

Specifies an interval of recurrence for the job.

Type: System.Nullable`1[System.Int32]
Parameter Sets: (All)
Aliases:

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

-JobCollectionName

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

Type: System.String
Parameter Sets: (All)
Aliases: Name, ResourceName

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-JobName

Specifies a name for the job.

Type: System.String
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-JobState

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

  • Enabled
  • Disabled
Type: System.String
Parameter Sets: (All)
Aliases:
Accepted values: Enabled, Disabled

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
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: System.String
Parameter Sets: (All)
Aliases:
Accepted values: GET, PUT, POST, DELETE

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

-RequestBody

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

Type: System.String
Parameter Sets: (All)
Aliases:

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

-ResourceGroupName

Specifies the resource group to which the job belongs.

Type: System.String
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-StartTime

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

Type: System.Nullable`1[System.DateTime]
Parameter Sets: (All)
Aliases:

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

-Uri

Specifies a URI for the job action.

Type: System.Uri
Parameter Sets: (All)
Aliases:

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

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

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

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

INPUTS

System.String

System.Collections.Hashtable

OUTPUTS

Microsoft.Azure.Commands.Scheduler.Models.PSSchedulerJobDefinition

NOTES

RELATED LINKS

New-AzureRmSchedulerJobCollection

New-AzureRmSchedulerServiceBusQueueJob

New-AzureRmSchedulerServiceBusTopicJob

New-AzureRmSchedulerStorageQueueJob

Set-AzureRmSchedulerHttpJob

Set-AzureRmSchedulerJobCollection

Set-AzureRmSchedulerServiceBusQueueJob

Set-AzureRmSchedulerServiceBusTopicJob

Set-AzureRmSchedulerStorageQueueJob