Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. computeschedule
  5. getScheduledAction
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.6.1 published on Friday, Aug 1, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.computeschedule.getScheduledAction

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.6.1 published on Friday, Aug 1, 2025 by Pulumi
pulumi/pulumi-azure-native

    Get a ScheduledAction

    Uses Azure REST API version 2025-04-15-preview.

    Using getScheduledAction

    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 getScheduledAction(args: GetScheduledActionArgs, opts?: InvokeOptions): Promise<GetScheduledActionResult>
function getScheduledActionOutput(args: GetScheduledActionOutputArgs, opts?: InvokeOptions): Output<GetScheduledActionResult>
    def get_scheduled_action(resource_group_name: Optional[str] = None,
                         scheduled_action_name: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetScheduledActionResult
def get_scheduled_action_output(resource_group_name: Optional[pulumi.Input[str]] = None,
                         scheduled_action_name: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetScheduledActionResult]
    func LookupScheduledAction(ctx *Context, args *LookupScheduledActionArgs, opts ...InvokeOption) (*LookupScheduledActionResult, error)
func LookupScheduledActionOutput(ctx *Context, args *LookupScheduledActionOutputArgs, opts ...InvokeOption) LookupScheduledActionResultOutput

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

    public static class GetScheduledAction 
{
    public static Task<GetScheduledActionResult> InvokeAsync(GetScheduledActionArgs args, InvokeOptions? opts = null)
    public static Output<GetScheduledActionResult> Invoke(GetScheduledActionInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetScheduledActionResult> getScheduledAction(GetScheduledActionArgs args, InvokeOptions options)
public static Output<GetScheduledActionResult> getScheduledAction(GetScheduledActionArgs args, InvokeOptions options)

    fn::invoke:
  function: azure-native:computeschedule:getScheduledAction
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ScheduledActionName string
    The name of the ScheduledAction
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ScheduledActionName string
    The name of the ScheduledAction
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    scheduledActionName String
    The name of the ScheduledAction
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    scheduledActionName string
    The name of the ScheduledAction
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    scheduled_action_name str
    The name of the ScheduledAction
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    scheduledActionName String
    The name of the ScheduledAction

    getScheduledAction 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. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    Properties Pulumi.AzureNative.ComputeSchedule.Outputs.ScheduledActionPropertiesResponse
    The resource-specific properties for this resource.
    SystemData Pulumi.AzureNative.ComputeSchedule.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"
    Tags Dictionary<string, string>
    Resource tags.
    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    Properties ScheduledActionPropertiesResponse
    The resource-specific properties for this 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"
    Tags map[string]string
    Resource tags.
    azureApiVersion String
    The Azure API version of the resource.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    properties ScheduledActionPropertiesResponse
    The resource-specific properties for this 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"
    tags Map<String,String>
    Resource tags.
    azureApiVersion string
    The Azure API version of the resource.
    id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location string
    The geo-location where the resource lives
    name string
    The name of the resource
    properties ScheduledActionPropertiesResponse
    The resource-specific properties for this 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"
    tags {[key: string]: string}
    Resource tags.
    azure_api_version str
    The Azure API version of the resource.
    id str
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location str
    The geo-location where the resource lives
    name str
    The name of the resource
    properties ScheduledActionPropertiesResponse
    The resource-specific properties for this 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"
    tags Mapping[str, str]
    Resource tags.
    azureApiVersion String
    The Azure API version of the resource.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    properties Property Map
    The resource-specific properties for this 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"
    tags Map<String>
    Resource tags.

    Supporting Types

    ExecutionParametersResponse

    OptimizationPreference string
    Details that could optimize the user's request
    RetryPolicy Pulumi.AzureNative.ComputeSchedule.Inputs.RetryPolicyResponse
    Retry policy the user can pass
    OptimizationPreference string
    Details that could optimize the user's request
    RetryPolicy RetryPolicyResponse
    Retry policy the user can pass
    optimizationPreference String
    Details that could optimize the user's request
    retryPolicy RetryPolicyResponse
    Retry policy the user can pass
    optimizationPreference string
    Details that could optimize the user's request
    retryPolicy RetryPolicyResponse
    Retry policy the user can pass
    optimization_preference str
    Details that could optimize the user's request
    retry_policy RetryPolicyResponse
    Retry policy the user can pass
    optimizationPreference String
    Details that could optimize the user's request
    retryPolicy Property Map
    Retry policy the user can pass

    NotificationPropertiesResponse

    Destination string
    Where the notification should be sent. For email, it should follow email format.
    Language string
    The language the notification should be sent on.
    Type string
    Type of notification to be sent.
    Disabled bool
    Tells if the notification is enabled or not.
    Destination string
    Where the notification should be sent. For email, it should follow email format.
    Language string
    The language the notification should be sent on.
    Type string
    Type of notification to be sent.
    Disabled bool
    Tells if the notification is enabled or not.
    destination String
    Where the notification should be sent. For email, it should follow email format.
    language String
    The language the notification should be sent on.
    type String
    Type of notification to be sent.
    disabled Boolean
    Tells if the notification is enabled or not.
    destination string
    Where the notification should be sent. For email, it should follow email format.
    language string
    The language the notification should be sent on.
    type string
    Type of notification to be sent.
    disabled boolean
    Tells if the notification is enabled or not.
    destination str
    Where the notification should be sent. For email, it should follow email format.
    language str
    The language the notification should be sent on.
    type str
    Type of notification to be sent.
    disabled bool
    Tells if the notification is enabled or not.
    destination String
    Where the notification should be sent. For email, it should follow email format.
    language String
    The language the notification should be sent on.
    type String
    Type of notification to be sent.
    disabled Boolean
    Tells if the notification is enabled or not.

    RetryPolicyResponse

    RetryCount int
    Retry count for user request
    RetryWindowInMinutes int
    Retry window in minutes for user request
    RetryCount int
    Retry count for user request
    RetryWindowInMinutes int
    Retry window in minutes for user request
    retryCount Integer
    Retry count for user request
    retryWindowInMinutes Integer
    Retry window in minutes for user request
    retryCount number
    Retry count for user request
    retryWindowInMinutes number
    Retry window in minutes for user request
    retry_count int
    Retry count for user request
    retry_window_in_minutes int
    Retry window in minutes for user request
    retryCount Number
    Retry count for user request
    retryWindowInMinutes Number
    Retry window in minutes for user request

    ScheduledActionPropertiesResponse

    ActionType string
    The action the scheduled action should perform in the resources
    NotificationSettings List<Pulumi.AzureNative.ComputeSchedule.Inputs.NotificationPropertiesResponse>
    The notification settings for the scheduled action
    ProvisioningState string
    The status of the last provisioning operation performed on the resource.
    ResourceType string
    The type of resource the scheduled action is targeting
    Schedule Pulumi.AzureNative.ComputeSchedule.Inputs.ScheduledActionsScheduleResponse
    The schedule the scheduled action is supposed to follow
    StartTime string
    The time which the scheduled action is supposed to start running
    Disabled bool
    Tell if the scheduled action is disabled or not
    EndTime string
    The time when the scheduled action is supposed to stop scheduling
    ActionType string
    The action the scheduled action should perform in the resources
    NotificationSettings []NotificationPropertiesResponse
    The notification settings for the scheduled action
    ProvisioningState string
    The status of the last provisioning operation performed on the resource.
    ResourceType string
    The type of resource the scheduled action is targeting
    Schedule ScheduledActionsScheduleResponse
    The schedule the scheduled action is supposed to follow
    StartTime string
    The time which the scheduled action is supposed to start running
    Disabled bool
    Tell if the scheduled action is disabled or not
    EndTime string
    The time when the scheduled action is supposed to stop scheduling
    actionType String
    The action the scheduled action should perform in the resources
    notificationSettings List<NotificationPropertiesResponse>
    The notification settings for the scheduled action
    provisioningState String
    The status of the last provisioning operation performed on the resource.
    resourceType String
    The type of resource the scheduled action is targeting
    schedule ScheduledActionsScheduleResponse
    The schedule the scheduled action is supposed to follow
    startTime String
    The time which the scheduled action is supposed to start running
    disabled Boolean
    Tell if the scheduled action is disabled or not
    endTime String
    The time when the scheduled action is supposed to stop scheduling
    actionType string
    The action the scheduled action should perform in the resources
    notificationSettings NotificationPropertiesResponse[]
    The notification settings for the scheduled action
    provisioningState string
    The status of the last provisioning operation performed on the resource.
    resourceType string
    The type of resource the scheduled action is targeting
    schedule ScheduledActionsScheduleResponse
    The schedule the scheduled action is supposed to follow
    startTime string
    The time which the scheduled action is supposed to start running
    disabled boolean
    Tell if the scheduled action is disabled or not
    endTime string
    The time when the scheduled action is supposed to stop scheduling
    action_type str
    The action the scheduled action should perform in the resources
    notification_settings Sequence[NotificationPropertiesResponse]
    The notification settings for the scheduled action
    provisioning_state str
    The status of the last provisioning operation performed on the resource.
    resource_type str
    The type of resource the scheduled action is targeting
    schedule ScheduledActionsScheduleResponse
    The schedule the scheduled action is supposed to follow
    start_time str
    The time which the scheduled action is supposed to start running
    disabled bool
    Tell if the scheduled action is disabled or not
    end_time str
    The time when the scheduled action is supposed to stop scheduling
    actionType String
    The action the scheduled action should perform in the resources
    notificationSettings List<Property Map>
    The notification settings for the scheduled action
    provisioningState String
    The status of the last provisioning operation performed on the resource.
    resourceType String
    The type of resource the scheduled action is targeting
    schedule Property Map
    The schedule the scheduled action is supposed to follow
    startTime String
    The time which the scheduled action is supposed to start running
    disabled Boolean
    Tell if the scheduled action is disabled or not
    endTime String
    The time when the scheduled action is supposed to stop scheduling

    ScheduledActionsScheduleResponse

    RequestedDaysOfTheMonth List<int>
    The days of the month the scheduled action is supposed to run on. If empty, it means it will run on every day of the month.
    RequestedMonths List<string>
    The months the scheduled action is supposed to run on
    RequestedWeekDays List<string>
    The week days the scheduled action is supposed to run on
    ScheduledTime string
    The time the scheduled action is supposed to run on
    TimeZone string
    The timezone the scheduled time is specified on
    DeadlineType string
    The type of deadline the scheduled action is supposed to follow for the schedule. If no value is passed, it will default to InitiateAt.
    ExecutionParameters Pulumi.AzureNative.ComputeSchedule.Inputs.ExecutionParametersResponse
    The execution parameters the scheduled action is supposed to follow
    RequestedDaysOfTheMonth []int
    The days of the month the scheduled action is supposed to run on. If empty, it means it will run on every day of the month.
    RequestedMonths []string
    The months the scheduled action is supposed to run on
    RequestedWeekDays []string
    The week days the scheduled action is supposed to run on
    ScheduledTime string
    The time the scheduled action is supposed to run on
    TimeZone string
    The timezone the scheduled time is specified on
    DeadlineType string
    The type of deadline the scheduled action is supposed to follow for the schedule. If no value is passed, it will default to InitiateAt.
    ExecutionParameters ExecutionParametersResponse
    The execution parameters the scheduled action is supposed to follow
    requestedDaysOfTheMonth List<Integer>
    The days of the month the scheduled action is supposed to run on. If empty, it means it will run on every day of the month.
    requestedMonths List<String>
    The months the scheduled action is supposed to run on
    requestedWeekDays List<String>
    The week days the scheduled action is supposed to run on
    scheduledTime String
    The time the scheduled action is supposed to run on
    timeZone String
    The timezone the scheduled time is specified on
    deadlineType String
    The type of deadline the scheduled action is supposed to follow for the schedule. If no value is passed, it will default to InitiateAt.
    executionParameters ExecutionParametersResponse
    The execution parameters the scheduled action is supposed to follow
    requestedDaysOfTheMonth number[]
    The days of the month the scheduled action is supposed to run on. If empty, it means it will run on every day of the month.
    requestedMonths string[]
    The months the scheduled action is supposed to run on
    requestedWeekDays string[]
    The week days the scheduled action is supposed to run on
    scheduledTime string
    The time the scheduled action is supposed to run on
    timeZone string
    The timezone the scheduled time is specified on
    deadlineType string
    The type of deadline the scheduled action is supposed to follow for the schedule. If no value is passed, it will default to InitiateAt.
    executionParameters ExecutionParametersResponse
    The execution parameters the scheduled action is supposed to follow
    requested_days_of_the_month Sequence[int]
    The days of the month the scheduled action is supposed to run on. If empty, it means it will run on every day of the month.
    requested_months Sequence[str]
    The months the scheduled action is supposed to run on
    requested_week_days Sequence[str]
    The week days the scheduled action is supposed to run on
    scheduled_time str
    The time the scheduled action is supposed to run on
    time_zone str
    The timezone the scheduled time is specified on
    deadline_type str
    The type of deadline the scheduled action is supposed to follow for the schedule. If no value is passed, it will default to InitiateAt.
    execution_parameters ExecutionParametersResponse
    The execution parameters the scheduled action is supposed to follow
    requestedDaysOfTheMonth List<Number>
    The days of the month the scheduled action is supposed to run on. If empty, it means it will run on every day of the month.
    requestedMonths List<String>
    The months the scheduled action is supposed to run on
    requestedWeekDays List<String>
    The week days the scheduled action is supposed to run on
    scheduledTime String
    The time the scheduled action is supposed to run on
    timeZone String
    The timezone the scheduled time is specified on
    deadlineType String
    The type of deadline the scheduled action is supposed to follow for the schedule. If no value is passed, it will default to InitiateAt.
    executionParameters Property Map
    The execution parameters the scheduled action is supposed to follow

    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.

    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.6.1 published on Friday, Aug 1, 2025 by Pulumi
    pulumi/pulumi-azure-native