azure-native.devtestlab.getVirtualMachineSchedule

Azure Native v3.16.0, Mar 20 26

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.

Viewing docs for Azure Native v3.16.0
published on Friday, Mar 20, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-azure-native

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.

Viewing docs for Azure Native v3.16.0
published on Friday, Mar 20, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-azure-native

Using getVirtualMachineSchedule

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getVirtualMachineSchedule(args: GetVirtualMachineScheduleArgs, opts?: InvokeOptions): Promise<GetVirtualMachineScheduleResult>
function getVirtualMachineScheduleOutput(args: GetVirtualMachineScheduleOutputArgs, opts?: InvokeOptions): Output<GetVirtualMachineScheduleResult>

def get_virtual_machine_schedule(expand: Optional[str] = None,
                                 lab_name: Optional[str] = None,
                                 name: Optional[str] = None,
                                 resource_group_name: Optional[str] = None,
                                 virtual_machine_name: Optional[str] = None,
                                 opts: Optional[InvokeOptions] = None) -> GetVirtualMachineScheduleResult
def get_virtual_machine_schedule_output(expand: Optional[pulumi.Input[str]] = None,
                                 lab_name: Optional[pulumi.Input[str]] = None,
                                 name: Optional[pulumi.Input[str]] = None,
                                 resource_group_name: Optional[pulumi.Input[str]] = None,
                                 virtual_machine_name: Optional[pulumi.Input[str]] = None,
                                 opts: Optional[InvokeOptions] = None) -> Output[GetVirtualMachineScheduleResult]

func LookupVirtualMachineSchedule(ctx *Context, args *LookupVirtualMachineScheduleArgs, opts ...InvokeOption) (*LookupVirtualMachineScheduleResult, error)
func LookupVirtualMachineScheduleOutput(ctx *Context, args *LookupVirtualMachineScheduleOutputArgs, opts ...InvokeOption) LookupVirtualMachineScheduleResultOutput

> Note: This function is named LookupVirtualMachineSchedule in the Go SDK.

public static class GetVirtualMachineSchedule 
{
    public static Task<GetVirtualMachineScheduleResult> InvokeAsync(GetVirtualMachineScheduleArgs args, InvokeOptions? opts = null)
    public static Output<GetVirtualMachineScheduleResult> Invoke(GetVirtualMachineScheduleInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetVirtualMachineScheduleResult> getVirtualMachineSchedule(GetVirtualMachineScheduleArgs args, InvokeOptions options)
public static Output<GetVirtualMachineScheduleResult> getVirtualMachineSchedule(GetVirtualMachineScheduleArgs args, InvokeOptions options)

fn::invoke:
  function: azure-native:devtestlab:getVirtualMachineSchedule
  arguments:
    # arguments dictionary

The following arguments are supported:

LabName string: labs
Name string: The name of the Schedule
ResourceGroupName string: The name of the resource group. The name is case insensitive.
VirtualMachineName string: virtualmachines
Expand string: Specify the $expand query. Example: 'properties($select=status)'

LabName string: labs
Name string: The name of the Schedule
ResourceGroupName string: The name of the resource group. The name is case insensitive.
VirtualMachineName string: virtualmachines
Expand string: Specify the $expand query. Example: 'properties($select=status)'

labName String: labs
name String: The name of the Schedule
resourceGroupName String: The name of the resource group. The name is case insensitive.
virtualMachineName String: virtualmachines
expand String: Specify the $expand query. Example: 'properties($select=status)'

labName string: labs
name string: The name of the Schedule
resourceGroupName string: The name of the resource group. The name is case insensitive.
virtualMachineName string: virtualmachines
expand string: Specify the $expand query. Example: 'properties($select=status)'

lab_name str: labs
name str: The name of the Schedule
resource_group_name str: The name of the resource group. The name is case insensitive.
virtual_machine_name str: virtualmachines
expand str: Specify the $expand query. Example: 'properties($select=status)'

labName String: labs
name String: The name of the Schedule
resourceGroupName String: The name of the resource group. The name is case insensitive.
virtualMachineName String: virtualmachines
expand String: Specify the $expand query. Example: 'properties($select=status)'

getVirtualMachineSchedule Result

The following output properties are available:

AzureApiVersion string: The Azure API version of the resource.
CreatedDate string: The creation date of the schedule.
Id string: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name string: The name of the resource
ProvisioningState string: The provisioning status of the resource.
SystemData Pulumi.AzureNative.DevTestLab.Outputs.SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
UniqueIdentifier string: The unique immutable identifier of a resource (Guid).
DailyRecurrence Pulumi.AzureNative.DevTestLab.Outputs.DayDetailsResponse: If the schedule will occur once each day of the week, specify the daily recurrence.
HourlyRecurrence Pulumi.AzureNative.DevTestLab.Outputs.HourDetailsResponse: If the schedule will occur multiple times a day, specify the hourly recurrence.
Location string: The geo-location where the resource lives
NotificationSettings Pulumi.AzureNative.DevTestLab.Outputs.NotificationSettingsResponse: Notification settings.
Status string: The status of the schedule (i.e. Enabled, Disabled)
Tags Dictionary<string, string>: Resource tags.
TargetResourceId string: The resource ID to which the schedule belongs
TaskType string: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart).
TimeZoneId string: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in IReadOnlyCollection<string> TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md)
WeeklyRecurrence Pulumi.AzureNative.DevTestLab.Outputs.WeekDetailsResponse: If the schedule will occur only some days of the week, specify the weekly recurrence.

