New-AzLabServicesSchedule

Reference

Module:: Az.LabServices

Operation to create or update a lab schedule.

Syntax

New-AzLabServicesSchedule
   -Name <String>
   -LabName <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String>]
   [-Note <String>]
   [-RecurrencePatternExpirationDate <DateTime>]
   [-RecurrencePatternFrequency <RecurrenceFrequency>]
   [-RecurrencePatternInterval <Int32>]
   [-RecurrencePatternWeekDay <WeekDay[]>]
   [-StartAt <DateTime>]
   [-StopAt <DateTime>]
   [-TimeZoneId <String>]
   [-DefaultProfile <PSObject>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

New-AzLabServicesSchedule
   -Name <String>
   [-SubscriptionId <String>]
   -Lab <Lab>
   [-Note <String>]
   [-RecurrencePatternExpirationDate <DateTime>]
   [-RecurrencePatternFrequency <RecurrenceFrequency>]
   [-RecurrencePatternInterval <Int32>]
   [-RecurrencePatternWeekDay <WeekDay[]>]
   [-StartAt <DateTime>]
   [-StopAt <DateTime>]
   [-TimeZoneId <String>]
   [-DefaultProfile <PSObject>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Operation to create or update a lab schedule.

Examples

Example 1: Create a new schedule in a lab.

New-AzLabServicesSchedule `
            -ResourceGroupName "Group Name" `
            -LabName "Lab Name" `
            -Name "Schedule Name" `
            -StartAt "$((Get-Date).AddHours(5))" `
            -StopAt "$((Get-Date).AddHours(6))" `
            -RecurrencePatternFrequency 'Weekly' `
            -RecurrencePatternInterval 1 `
            -RecurrencePatternWeekDay @($((Get-Date).DayOfWeek)) `
            -RecurrencePatternExpirationDate $((Get-Date).AddDays(20)) `
            -TimeZoneId 'America/Los_Angeles'

Name
----
Schedule Name

Create a weekly schedule.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

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

-DefaultProfile

The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.

Type:	PSObject
Aliases:	AzureRMContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Lab

To construct, see NOTES section for LAB properties and create a hash table.

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

-LabName

The name of the lab that uniquely identifies it within containing lab account. Used in resource URIs.

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

-Name

The name of the schedule that uniquely identifies it within containing lab. Used in resource URIs.

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

-Note

Notes for this schedule.

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

-RecurrencePatternExpirationDate

When the recurrence will expire. This date is inclusive.

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

-RecurrencePatternFrequency

The frequency of the recurrence.

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

-RecurrencePatternInterval

The interval to invoke the schedule on. For example, interval = 2 and RecurrenceFrequency.Daily will run every 2 days. When no interval is supplied, an interval of 1 is used.

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

-RecurrencePatternWeekDay

The week days the schedule runs. Used for when the Frequency is set to Weekly.

Type:	WeekDay[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ResourceGroupName

The name of the resource group. The name is case insensitive.

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

-StartAt

When lab user virtual machines will be started. Timestamp offsets will be ignored and timeZoneId is used instead.

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

-StopAt

When lab user virtual machines will be stopped. Timestamp offsets will be ignored and timeZoneId is used instead.

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

-SubscriptionId

The ID of the target subscription.

Type:	String
Position:	Named
Default value:	(Get-AzContext).Subscription.Id
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-TimeZoneId

The IANA timezone id for the schedule.

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

Inputs

Lab

Outputs

ISchedule

Share via