Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. devtestlab
  5. listVirtualMachineApplicableSchedules
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi
pulumi/pulumi-azure-native

azure-native.devtestlab.listVirtualMachineApplicableSchedules

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi
pulumi/pulumi-azure-native

    Lists the applicable start/stop schedules, if any. Azure REST API version: 2018-09-15.

    Other available API versions: 2016-05-15.

    Using listVirtualMachineApplicableSchedules

    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 listVirtualMachineApplicableSchedules(args: ListVirtualMachineApplicableSchedulesArgs, opts?: InvokeOptions): Promise<ListVirtualMachineApplicableSchedulesResult>
function listVirtualMachineApplicableSchedulesOutput(args: ListVirtualMachineApplicableSchedulesOutputArgs, opts?: InvokeOptions): Output<ListVirtualMachineApplicableSchedulesResult>
    def list_virtual_machine_applicable_schedules(lab_name: Optional[str] = None,
                                              name: Optional[str] = None,
                                              resource_group_name: Optional[str] = None,
                                              opts: Optional[InvokeOptions] = None) -> ListVirtualMachineApplicableSchedulesResult
def list_virtual_machine_applicable_schedules_output(lab_name: Optional[pulumi.Input[str]] = None,
                                              name: Optional[pulumi.Input[str]] = None,
                                              resource_group_name: Optional[pulumi.Input[str]] = None,
                                              opts: Optional[InvokeOptions] = None) -> Output[ListVirtualMachineApplicableSchedulesResult]
    func ListVirtualMachineApplicableSchedules(ctx *Context, args *ListVirtualMachineApplicableSchedulesArgs, opts ...InvokeOption) (*ListVirtualMachineApplicableSchedulesResult, error)
