New-AzureRmAutomationSchedule
Syntax
New-AzureRmAutomationSchedule
[-ResourceGroupName] <String>
[-AutomationAccountName] <String>
[-Name] <String>
[-StartTime] <DateTimeOffset>
-DayInterval <Byte>
[-Description <String>]
[-ExpiryTime <DateTimeOffset>]
[-TimeZone <String>]
[<CommonParameters>]
New-AzureRmAutomationSchedule
[-ResourceGroupName] <String>
[-AutomationAccountName] <String>
[-Name] <String>
[-StartTime] <DateTimeOffset>
[-DayOfWeek <DayOfWeek>]
[-DayOfWeekOccurrence <DayOfWeekOccurrence>]
[-Description <String>]
[-ExpiryTime <DateTimeOffset>]
-MonthInterval <Byte>
[-TimeZone <String>]
[<CommonParameters>]
New-AzureRmAutomationSchedule
[-ResourceGroupName] <String>
[-AutomationAccountName] <String>
[-Name] <String>
[-StartTime] <DateTimeOffset>
[-DaysOfMonth <DaysOfMonth[]>]
[-Description <String>]
[-ExpiryTime <DateTimeOffset>]
-MonthInterval <Byte>
[-TimeZone <String>]
[<CommonParameters>]
New-AzureRmAutomationSchedule
[-ResourceGroupName] <String>
[-AutomationAccountName] <String>
[-Name] <String>
[-StartTime] <DateTimeOffset>
[-DaysOfWeek <DayOfWeek[]>]
[-Description <String>]
[-ExpiryTime <DateTimeOffset>]
[-TimeZone <String>]
-WeekInterval <Byte>
[<CommonParameters>]
New-AzureRmAutomationSchedule
[-ResourceGroupName] <String>
[-AutomationAccountName] <String>
[-Name] <String>
[-StartTime] <DateTimeOffset>
[-Description <String>]
[-ExpiryTime <DateTimeOffset>]
-HourInterval <Byte>
[-TimeZone <String>]
[<CommonParameters>]
New-AzureRmAutomationSchedule
[-ResourceGroupName] <String>
[-AutomationAccountName] <String>
[-Name] <String>
[-StartTime] <DateTimeOffset>
[-Description <String>]
[-OneTime]
[-TimeZone <String>]
[<CommonParameters>]
Description
The New-AzureRmAutomationSchedule cmdlet creates a schedule in Azure Automation.
Examples
Example 1: Create a one-time schedule in local time
PS C:\>$TimeZone = ([System.TimeZoneInfo]::Local)Id
PS C:\> New-AzureRmAutomationSchedule -AutomationAccountName "Contoso17" -Name "Schedule01" -StartTime "23:00" -OneTime -ResourceGroupName "ResourceGroup01" -TimeZone $TimeZone
The first command gets the time zone ID from the system and stores it in the $TimeZone variable. The second command creates a schedule that runs one time on the current date at 11:00 PM in the specified time zone..
Example 2: Create a recurring schedule
PS C:\>$StartTime = Get-Date "13:00:00"
PS C:\> $EndTime = $StartTime.AddYears(1)
PS C:\> New-AzureRmAutomationSchedule -AutomationAccountName "Contoso17" -Name "Schedule02" -StartTime $StartTime -ExpiryTime $EndTime -DailyInterval 1 -ResourceGroupName "ResourceGroup01"
The first command creates a date object by using the Get-Date cmdlet, and then stores the object in the $StartDate variable. Specify a time that is at least five minutes in the future.
The second command creates a date object by using the Get-Date cmdlet, and then stores the object in the $EndDate variable. The command specifies a future time.
The final command creates a daily schedule named Schedule01 to begin at the time stored in $StartDate and expire at the time stored in $EndDate.
Required Parameters
Specifies the name of an Automation account for which this cmdlet creates a schedule.
| Type: | String |
| Position: | 1 |
| Default value: | None |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | False |
Specifies an interval, in days, for the schedule. If you do not specify this parameter, and you do not specify the OneTime parameter, the default value is one (1).
| Type: | Byte |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Specifies an interval, in hours, for the schedule.
| Type: | Byte |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Specifies an interval, in Months, for the schedule.
| Type: | Byte |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Specifies a name for the schedule.
| Type: | String |
| Position: | 2 |
| Default value: | None |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | False |
Specifies that the cmdlet creates a one-time schedule.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Specifies the name of a resource group for which this cmdlet creates a schedule.
| Type: | String |
| Position: | 0 |
| Default value: | None |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | False |
Specifies the start time of a schedule as a DateTimeOffset object. You can specify a string that can be converted to a valid DateTimeOffset. . If the TimeZone parameter is specified, the offset will be ignored and the time zone specified is used.
| Type: | DateTimeOffset |
| Position: | 3 |
| Default value: | None |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | False |
Specifies an interval, in weeks, for the schedule.
| Type: | Byte |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Optional Parameters
Specifies a list of days of the week for the weekly schedule.
| Type: | DayOfWeek |
| Parameter Sets: | Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Specifies the occurrence of the week within the month that the schedule runs. psdx_paramvalues
- 1
- 2
- 3
- 4
- -1
- First
- Second
- Third
- Fourth
- LastDay
| Type: | DayOfWeekOccurrence |
| Parameter Sets: | First, Second, Third, Fourth, Last |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Specifies a list of days of the month for the monthly schedule.
| Type: | DaysOfMonth[] |
| Parameter Sets: | One, Two, Three, Four, Five, Six, Seventh, Eighth, Ninth, Tenth, Eleventh, Twelfth, Thirteenth, Fourteenth, Fifteenth, Sixteenth, Seventeenth, Eighteenth, Nineteenth, Twentieth, TwentyFirst, TwentySecond, TwentyThird, TwentyFourth, TwentyFifth, TwentySixth, TwentySeventh, TwentyEighth, TwentyNinth, Thirtieth, ThirtyFirst, LastDay |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Specifies a list of days of the week for the weekly schedule.
| Type: | DayOfWeek[] |
| Parameter Sets: | Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Specifies a description for the schedule.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | False |
Specifies the expiry time of a schedule as a DateTimeOffest object. You can specify a string that can be converted to a valid DateTimeOffset.
| Type: | DateTimeOffset |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Specifies the time zone for the schedule. This string can be the IANA ID or the Windows Time Zone ID.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | False |
Outputs
Microsoft.Azure.Commands.Automation.Model.Schedule