AzureApiVersion string: The Azure API version of the resource.
CreatedDate string: The creation date of the schedule.
Id string: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name string: The name of the resource
ProvisioningState string: The provisioning status of the resource.
SystemData SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
UniqueIdentifier string: The unique immutable identifier of a resource (Guid).
DailyRecurrence DayDetailsResponse: If the schedule will occur once each day of the week, specify the daily recurrence.
HourlyRecurrence HourDetailsResponse: If the schedule will occur multiple times a day, specify the hourly recurrence.
Location string: The geo-location where the resource lives
NotificationSettings NotificationSettingsResponse: Notification settings.
Status string: The status of the schedule (i.e. Enabled, Disabled)
Tags map[string]string: Resource tags.
TargetResourceId string: The resource ID to which the schedule belongs
TaskType string: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart).
TimeZoneId string: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in IReadOnlyCollection<string> TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md)
WeeklyRecurrence WeekDetailsResponse: If the schedule will occur only some days of the week, specify the weekly recurrence.

azureApiVersion String: The Azure API version of the resource.
createdDate String: The creation date of the schedule.
id String: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name String: The name of the resource
provisioningState String: The provisioning status of the resource.
systemData SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
uniqueIdentifier String: The unique immutable identifier of a resource (Guid).
dailyRecurrence DayDetailsResponse: If the schedule will occur once each day of the week, specify the daily recurrence.
hourlyRecurrence HourDetailsResponse: If the schedule will occur multiple times a day, specify the hourly recurrence.
location String: The geo-location where the resource lives
notificationSettings NotificationSettingsResponse: Notification settings.
status String: The status of the schedule (i.e. Enabled, Disabled)
tags Map<String,String>: Resource tags.
targetResourceId String: The resource ID to which the schedule belongs
taskType String: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart).
timeZoneId String: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in IReadOnlyCollection<string> TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md)
weeklyRecurrence WeekDetailsResponse: If the schedule will occur only some days of the week, specify the weekly recurrence.