func ListVirtualMachineApplicableSchedulesOutput(ctx *Context, args *ListVirtualMachineApplicableSchedulesOutputArgs, opts ...InvokeOption) ListVirtualMachineApplicableSchedulesResultOutput

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

    public static class ListVirtualMachineApplicableSchedules 
{
    public static Task<ListVirtualMachineApplicableSchedulesResult> InvokeAsync(ListVirtualMachineApplicableSchedulesArgs args, InvokeOptions? opts = null)
    public static Output<ListVirtualMachineApplicableSchedulesResult> Invoke(ListVirtualMachineApplicableSchedulesInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<ListVirtualMachineApplicableSchedulesResult> listVirtualMachineApplicableSchedules(ListVirtualMachineApplicableSchedulesArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

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

    The following arguments are supported:

    LabName string
    The name of the lab.
    Name string
    The name of the virtual machine.
    ResourceGroupName string
    The name of the resource group.
    LabName string
    The name of the lab.
    Name string
    The name of the virtual machine.
    ResourceGroupName string
    The name of the resource group.
    labName String
    The name of the lab.
    name String
    The name of the virtual machine.
    resourceGroupName String
    The name of the resource group.
    labName string
    The name of the lab.
    name string
    The name of the virtual machine.
    resourceGroupName string
    The name of the resource group.
    lab_name str
    The name of the lab.
    name str
    The name of the virtual machine.
    resource_group_name str
    The name of the resource group.
    labName String
    The name of the lab.
    name String
    The name of the virtual machine.
    resourceGroupName String
    The name of the resource group.

    listVirtualMachineApplicableSchedules Result

    The following output properties are available:

    Id string
    The identifier of the resource.
    Name string
    The name of the resource.
    Type string
    The type of the resource.
    LabVmsShutdown Pulumi.AzureNative.DevTestLab.Outputs.ScheduleResponse
    The auto-shutdown schedule, if one has been set at the lab or lab resource level.
    LabVmsStartup Pulumi.AzureNative.DevTestLab.Outputs.ScheduleResponse
    The auto-startup schedule, if one has been set at the lab or lab resource level.
    Location string
    The location of the resource.
    Tags Dictionary<string, string>
    The tags of the resource.
    Id string
    The identifier of the resource.
    Name string
    The name of the resource.
    Type string
    The type of the resource.
    LabVmsShutdown ScheduleResponse
    The auto-shutdown schedule, if one has been set at the lab or lab resource level.
    LabVmsStartup ScheduleResponse
    The auto-startup schedule, if one has been set at the lab or lab resource level.
    Location string
    The location of the resource.
    Tags map[string]string
    The tags of the resource.
    id String
    The identifier of the resource.
    name String
    The name of the resource.
    type String
    The type of the resource.
    labVmsShutdown ScheduleResponse
    The auto-shutdown schedule, if one has been set at the lab or lab resource level.
    labVmsStartup ScheduleResponse
    The auto-startup schedule, if one has been set at the lab or lab resource level.
    location String
    The location of the resource.
    tags Map<String,String>
    The tags of the resource.
    id string
    The identifier of the resource.
    name string
    The name of the resource.
    type string
    The type of the resource.
    labVmsShutdown ScheduleResponse
    The auto-shutdown schedule, if one has been set at the lab or lab resource level.
    labVmsStartup ScheduleResponse
    The auto-startup schedule, if one has been set at the lab or lab resource level.
    location string
    The location of the resource.
    tags {[key: string]: string}
    The tags of the resource.
    id str
    The identifier of the resource.
    name str
    The name of the resource.
    type str
    The type of the resource.
    lab_vms_shutdown ScheduleResponse
    The auto-shutdown schedule, if one has been set at the lab or lab resource level.
    lab_vms_startup ScheduleResponse
    The auto-startup schedule, if one has been set at the lab or lab resource level.
    location str
    The location of the resource.
    tags Mapping[str, str]
    The tags of the resource.
    id String
    The identifier of the resource.
    name String
    The name of the resource.
    type String
    The type of the resource.
    labVmsShutdown Property Map
    The auto-shutdown schedule, if one has been set at the lab or lab resource level.
    labVmsStartup Property Map
    The auto-startup schedule, if one has been set at the lab or lab resource level.
    location String
    The location of the resource.
    tags Map<String>
    The tags of the resource.

    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.

    ScheduleResponse

    CreatedDate string
    The creation date of the schedule.
    Id string
    The identifier of the resource.
    Name string
    The name of the resource.
    ProvisioningState string
    The provisioning status of the resource.
    Type string
    The type of the resource.
    UniqueIdentifier string
    The unique immutable identifier of a resource (Guid).
    DailyRecurrence Pulumi.AzureNative.DevTestLab.Inputs.DayDetailsResponse
    If the schedule will occur once each day of the week, specify the daily recurrence.
    HourlyRecurrence Pulumi.AzureNative.DevTestLab.Inputs.HourDetailsResponse
    If the schedule will occur multiple times a day, specify the hourly recurrence.
    Location string
    The location of the resource.
    NotificationSettings Pulumi.AzureNative.DevTestLab.Inputs.NotificationSettingsResponse
    Notification settings.
    Status string
    The status of the schedule (i.e. Enabled, Disabled)
    Tags Dictionary<string, string>
    The tags of the resource.
    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.Inputs.WeekDetailsResponse
    If the schedule will occur only some days of the week, specify the weekly recurrence.
    CreatedDate string
    The creation date of the schedule.
    Id string
    The identifier of the resource.
    Name string
    The name of the resource.
    ProvisioningState string
    The provisioning status of the resource.
    Type string
    The type of the resource.
    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 location of the resource.
    NotificationSettings NotificationSettingsResponse
    Notification settings.
    Status string
    The status of the schedule (i.e. Enabled, Disabled)
    Tags map[string]string
    The tags of the resource.
    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.
    createdDate String
    The creation date of the schedule.
    id String
    The identifier of the resource.
    name String
    The name of the resource.
    provisioningState String
    The provisioning status of the resource.
    type String
    The type of the resource.
    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 location of the resource.
    notificationSettings NotificationSettingsResponse
    Notification settings.
    status String
    The status of the schedule (i.e. Enabled, Disabled)
    tags Map<String,String>
    The tags of the resource.
    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.
    createdDate string
    The creation date of the schedule.
    id string
    The identifier of the resource.
    name string
    The name of the resource.
    provisioningState string
    The provisioning status of the resource.
    type string
    The type of the resource.
    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 location of the resource.
    notificationSettings NotificationSettingsResponse
    Notification settings.
    status string
    The status of the schedule (i.e. Enabled, Disabled)
    tags {[key: string]: string}
    The tags of the resource.
    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.
    created_date str
    The creation date of the schedule.
    id str
    The identifier of the resource.
    name str
    The name of the resource.
    provisioning_state str
    The provisioning status of the resource.
    type str
    The type of the resource.
    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 location of the resource.
    notification_settings NotificationSettingsResponse
    Notification settings.
    status str
    The status of the schedule (i.e. Enabled, Disabled)
    tags Mapping[str, str]
    The tags of the resource.
    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.
    createdDate String
    The creation date of the schedule.
    id String
    The identifier of the resource.
    name String
    The name of the resource.
    provisioningState String
    The provisioning status of the resource.
    type String
    The type of the resource.
    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 location of the resource.
    notificationSettings Property Map
    Notification settings.
    status String
    The status of the schedule (i.e. Enabled, Disabled)
    tags Map<String>
    The tags of the resource.
    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.

    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.).

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi
    pulumi/pulumi-azure-native