Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. automation
  5. getSchedule
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.4.0 published on Wednesday, May 7, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.automation.getSchedule

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.4.0 published on Wednesday, May 7, 2025 by Pulumi
pulumi/pulumi-azure-native

    Retrieve the schedule identified by schedule name.

    Uses Azure REST API version 2023-11-01.

    Other available API versions: 2015-10-31, 2019-06-01, 2020-01-13-preview, 2022-08-08, 2023-05-15-preview, 2024-10-23. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native automation [ApiVersion]. See the version guide for details.

    Using getSchedule

    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 getSchedule(args: GetScheduleArgs, opts?: InvokeOptions): Promise<GetScheduleResult>
function getScheduleOutput(args: GetScheduleOutputArgs, opts?: InvokeOptions): Output<GetScheduleResult>
    def get_schedule(automation_account_name: Optional[str] = None,
                 resource_group_name: Optional[str] = None,
                 schedule_name: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetScheduleResult
def get_schedule_output(automation_account_name: Optional[pulumi.Input[str]] = None,
                 resource_group_name: Optional[pulumi.Input[str]] = None,
                 schedule_name: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetScheduleResult]
    func LookupSchedule(ctx *Context, args *LookupScheduleArgs, opts ...InvokeOption) (*LookupScheduleResult, error)
func LookupScheduleOutput(ctx *Context, args *LookupScheduleOutputArgs, opts ...InvokeOption) LookupScheduleResultOutput

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

    public static class GetSchedule 
{
    public static Task<GetScheduleResult> InvokeAsync(GetScheduleArgs args, InvokeOptions? opts = null)
    public static Output<GetScheduleResult> Invoke(GetScheduleInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetScheduleResult> getSchedule(GetScheduleArgs args, InvokeOptions options)
public static Output<GetScheduleResult> getSchedule(GetScheduleArgs args, InvokeOptions options)

    fn::invoke:
  function: azure-native:automation:getSchedule
  arguments:
    # arguments dictionary

    The following arguments are supported:

    AutomationAccountName string
    The name of the automation account.
    ResourceGroupName string
    Name of an Azure Resource group.
    ScheduleName string
    The schedule name.
    AutomationAccountName string
    The name of the automation account.
    ResourceGroupName string
    Name of an Azure Resource group.
    ScheduleName string
    The schedule name.
    automationAccountName String
    The name of the automation account.
    resourceGroupName String
    Name of an Azure Resource group.
    scheduleName String
    The schedule name.
    automationAccountName string
    The name of the automation account.
    resourceGroupName string
    Name of an Azure Resource group.
    scheduleName string
    The schedule name.
    automation_account_name str
    The name of the automation account.
    resource_group_name str
    Name of an Azure Resource group.
    schedule_name str
    The schedule name.
    automationAccountName String
    The name of the automation account.
    resourceGroupName String
    Name of an Azure Resource group.
    scheduleName String
    The schedule name.

    getSchedule Result

    The following output properties are available:

    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    Fully qualified resource Id for the resource
    Name string
    The name of the resource
    StartTimeOffsetMinutes double
    Gets the start time's offset in minutes.
    Type string
    The type of the resource.
    AdvancedSchedule Pulumi.AzureNative.Automation.Outputs.AdvancedScheduleResponse
    Gets or sets the advanced schedule.
    CreationTime string
    Gets or sets the creation time.
    Description string
    Gets or sets the description.
    ExpiryTime string
    Gets or sets the end time of the schedule.
    ExpiryTimeOffsetMinutes double
    Gets or sets the expiry time's offset in minutes.
    Frequency string
    Gets or sets the frequency of the schedule.
    Interval object
    Gets or sets the interval of the schedule.
    IsEnabled bool
    Gets or sets a value indicating whether this schedule is enabled.
    LastModifiedTime string
    Gets or sets the last modified time.
    NextRun string
    Gets or sets the next run time of the schedule.
    NextRunOffsetMinutes double
    Gets or sets the next run time's offset in minutes.
    StartTime string
    Gets or sets the start time of the schedule.
    TimeZone string
    Gets or sets the time zone of the schedule.
    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    Fully qualified resource Id for the resource
    Name string
    The name of the resource
    StartTimeOffsetMinutes float64
    Gets the start time's offset in minutes.
    Type string
    The type of the resource.
    AdvancedSchedule AdvancedScheduleResponse
    Gets or sets the advanced schedule.
    CreationTime string
    Gets or sets the creation time.
    Description string
    Gets or sets the description.
    ExpiryTime string
    Gets or sets the end time of the schedule.
    ExpiryTimeOffsetMinutes float64
    Gets or sets the expiry time's offset in minutes.
    Frequency string
    Gets or sets the frequency of the schedule.
    Interval interface{}
    Gets or sets the interval of the schedule.
    IsEnabled bool
    Gets or sets a value indicating whether this schedule is enabled.
    LastModifiedTime string
    Gets or sets the last modified time.
    NextRun string
    Gets or sets the next run time of the schedule.
    NextRunOffsetMinutes float64
    Gets or sets the next run time's offset in minutes.
    StartTime string
    Gets or sets the start time of the schedule.
    TimeZone string
    Gets or sets the time zone of the schedule.
    azureApiVersion String
    The Azure API version of the resource.
    id String
    Fully qualified resource Id for the resource
    name String
    The name of the resource
    startTimeOffsetMinutes Double
    Gets the start time's offset in minutes.
    type String
    The type of the resource.
    advancedSchedule AdvancedScheduleResponse
    Gets or sets the advanced schedule.
    creationTime String
    Gets or sets the creation time.
    description String
    Gets or sets the description.
    expiryTime String
    Gets or sets the end time of the schedule.
    expiryTimeOffsetMinutes Double
    Gets or sets the expiry time's offset in minutes.
    frequency String
    Gets or sets the frequency of the schedule.
    interval Object
    Gets or sets the interval of the schedule.
    isEnabled Boolean
    Gets or sets a value indicating whether this schedule is enabled.
    lastModifiedTime String
    Gets or sets the last modified time.
    nextRun String
    Gets or sets the next run time of the schedule.
    nextRunOffsetMinutes Double
    Gets or sets the next run time's offset in minutes.
    startTime String
    Gets or sets the start time of the schedule.
    timeZone String
    Gets or sets the time zone of the schedule.
    azureApiVersion string
    The Azure API version of the resource.
    id string
    Fully qualified resource Id for the resource
    name string
    The name of the resource
    startTimeOffsetMinutes number
    Gets the start time's offset in minutes.
    type string
    The type of the resource.
    advancedSchedule AdvancedScheduleResponse
    Gets or sets the advanced schedule.
    creationTime string
    Gets or sets the creation time.
    description string
    Gets or sets the description.
    expiryTime string
    Gets or sets the end time of the schedule.
    expiryTimeOffsetMinutes number
    Gets or sets the expiry time's offset in minutes.
    frequency string
    Gets or sets the frequency of the schedule.
    interval any
    Gets or sets the interval of the schedule.
    isEnabled boolean
    Gets or sets a value indicating whether this schedule is enabled.
    lastModifiedTime string
    Gets or sets the last modified time.
    nextRun string
    Gets or sets the next run time of the schedule.
    nextRunOffsetMinutes number
    Gets or sets the next run time's offset in minutes.
    startTime string
    Gets or sets the start time of the schedule.
    timeZone string
    Gets or sets the time zone of the schedule.
    azure_api_version str
    The Azure API version of the resource.
    id str
    Fully qualified resource Id for the resource
    name str
    The name of the resource
    start_time_offset_minutes float
    Gets the start time's offset in minutes.
    type str
    The type of the resource.
    advanced_schedule AdvancedScheduleResponse
    Gets or sets the advanced schedule.
    creation_time str
    Gets or sets the creation time.
    description str
    Gets or sets the description.
    expiry_time str
    Gets or sets the end time of the schedule.
    expiry_time_offset_minutes float
    Gets or sets the expiry time's offset in minutes.
    frequency str
    Gets or sets the frequency of the schedule.
    interval Any
    Gets or sets the interval of the schedule.
    is_enabled bool
    Gets or sets a value indicating whether this schedule is enabled.
    last_modified_time str
    Gets or sets the last modified time.
    next_run str
    Gets or sets the next run time of the schedule.
    next_run_offset_minutes float
    Gets or sets the next run time's offset in minutes.
    start_time str
    Gets or sets the start time of the schedule.
    time_zone str
    Gets or sets the time zone of the schedule.
    azureApiVersion String
    The Azure API version of the resource.
    id String
    Fully qualified resource Id for the resource
    name String
    The name of the resource
    startTimeOffsetMinutes Number
    Gets the start time's offset in minutes.
    type String
    The type of the resource.
    advancedSchedule Property Map
    Gets or sets the advanced schedule.
    creationTime String
    Gets or sets the creation time.
    description String
    Gets or sets the description.
    expiryTime String
    Gets or sets the end time of the schedule.
    expiryTimeOffsetMinutes Number
    Gets or sets the expiry time's offset in minutes.
    frequency String
    Gets or sets the frequency of the schedule.
    interval Any
    Gets or sets the interval of the schedule.
    isEnabled Boolean
    Gets or sets a value indicating whether this schedule is enabled.
    lastModifiedTime String
    Gets or sets the last modified time.
    nextRun String
    Gets or sets the next run time of the schedule.
    nextRunOffsetMinutes Number
    Gets or sets the next run time's offset in minutes.
    startTime String
    Gets or sets the start time of the schedule.
    timeZone String
    Gets or sets the time zone of the schedule.

    Supporting Types

    AdvancedScheduleMonthlyOccurrenceResponse

    Day string
    Day of the occurrence. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday.
    Occurrence int
    Occurrence of the week within the month. Must be between 1 and 5
    Day string
    Day of the occurrence. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday.
    Occurrence int
    Occurrence of the week within the month. Must be between 1 and 5
    day String
    Day of the occurrence. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday.
    occurrence Integer
    Occurrence of the week within the month. Must be between 1 and 5
    day string
    Day of the occurrence. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday.
    occurrence number
    Occurrence of the week within the month. Must be between 1 and 5
    day str
    Day of the occurrence. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday.
    occurrence int
    Occurrence of the week within the month. Must be between 1 and 5
    day String
    Day of the occurrence. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday.
    occurrence Number
    Occurrence of the week within the month. Must be between 1 and 5

    AdvancedScheduleResponse

    MonthDays List<int>
    Days of the month that the job should execute on. Must be between 1 and 31.
    MonthlyOccurrences List<Pulumi.AzureNative.Automation.Inputs.AdvancedScheduleMonthlyOccurrenceResponse>
    Occurrences of days within a month.
    WeekDays List<string>
    Days of the week that the job should execute on.
    MonthDays []int
    Days of the month that the job should execute on. Must be between 1 and 31.
    MonthlyOccurrences []AdvancedScheduleMonthlyOccurrenceResponse
    Occurrences of days within a month.
    WeekDays []string
    Days of the week that the job should execute on.
    monthDays List<Integer>
    Days of the month that the job should execute on. Must be between 1 and 31.
    monthlyOccurrences List<AdvancedScheduleMonthlyOccurrenceResponse>
    Occurrences of days within a month.
    weekDays List<String>
    Days of the week that the job should execute on.
    monthDays number[]
    Days of the month that the job should execute on. Must be between 1 and 31.
    monthlyOccurrences AdvancedScheduleMonthlyOccurrenceResponse[]
    Occurrences of days within a month.
    weekDays string[]
    Days of the week that the job should execute on.
    month_days Sequence[int]
    Days of the month that the job should execute on. Must be between 1 and 31.
    monthly_occurrences Sequence[AdvancedScheduleMonthlyOccurrenceResponse]
    Occurrences of days within a month.
    week_days Sequence[str]
    Days of the week that the job should execute on.
    monthDays List<Number>
    Days of the month that the job should execute on. Must be between 1 and 31.
    monthlyOccurrences List<Property Map>
    Occurrences of days within a month.
    weekDays List<String>
    Days of the week that the job should execute on.

    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 v2 docs if using the v2 version of this package.
    Azure Native v3.4.0 published on Wednesday, May 7, 2025 by Pulumi
    pulumi/pulumi-azure-native