azureApiVersion string: The Azure API version of the resource.
createdDate string: The creation date of the schedule.
id string: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name string: The name of the resource
provisioningState string: The provisioning status of the resource.
systemData SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.
type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
uniqueIdentifier string: The unique immutable identifier of a resource (Guid).
dailyRecurrence DayDetailsResponse: If the schedule will occur once each day of the week, specify the daily recurrence.
hourlyRecurrence HourDetailsResponse: If the schedule will occur multiple times a day, specify the hourly recurrence.
location string: The geo-location where the resource lives
notificationSettings NotificationSettingsResponse: Notification settings.
status string: The status of the schedule (i.e. Enabled, Disabled)
tags {[key: string]: string}: Resource tags.
targetResourceId string: The resource ID to which the schedule belongs
taskType string: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart).
timeZoneId string: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in IReadOnlyCollection<string> TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md)
weeklyRecurrence WeekDetailsResponse: If the schedule will occur only some days of the week, specify the weekly recurrence.

azure_api_version str: The Azure API version of the resource.
created_date str: The creation date of the schedule.
id str: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name str: The name of the resource
provisioning_state str: The provisioning status of the resource.
system_data SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.
type str: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
unique_identifier str: The unique immutable identifier of a resource (Guid).
daily_recurrence DayDetailsResponse: If the schedule will occur once each day of the week, specify the daily recurrence.
hourly_recurrence HourDetailsResponse: If the schedule will occur multiple times a day, specify the hourly recurrence.
location str: The geo-location where the resource lives
notification_settings NotificationSettingsResponse: Notification settings.
status str: The status of the schedule (i.e. Enabled, Disabled)
tags Mapping[str, str]: Resource tags.
target_resource_id str: The resource ID to which the schedule belongs
task_type str: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart).
time_zone_id str: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in IReadOnlyCollection<string> TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md)
weekly_recurrence WeekDetailsResponse: If the schedule will occur only some days of the week, specify the weekly recurrence.

azureApiVersion String: The Azure API version of the resource.
createdDate String: The creation date of the schedule.
id String: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name String: The name of the resource
provisioningState String: The provisioning status of the resource.
systemData Property Map: Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
uniqueIdentifier String: The unique immutable identifier of a resource (Guid).
dailyRecurrence Property Map: If the schedule will occur once each day of the week, specify the daily recurrence.
hourlyRecurrence Property Map: If the schedule will occur multiple times a day, specify the hourly recurrence.
location String: The geo-location where the resource lives
notificationSettings Property Map: Notification settings.
status String: The status of the schedule (i.e. Enabled, Disabled)
tags Map<String>: Resource tags.
targetResourceId String: The resource ID to which the schedule belongs
taskType String: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart).
timeZoneId String: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in IReadOnlyCollection<string> TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md)
weeklyRecurrence Property Map: If the schedule will occur only some days of the week, specify the weekly recurrence.

Supporting Types

DayDetailsResponse

Time string: The time of day the schedule will occur.

Time string: The time of day the schedule will occur.

time String: The time of day the schedule will occur.

time string: The time of day the schedule will occur.

time str: The time of day the schedule will occur.

time String: The time of day the schedule will occur.

HourDetailsResponse

Minute int: Minutes of the hour the schedule will run.

Minute int: Minutes of the hour the schedule will run.

minute Integer: Minutes of the hour the schedule will run.

minute number: Minutes of the hour the schedule will run.

minute int: Minutes of the hour the schedule will run.

minute Number: Minutes of the hour the schedule will run.

NotificationSettingsResponse

EmailRecipient string: The email recipient to send notifications to (can be a list of semi-colon separated email addresses).
NotificationLocale string: The locale to use when sending a notification (fallback for unsupported languages is EN).
Status string: If notifications are enabled for this schedule (i.e. Enabled, Disabled).
TimeInMinutes int: Time in minutes before event at which notification will be sent.
WebhookUrl string: The webhook URL to which the notification will be sent.

EmailRecipient string: The email recipient to send notifications to (can be a list of semi-colon separated email addresses).
NotificationLocale string: The locale to use when sending a notification (fallback for unsupported languages is EN).
Status string: If notifications are enabled for this schedule (i.e. Enabled, Disabled).
TimeInMinutes int: Time in minutes before event at which notification will be sent.
WebhookUrl string: The webhook URL to which the notification will be sent.

