Azure Native v1.99.1, Mar 31 23

azure-native.devtestlab.getGlobalSchedule

Get schedule. API Version: 2018-09-15.

Using getGlobalSchedule

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 getGlobalSchedule(args: GetGlobalScheduleArgs, opts?: InvokeOptions): Promise<GetGlobalScheduleResult>
function getGlobalScheduleOutput(args: GetGlobalScheduleOutputArgs, opts?: InvokeOptions): Output<GetGlobalScheduleResult>

def get_global_schedule(expand: Optional[str] = None,
                        name: Optional[str] = None,
                        resource_group_name: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetGlobalScheduleResult
def get_global_schedule_output(expand: Optional[pulumi.Input[str]] = None,
                        name: Optional[pulumi.Input[str]] = None,
                        resource_group_name: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetGlobalScheduleResult]

func LookupGlobalSchedule(ctx *Context, args *LookupGlobalScheduleArgs, opts ...InvokeOption) (*LookupGlobalScheduleResult, error)
func LookupGlobalScheduleOutput(ctx *Context, args *LookupGlobalScheduleOutputArgs, opts ...InvokeOption) LookupGlobalScheduleResultOutput

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

public static class GetGlobalSchedule 
{
    public static Task<GetGlobalScheduleResult> InvokeAsync(GetGlobalScheduleArgs args, InvokeOptions? opts = null)
    public static Output<GetGlobalScheduleResult> Invoke(GetGlobalScheduleInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetGlobalScheduleResult> getGlobalSchedule(GetGlobalScheduleArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

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

The following arguments are supported:

Name string: The name of the schedule.
ResourceGroupName string: The name of the resource group.
Expand string: Specify the $expand query. Example: 'properties($select=status)'

Name string: The name of the schedule.
ResourceGroupName string: The name of the resource group.
Expand string: Specify the $expand query. Example: 'properties($select=status)'

name String: The name of the schedule.
resourceGroupName String: The name of the resource group.
expand String: Specify the $expand query. Example: 'properties($select=status)'

name string: The name of the schedule.
resourceGroupName string: The name of the resource group.
expand string: Specify the $expand query. Example: 'properties($select=status)'

name str: The name of the schedule.
resource_group_name str: The name of the resource group.
expand str: Specify the $expand query. Example: 'properties($select=status)'

name String: The name of the schedule.
resourceGroupName String: The name of the resource group.
expand String: Specify the $expand query. Example: 'properties($select=status)'

getGlobalSchedule Result

The following output properties are available:

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.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 location of the resource.
NotificationSettings Pulumi.AzureNative.DevTestLab.Outputs.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. Pacific Standard time).
WeeklyRecurrence Pulumi.AzureNative.DevTestLab.Outputs.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. Pacific Standard time).
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. Pacific Standard time).
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. Pacific Standard time).
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. Pacific Standard time).
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. Pacific Standard time).
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.

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