emailRecipient String: The email recipient to send notifications to (can be a list of semi-colon separated email addresses).
notificationLocale String: The locale to use when sending a notification (fallback for unsupported languages is EN).
status String: If notifications are enabled for this schedule (i.e. Enabled, Disabled).
timeInMinutes Integer: Time in minutes before event at which notification will be sent.
webhookUrl String: The webhook URL to which the notification will be sent.

emailRecipient string: The email recipient to send notifications to (can be a list of semi-colon separated email addresses).
notificationLocale string: The locale to use when sending a notification (fallback for unsupported languages is EN).
status string: If notifications are enabled for this schedule (i.e. Enabled, Disabled).
timeInMinutes number: Time in minutes before event at which notification will be sent.
webhookUrl string: The webhook URL to which the notification will be sent.

email_recipient str: The email recipient to send notifications to (can be a list of semi-colon separated email addresses).
notification_locale str: The locale to use when sending a notification (fallback for unsupported languages is EN).
status str: If notifications are enabled for this schedule (i.e. Enabled, Disabled).
time_in_minutes int: Time in minutes before event at which notification will be sent.
webhook_url str: The webhook URL to which the notification will be sent.

emailRecipient String: The email recipient to send notifications to (can be a list of semi-colon separated email addresses).
notificationLocale String: The locale to use when sending a notification (fallback for unsupported languages is EN).
status String: If notifications are enabled for this schedule (i.e. Enabled, Disabled).
timeInMinutes Number: Time in minutes before event at which notification will be sent.
webhookUrl String: The webhook URL to which the notification will be sent.

SystemDataResponse

CreatedAt string: The timestamp of resource creation (UTC).
CreatedBy string: The identity that created the resource.
CreatedByType string: The type of identity that created the resource.
LastModifiedAt string: The timestamp of resource last modification (UTC)
LastModifiedBy string: The identity that last modified the resource.
LastModifiedByType string: The type of identity that last modified the resource.

CreatedAt string: The timestamp of resource creation (UTC).
CreatedBy string: The identity that created the resource.
CreatedByType string: The type of identity that created the resource.
LastModifiedAt string: The timestamp of resource last modification (UTC)
LastModifiedBy string: The identity that last modified the resource.
LastModifiedByType string: The type of identity that last modified the resource.

createdAt String: The timestamp of resource creation (UTC).
createdBy String: The identity that created the resource.
createdByType String: The type of identity that created the resource.
lastModifiedAt String: The timestamp of resource last modification (UTC)
lastModifiedBy String: The identity that last modified the resource.
lastModifiedByType String: The type of identity that last modified the resource.

createdAt string: The timestamp of resource creation (UTC).
createdBy string: The identity that created the resource.
createdByType string: The type of identity that created the resource.
lastModifiedAt string: The timestamp of resource last modification (UTC)
lastModifiedBy string: The identity that last modified the resource.
lastModifiedByType string: The type of identity that last modified the resource.

created_at str: The timestamp of resource creation (UTC).
created_by str: The identity that created the resource.
created_by_type str: The type of identity that created the resource.
last_modified_at str: The timestamp of resource last modification (UTC)
last_modified_by str: The identity that last modified the resource.
last_modified_by_type str: The type of identity that last modified the resource.

createdAt String: The timestamp of resource creation (UTC).
createdBy String: The identity that created the resource.
createdByType String: The type of identity that created the resource.
lastModifiedAt String: The timestamp of resource last modification (UTC)
lastModifiedBy String: The identity that last modified the resource.
lastModifiedByType String: The type of identity that last modified the resource.

WeekDetailsResponse

Time string: The time of the day the schedule will occur.
Weekdays List<string>: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.).

Time string: The time of the day the schedule will occur.
Weekdays []string: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.).

time String: The time of the day the schedule will occur.
weekdays List<String>: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.).

time string: The time of the day the schedule will occur.
weekdays string[]: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.).

time str: The time of the day the schedule will occur.
weekdays Sequence[str]: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.).

time String: The time of the day the schedule will occur.
weekdays List<String>: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.).