1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. OsManagementHub
  5. getScheduledJob
Oracle Cloud Infrastructure v2.11.0 published on Thursday, Sep 19, 2024 by Pulumi

oci.OsManagementHub.getScheduledJob

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.11.0 published on Thursday, Sep 19, 2024 by Pulumi

    This data source provides details about a specific Scheduled Job resource in Oracle Cloud Infrastructure Os Management Hub service.

    Gets information about the specified scheduled job.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testScheduledJob = oci.OsManagementHub.getScheduledJob({
        scheduledJobId: testScheduledJobOciOsManagementHubScheduledJob.id,
    });
    
    import pulumi
    import pulumi_oci as oci
    
    test_scheduled_job = oci.OsManagementHub.get_scheduled_job(scheduled_job_id=test_scheduled_job_oci_os_management_hub_scheduled_job["id"])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/OsManagementHub"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := OsManagementHub.GetScheduledJob(ctx, &osmanagementhub.GetScheduledJobArgs{
    			ScheduledJobId: testScheduledJobOciOsManagementHubScheduledJob.Id,
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Oci = Pulumi.Oci;
    
    return await Deployment.RunAsync(() => 
    {
        var testScheduledJob = Oci.OsManagementHub.GetScheduledJob.Invoke(new()
        {
            ScheduledJobId = testScheduledJobOciOsManagementHubScheduledJob.Id,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.oci.OsManagementHub.OsManagementHubFunctions;
    import com.pulumi.oci.OsManagementHub.inputs.GetScheduledJobArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var testScheduledJob = OsManagementHubFunctions.getScheduledJob(GetScheduledJobArgs.builder()
                .scheduledJobId(testScheduledJobOciOsManagementHubScheduledJob.id())
                .build());
    
        }
    }
    
    variables:
      testScheduledJob:
        fn::invoke:
          Function: oci:OsManagementHub:getScheduledJob
          Arguments:
            scheduledJobId: ${testScheduledJobOciOsManagementHubScheduledJob.id}
    

    Using getScheduledJob

    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 getScheduledJob(args: GetScheduledJobArgs, opts?: InvokeOptions): Promise<GetScheduledJobResult>
    function getScheduledJobOutput(args: GetScheduledJobOutputArgs, opts?: InvokeOptions): Output<GetScheduledJobResult>
    def get_scheduled_job(scheduled_job_id: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetScheduledJobResult
    def get_scheduled_job_output(scheduled_job_id: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetScheduledJobResult]
    func GetScheduledJob(ctx *Context, args *GetScheduledJobArgs, opts ...InvokeOption) (*GetScheduledJobResult, error)
    func GetScheduledJobOutput(ctx *Context, args *GetScheduledJobOutputArgs, opts ...InvokeOption) GetScheduledJobResultOutput

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

    public static class GetScheduledJob 
    {
        public static Task<GetScheduledJobResult> InvokeAsync(GetScheduledJobArgs args, InvokeOptions? opts = null)
        public static Output<GetScheduledJobResult> Invoke(GetScheduledJobInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetScheduledJobResult> getScheduledJob(GetScheduledJobArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: oci:OsManagementHub/getScheduledJob:getScheduledJob
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ScheduledJobId string
    The OCID of the scheduled job.
    ScheduledJobId string
    The OCID of the scheduled job.
    scheduledJobId String
    The OCID of the scheduled job.
    scheduledJobId string
    The OCID of the scheduled job.
    scheduled_job_id str
    The OCID of the scheduled job.
    scheduledJobId String
    The OCID of the scheduled job.

    getScheduledJob Result

    The following output properties are available:

    CompartmentId string
    The OCID of the compartment that contains the scheduled job.
    DefinedTags Dictionary<string, string>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    Description string
    User-specified description for the scheduled job.
    DisplayName string
    User-friendly name for the scheduled job.
    FreeformTags Dictionary<string, string>
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    Id string
    The OCID of the scheduled job.
    IsManagedByAutonomousLinux bool
    Indicates whether this scheduled job is managed by the Autonomous Linux service.
    IsRestricted bool
    Indicates if the schedule job has restricted update and deletion capabilities. For restricted scheduled jobs, you can update only the timeNextExecution, recurringRule, and tags.
    IsSubcompartmentIncluded bool
    Indicates whether to apply the scheduled job to all compartments in the tenancy when managedCompartmentIds specifies the tenancy OCID (root compartment).
    LifecycleStageIds List<string>
    The lifecycle stage OCIDs that this scheduled job operates on. A scheduled job can only operate on one type of target, therefore this parameter is mutually exclusive with managedInstanceIds, managedInstanceGroupIds, and managedCompartmentIds.
    Locations List<string>
    The list of locations this scheduled job should operate on for a job targeting on compartments. (Empty list means apply to all locations). This can only be set when managedCompartmentIds is not empty.
    ManagedCompartmentIds List<string>
    The compartment OCIDs that this scheduled job operates on. A scheduled job can only operate on one type of target, therefore this parameter is mutually exclusive with managedInstanceIds, managedInstanceGroupIds, and lifecycleStageIds.
    ManagedInstanceGroupIds List<string>
    The managed instance group OCIDs that this scheduled job operates on. A scheduled job can only operate on one type of target, therefore this parameter is mutually exclusive with managedInstanceIds, managedCompartmentIds, and lifecycleStageIds.
    ManagedInstanceIds List<string>
    The managed instance OCIDs that this scheduled job operates on. A scheduled job can only operate on one type of target, therefore this parameter is mutually exclusive with managedInstanceGroupIds, managedCompartmentIds, and lifecycleStageIds.
    Operations List<GetScheduledJobOperation>
    The list of operations this scheduled job needs to perform. A scheduled job supports only one operation type, unless it is one of the following:

    • UPDATE_PACKAGES
    • UPDATE_ALL
    • UPDATE_SECURITY
    • UPDATE_BUGFIX
    • UPDATE_ENHANCEMENT
    • UPDATE_OTHER
    • UPDATE_KSPLICE_USERSPACE
    • UPDATE_KSPLICE_KERNEL
    RecurringRule string
    The frequency schedule for a recurring scheduled job.
    RetryIntervals List<int>
    The amount of time in minutes to wait until retrying the scheduled job. If set, the service will automatically retry a failed scheduled job after the interval. For example, you could set the interval to [2,5,10]. If the initial execution of the job fails, the service waits 2 minutes and then retries. If that fails, the service waits 5 minutes and then retries. If that fails, the service waits 10 minutes and then retries.
    ScheduleType string
    The type of scheduling frequency for the job.
    ScheduledJobId string
    State string
    The current state of the scheduled job.
    SystemTags Dictionary<string, string>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The time this scheduled job was created (in RFC 3339 format).
    TimeLastExecution string
    The time of the last execution of this scheduled job (in RFC 3339 format).
    TimeNextExecution string
    The time of the next execution of this scheduled job (in RFC 3339 format).
    TimeUpdated string
    The time this scheduled job was updated (in RFC 3339 format).
    WorkRequestIds List<string>
    The list of work request OCIDs associated with this scheduled job.
    CompartmentId string
    The OCID of the compartment that contains the scheduled job.
    DefinedTags map[string]string
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    Description string
    User-specified description for the scheduled job.
    DisplayName string
    User-friendly name for the scheduled job.
    FreeformTags map[string]string
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    Id string
    The OCID of the scheduled job.
    IsManagedByAutonomousLinux bool
    Indicates whether this scheduled job is managed by the Autonomous Linux service.
    IsRestricted bool
    Indicates if the schedule job has restricted update and deletion capabilities. For restricted scheduled jobs, you can update only the timeNextExecution, recurringRule, and tags.
    IsSubcompartmentIncluded bool
    Indicates whether to apply the scheduled job to all compartments in the tenancy when managedCompartmentIds specifies the tenancy OCID (root compartment).
    LifecycleStageIds []string
    The lifecycle stage OCIDs that this scheduled job operates on. A scheduled job can only operate on one type of target, therefore this parameter is mutually exclusive with managedInstanceIds, managedInstanceGroupIds, and managedCompartmentIds.
    Locations []string
    The list of locations this scheduled job should operate on for a job targeting on compartments. (Empty list means apply to all locations). This can only be set when managedCompartmentIds is not empty.
    ManagedCompartmentIds []string
    The compartment OCIDs that this scheduled job operates on. A scheduled job can only operate on one type of target, therefore this parameter is mutually exclusive with managedInstanceIds, managedInstanceGroupIds, and lifecycleStageIds.
    ManagedInstanceGroupIds []string
    The managed instance group OCIDs that this scheduled job operates on. A scheduled job can only operate on one type of target, therefore this parameter is mutually exclusive with managedInstanceIds, managedCompartmentIds, and lifecycleStageIds.
    ManagedInstanceIds []string
    The managed instance OCIDs that this scheduled job operates on. A scheduled job can only operate on one type of target, therefore this parameter is mutually exclusive with managedInstanceGroupIds, managedCompartmentIds, and lifecycleStageIds.
    Operations []GetScheduledJobOperation
    The list of operations this scheduled job needs to perform. A scheduled job supports only one operation type, unless it is one of the following:

    • UPDATE_PACKAGES
    • UPDATE_ALL
    • UPDATE_SECURITY
    • UPDATE_BUGFIX
    • UPDATE_ENHANCEMENT
    • UPDATE_OTHER
    • UPDATE_KSPLICE_USERSPACE
    • UPDATE_KSPLICE_KERNEL
    RecurringRule string
    The frequency schedule for a recurring scheduled job.
    RetryIntervals []int
    The amount of time in minutes to wait until retrying the scheduled job. If set, the service will automatically retry a failed scheduled job after the interval. For example, you could set the interval to [2,5,10]. If the initial execution of the job fails, the service waits 2 minutes and then retries. If that fails, the service waits 5 minutes and then retries. If that fails, the service waits 10 minutes and then retries.
    ScheduleType string
    The type of scheduling frequency for the job.
    ScheduledJobId string
    State string
    The current state of the scheduled job.
    SystemTags map[string]string
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The time this scheduled job was created (in RFC 3339 format).
    TimeLastExecution string
    The time of the last execution of this scheduled job (in RFC 3339 format).
    TimeNextExecution string
    The time of the next execution of this scheduled job (in RFC 3339 format).
    TimeUpdated string
    The time this scheduled job was updated (in RFC 3339 format).
    WorkRequestIds []string
    The list of work request OCIDs associated with this scheduled job.
    compartmentId String
    The OCID of the compartment that contains the scheduled job.
    definedTags Map<String,String>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description String
    User-specified description for the scheduled job.
    displayName String
    User-friendly name for the scheduled job.
    freeformTags Map<String,String>
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    id String
    The OCID of the scheduled job.
    isManagedByAutonomousLinux Boolean
    Indicates whether this scheduled job is managed by the Autonomous Linux service.
    isRestricted Boolean
    Indicates if the schedule job has restricted update and deletion capabilities. For restricted scheduled jobs, you can update only the timeNextExecution, recurringRule, and tags.
    isSubcompartmentIncluded Boolean
    Indicates whether to apply the scheduled job to all compartments in the tenancy when managedCompartmentIds specifies the tenancy OCID (root compartment).
    lifecycleStageIds List<String>
    The lifecycle stage OCIDs that this scheduled job operates on. A scheduled job can only operate on one type of target, therefore this parameter is mutually exclusive with managedInstanceIds, managedInstanceGroupIds, and managedCompartmentIds.
    locations List<String>
    The list of locations this scheduled job should operate on for a job targeting on compartments. (Empty list means apply to all locations). This can only be set when managedCompartmentIds is not empty.
    managedCompartmentIds List<String>
    The compartment OCIDs that this scheduled job operates on. A scheduled job can only operate on one type of target, therefore this parameter is mutually exclusive with managedInstanceIds, managedInstanceGroupIds, and lifecycleStageIds.
    managedInstanceGroupIds List<String>
    The managed instance group OCIDs that this scheduled job operates on. A scheduled job can only operate on one type of target, therefore this parameter is mutually exclusive with managedInstanceIds, managedCompartmentIds, and lifecycleStageIds.
    managedInstanceIds List<String>
    The managed instance OCIDs that this scheduled job operates on. A scheduled job can only operate on one type of target, therefore this parameter is mutually exclusive with managedInstanceGroupIds, managedCompartmentIds, and lifecycleStageIds.
    operations List<GetScheduledJobOperation>
    The list of operations this scheduled job needs to perform. A scheduled job supports only one operation type, unless it is one of the following:

    • UPDATE_PACKAGES
    • UPDATE_ALL
    • UPDATE_SECURITY
    • UPDATE_BUGFIX
    • UPDATE_ENHANCEMENT
    • UPDATE_OTHER
    • UPDATE_KSPLICE_USERSPACE
    • UPDATE_KSPLICE_KERNEL
    recurringRule String
    The frequency schedule for a recurring scheduled job.
    retryIntervals List<Integer>
    The amount of time in minutes to wait until retrying the scheduled job. If set, the service will automatically retry a failed scheduled job after the interval. For example, you could set the interval to [2,5,10]. If the initial execution of the job fails, the service waits 2 minutes and then retries. If that fails, the service waits 5 minutes and then retries. If that fails, the service waits 10 minutes and then retries.
    scheduleType String
    The type of scheduling frequency for the job.
    scheduledJobId String
    state String
    The current state of the scheduled job.
    systemTags Map<String,String>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The time this scheduled job was created (in RFC 3339 format).
    timeLastExecution String
    The time of the last execution of this scheduled job (in RFC 3339 format).
    timeNextExecution String
    The time of the next execution of this scheduled job (in RFC 3339 format).
    timeUpdated String
    The time this scheduled job was updated (in RFC 3339 format).
    workRequestIds List<String>
    The list of work request OCIDs associated with this scheduled job.
    compartmentId string
    The OCID of the compartment that contains the scheduled job.
    definedTags {[key: string]: string}
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description string
    User-specified description for the scheduled job.
    displayName string
    User-friendly name for the scheduled job.
    freeformTags {[key: string]: string}
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    id string
    The OCID of the scheduled job.
    isManagedByAutonomousLinux boolean
    Indicates whether this scheduled job is managed by the Autonomous Linux service.
    isRestricted boolean
    Indicates if the schedule job has restricted update and deletion capabilities. For restricted scheduled jobs, you can update only the timeNextExecution, recurringRule, and tags.
    isSubcompartmentIncluded boolean
    Indicates whether to apply the scheduled job to all compartments in the tenancy when managedCompartmentIds specifies the tenancy OCID (root compartment).
    lifecycleStageIds string[]
    The lifecycle stage OCIDs that this scheduled job operates on. A scheduled job can only operate on one type of target, therefore this parameter is mutually exclusive with managedInstanceIds, managedInstanceGroupIds, and managedCompartmentIds.
    locations string[]
    The list of locations this scheduled job should operate on for a job targeting on compartments. (Empty list means apply to all locations). This can only be set when managedCompartmentIds is not empty.
    managedCompartmentIds string[]
    The compartment OCIDs that this scheduled job operates on. A scheduled job can only operate on one type of target, therefore this parameter is mutually exclusive with managedInstanceIds, managedInstanceGroupIds, and lifecycleStageIds.
    managedInstanceGroupIds string[]
    The managed instance group OCIDs that this scheduled job operates on. A scheduled job can only operate on one type of target, therefore this parameter is mutually exclusive with managedInstanceIds, managedCompartmentIds, and lifecycleStageIds.
    managedInstanceIds string[]
    The managed instance OCIDs that this scheduled job operates on. A scheduled job can only operate on one type of target, therefore this parameter is mutually exclusive with managedInstanceGroupIds, managedCompartmentIds, and lifecycleStageIds.
    operations GetScheduledJobOperation[]
    The list of operations this scheduled job needs to perform. A scheduled job supports only one operation type, unless it is one of the following:

    • UPDATE_PACKAGES
    • UPDATE_ALL
    • UPDATE_SECURITY
    • UPDATE_BUGFIX
    • UPDATE_ENHANCEMENT
    • UPDATE_OTHER
    • UPDATE_KSPLICE_USERSPACE
    • UPDATE_KSPLICE_KERNEL
    recurringRule string
    The frequency schedule for a recurring scheduled job.
    retryIntervals number[]
    The amount of time in minutes to wait until retrying the scheduled job. If set, the service will automatically retry a failed scheduled job after the interval. For example, you could set the interval to [2,5,10]. If the initial execution of the job fails, the service waits 2 minutes and then retries. If that fails, the service waits 5 minutes and then retries. If that fails, the service waits 10 minutes and then retries.
    scheduleType string
    The type of scheduling frequency for the job.
    scheduledJobId string
    state string
    The current state of the scheduled job.
    systemTags {[key: string]: string}
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated string
    The time this scheduled job was created (in RFC 3339 format).
    timeLastExecution string
    The time of the last execution of this scheduled job (in RFC 3339 format).
    timeNextExecution string
    The time of the next execution of this scheduled job (in RFC 3339 format).
    timeUpdated string
    The time this scheduled job was updated (in RFC 3339 format).
    workRequestIds string[]
    The list of work request OCIDs associated with this scheduled job.
    compartment_id str
    The OCID of the compartment that contains the scheduled job.
    defined_tags Mapping[str, str]
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description str
    User-specified description for the scheduled job.
    display_name str
    User-friendly name for the scheduled job.
    freeform_tags Mapping[str, str]
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    id str
    The OCID of the scheduled job.
    is_managed_by_autonomous_linux bool
    Indicates whether this scheduled job is managed by the Autonomous Linux service.
    is_restricted bool
    Indicates if the schedule job has restricted update and deletion capabilities. For restricted scheduled jobs, you can update only the timeNextExecution, recurringRule, and tags.
    is_subcompartment_included bool
    Indicates whether to apply the scheduled job to all compartments in the tenancy when managedCompartmentIds specifies the tenancy OCID (root compartment).
    lifecycle_stage_ids Sequence[str]
    The lifecycle stage OCIDs that this scheduled job operates on. A scheduled job can only operate on one type of target, therefore this parameter is mutually exclusive with managedInstanceIds, managedInstanceGroupIds, and managedCompartmentIds.
    locations Sequence[str]
    The list of locations this scheduled job should operate on for a job targeting on compartments. (Empty list means apply to all locations). This can only be set when managedCompartmentIds is not empty.
    managed_compartment_ids Sequence[str]
    The compartment OCIDs that this scheduled job operates on. A scheduled job can only operate on one type of target, therefore this parameter is mutually exclusive with managedInstanceIds, managedInstanceGroupIds, and lifecycleStageIds.
    managed_instance_group_ids Sequence[str]
    The managed instance group OCIDs that this scheduled job operates on. A scheduled job can only operate on one type of target, therefore this parameter is mutually exclusive with managedInstanceIds, managedCompartmentIds, and lifecycleStageIds.
    managed_instance_ids Sequence[str]
    The managed instance OCIDs that this scheduled job operates on. A scheduled job can only operate on one type of target, therefore this parameter is mutually exclusive with managedInstanceGroupIds, managedCompartmentIds, and lifecycleStageIds.
    operations Sequence[osmanagementhub.GetScheduledJobOperation]
    The list of operations this scheduled job needs to perform. A scheduled job supports only one operation type, unless it is one of the following:

    • UPDATE_PACKAGES
    • UPDATE_ALL
    • UPDATE_SECURITY
    • UPDATE_BUGFIX
    • UPDATE_ENHANCEMENT
    • UPDATE_OTHER
    • UPDATE_KSPLICE_USERSPACE
    • UPDATE_KSPLICE_KERNEL
    recurring_rule str
    The frequency schedule for a recurring scheduled job.
    retry_intervals Sequence[int]
    The amount of time in minutes to wait until retrying the scheduled job. If set, the service will automatically retry a failed scheduled job after the interval. For example, you could set the interval to [2,5,10]. If the initial execution of the job fails, the service waits 2 minutes and then retries. If that fails, the service waits 5 minutes and then retries. If that fails, the service waits 10 minutes and then retries.
    schedule_type str
    The type of scheduling frequency for the job.
    scheduled_job_id str
    state str
    The current state of the scheduled job.
    system_tags Mapping[str, str]
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    time_created str
    The time this scheduled job was created (in RFC 3339 format).
    time_last_execution str
    The time of the last execution of this scheduled job (in RFC 3339 format).
    time_next_execution str
    The time of the next execution of this scheduled job (in RFC 3339 format).
    time_updated str
    The time this scheduled job was updated (in RFC 3339 format).
    work_request_ids Sequence[str]
    The list of work request OCIDs associated with this scheduled job.
    compartmentId String
    The OCID of the compartment that contains the scheduled job.
    definedTags Map<String>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description String
    User-specified description for the scheduled job.
    displayName String
    User-friendly name for the scheduled job.
    freeformTags Map<String>
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    id String
    The OCID of the scheduled job.
    isManagedByAutonomousLinux Boolean
    Indicates whether this scheduled job is managed by the Autonomous Linux service.
    isRestricted Boolean
    Indicates if the schedule job has restricted update and deletion capabilities. For restricted scheduled jobs, you can update only the timeNextExecution, recurringRule, and tags.
    isSubcompartmentIncluded Boolean
    Indicates whether to apply the scheduled job to all compartments in the tenancy when managedCompartmentIds specifies the tenancy OCID (root compartment).
    lifecycleStageIds List<String>
    The lifecycle stage OCIDs that this scheduled job operates on. A scheduled job can only operate on one type of target, therefore this parameter is mutually exclusive with managedInstanceIds, managedInstanceGroupIds, and managedCompartmentIds.
    locations List<String>
    The list of locations this scheduled job should operate on for a job targeting on compartments. (Empty list means apply to all locations). This can only be set when managedCompartmentIds is not empty.
    managedCompartmentIds List<String>
    The compartment OCIDs that this scheduled job operates on. A scheduled job can only operate on one type of target, therefore this parameter is mutually exclusive with managedInstanceIds, managedInstanceGroupIds, and lifecycleStageIds.
    managedInstanceGroupIds List<String>
    The managed instance group OCIDs that this scheduled job operates on. A scheduled job can only operate on one type of target, therefore this parameter is mutually exclusive with managedInstanceIds, managedCompartmentIds, and lifecycleStageIds.
    managedInstanceIds List<String>
    The managed instance OCIDs that this scheduled job operates on. A scheduled job can only operate on one type of target, therefore this parameter is mutually exclusive with managedInstanceGroupIds, managedCompartmentIds, and lifecycleStageIds.
    operations List<Property Map>
    The list of operations this scheduled job needs to perform. A scheduled job supports only one operation type, unless it is one of the following:

    • UPDATE_PACKAGES
    • UPDATE_ALL
    • UPDATE_SECURITY
    • UPDATE_BUGFIX
    • UPDATE_ENHANCEMENT
    • UPDATE_OTHER
    • UPDATE_KSPLICE_USERSPACE
    • UPDATE_KSPLICE_KERNEL
    recurringRule String
    The frequency schedule for a recurring scheduled job.
    retryIntervals List<Number>
    The amount of time in minutes to wait until retrying the scheduled job. If set, the service will automatically retry a failed scheduled job after the interval. For example, you could set the interval to [2,5,10]. If the initial execution of the job fails, the service waits 2 minutes and then retries. If that fails, the service waits 5 minutes and then retries. If that fails, the service waits 10 minutes and then retries.
    scheduleType String
    The type of scheduling frequency for the job.
    scheduledJobId String
    state String
    The current state of the scheduled job.
    systemTags Map<String>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The time this scheduled job was created (in RFC 3339 format).
    timeLastExecution String
    The time of the last execution of this scheduled job (in RFC 3339 format).
    timeNextExecution String
    The time of the next execution of this scheduled job (in RFC 3339 format).
    timeUpdated String
    The time this scheduled job was updated (in RFC 3339 format).
    workRequestIds List<String>
    The list of work request OCIDs associated with this scheduled job.

    Supporting Types

    GetScheduledJobOperation

    ManageModuleStreamsDetails List<GetScheduledJobOperationManageModuleStreamsDetail>
    The set of changes to make to the state of the modules, streams, and profiles on the managed target.
    OperationType string
    The type of operation this scheduled job performs.
    PackageNames List<string>
    The names of the target packages. This parameter only applies when the scheduled job is for installing, updating, or removing packages.
    SoftwareSourceIds List<string>
    The software source OCIDs. This parameter only applies when the scheduled job is for attaching or detaching software sources.
    SwitchModuleStreamsDetails List<GetScheduledJobOperationSwitchModuleStreamsDetail>
    Provides the information used to update a module stream.
    WindowsUpdateNames List<string>
    Unique identifier for the Windows update. This parameter only applies if the scheduled job is for installing Windows updates. Note that this is not an OCID, but is a unique identifier assigned by Microsoft. For example: '6981d463-cd91-4a26-b7c4-ea4ded9183ed'.
    ManageModuleStreamsDetails []GetScheduledJobOperationManageModuleStreamsDetail
    The set of changes to make to the state of the modules, streams, and profiles on the managed target.
    OperationType string
    The type of operation this scheduled job performs.
    PackageNames []string
    The names of the target packages. This parameter only applies when the scheduled job is for installing, updating, or removing packages.
    SoftwareSourceIds []string
    The software source OCIDs. This parameter only applies when the scheduled job is for attaching or detaching software sources.
    SwitchModuleStreamsDetails []GetScheduledJobOperationSwitchModuleStreamsDetail
    Provides the information used to update a module stream.
    WindowsUpdateNames []string
    Unique identifier for the Windows update. This parameter only applies if the scheduled job is for installing Windows updates. Note that this is not an OCID, but is a unique identifier assigned by Microsoft. For example: '6981d463-cd91-4a26-b7c4-ea4ded9183ed'.
    manageModuleStreamsDetails List<GetScheduledJobOperationManageModuleStreamsDetail>
    The set of changes to make to the state of the modules, streams, and profiles on the managed target.
    operationType String
    The type of operation this scheduled job performs.
    packageNames List<String>
    The names of the target packages. This parameter only applies when the scheduled job is for installing, updating, or removing packages.
    softwareSourceIds List<String>
    The software source OCIDs. This parameter only applies when the scheduled job is for attaching or detaching software sources.
    switchModuleStreamsDetails List<GetScheduledJobOperationSwitchModuleStreamsDetail>
    Provides the information used to update a module stream.
    windowsUpdateNames List<String>
    Unique identifier for the Windows update. This parameter only applies if the scheduled job is for installing Windows updates. Note that this is not an OCID, but is a unique identifier assigned by Microsoft. For example: '6981d463-cd91-4a26-b7c4-ea4ded9183ed'.
    manageModuleStreamsDetails GetScheduledJobOperationManageModuleStreamsDetail[]
    The set of changes to make to the state of the modules, streams, and profiles on the managed target.
    operationType string
    The type of operation this scheduled job performs.
    packageNames string[]
    The names of the target packages. This parameter only applies when the scheduled job is for installing, updating, or removing packages.
    softwareSourceIds string[]
    The software source OCIDs. This parameter only applies when the scheduled job is for attaching or detaching software sources.
    switchModuleStreamsDetails GetScheduledJobOperationSwitchModuleStreamsDetail[]
    Provides the information used to update a module stream.
    windowsUpdateNames string[]
    Unique identifier for the Windows update. This parameter only applies if the scheduled job is for installing Windows updates. Note that this is not an OCID, but is a unique identifier assigned by Microsoft. For example: '6981d463-cd91-4a26-b7c4-ea4ded9183ed'.
    manage_module_streams_details Sequence[osmanagementhub.GetScheduledJobOperationManageModuleStreamsDetail]
    The set of changes to make to the state of the modules, streams, and profiles on the managed target.
    operation_type str
    The type of operation this scheduled job performs.
    package_names Sequence[str]
    The names of the target packages. This parameter only applies when the scheduled job is for installing, updating, or removing packages.
    software_source_ids Sequence[str]
    The software source OCIDs. This parameter only applies when the scheduled job is for attaching or detaching software sources.
    switch_module_streams_details Sequence[osmanagementhub.GetScheduledJobOperationSwitchModuleStreamsDetail]
    Provides the information used to update a module stream.
    windows_update_names Sequence[str]
    Unique identifier for the Windows update. This parameter only applies if the scheduled job is for installing Windows updates. Note that this is not an OCID, but is a unique identifier assigned by Microsoft. For example: '6981d463-cd91-4a26-b7c4-ea4ded9183ed'.
    manageModuleStreamsDetails List<Property Map>
    The set of changes to make to the state of the modules, streams, and profiles on the managed target.
    operationType String
    The type of operation this scheduled job performs.
    packageNames List<String>
    The names of the target packages. This parameter only applies when the scheduled job is for installing, updating, or removing packages.
    softwareSourceIds List<String>
    The software source OCIDs. This parameter only applies when the scheduled job is for attaching or detaching software sources.
    switchModuleStreamsDetails List<Property Map>
    Provides the information used to update a module stream.
    windowsUpdateNames List<String>
    Unique identifier for the Windows update. This parameter only applies if the scheduled job is for installing Windows updates. Note that this is not an OCID, but is a unique identifier assigned by Microsoft. For example: '6981d463-cd91-4a26-b7c4-ea4ded9183ed'.

    GetScheduledJobOperationManageModuleStreamsDetail

    disables List<Property Map>
    The set of module streams to disable.
    enables List<Property Map>
    The set of module streams to enable.
    installs List<Property Map>
    The set of module stream profiles to install.
    removes List<Property Map>
    The set of module stream profiles to remove.

    GetScheduledJobOperationManageModuleStreamsDetailDisable

    ModuleName string
    The name of a module.
    SoftwareSourceId string
    The OCID of the software source that contains the module stream.
    StreamName string
    The name of a stream of the specified module.
    ModuleName string
    The name of a module.
    SoftwareSourceId string
    The OCID of the software source that contains the module stream.
    StreamName string
    The name of a stream of the specified module.
    moduleName String
    The name of a module.
    softwareSourceId String
    The OCID of the software source that contains the module stream.
    streamName String
    The name of a stream of the specified module.
    moduleName string
    The name of a module.
    softwareSourceId string
    The OCID of the software source that contains the module stream.
    streamName string
    The name of a stream of the specified module.
    module_name str
    The name of a module.
    software_source_id str
    The OCID of the software source that contains the module stream.
    stream_name str
    The name of a stream of the specified module.
    moduleName String
    The name of a module.
    softwareSourceId String
    The OCID of the software source that contains the module stream.
    streamName String
    The name of a stream of the specified module.

    GetScheduledJobOperationManageModuleStreamsDetailEnable

    ModuleName string
    The name of a module.
    SoftwareSourceId string
    The OCID of the software source that contains the module stream.
    StreamName string
    The name of a stream of the specified module.
    ModuleName string
    The name of a module.
    SoftwareSourceId string
    The OCID of the software source that contains the module stream.
    StreamName string
    The name of a stream of the specified module.
    moduleName String
    The name of a module.
    softwareSourceId String
    The OCID of the software source that contains the module stream.
    streamName String
    The name of a stream of the specified module.
    moduleName string
    The name of a module.
    softwareSourceId string
    The OCID of the software source that contains the module stream.
    streamName string
    The name of a stream of the specified module.
    module_name str
    The name of a module.
    software_source_id str
    The OCID of the software source that contains the module stream.
    stream_name str
    The name of a stream of the specified module.
    moduleName String
    The name of a module.
    softwareSourceId String
    The OCID of the software source that contains the module stream.
    streamName String
    The name of a stream of the specified module.

    GetScheduledJobOperationManageModuleStreamsDetailInstall

    ModuleName string
    The name of a module.
    ProfileName string
    The name of a profile of the specified module stream.
    SoftwareSourceId string
    The OCID of the software source that contains the module stream.
    StreamName string
    The name of a stream of the specified module.
    ModuleName string
    The name of a module.
    ProfileName string
    The name of a profile of the specified module stream.
    SoftwareSourceId string
    The OCID of the software source that contains the module stream.
    StreamName string
    The name of a stream of the specified module.
    moduleName String
    The name of a module.
    profileName String
    The name of a profile of the specified module stream.
    softwareSourceId String
    The OCID of the software source that contains the module stream.
    streamName String
    The name of a stream of the specified module.
    moduleName string
    The name of a module.
    profileName string
    The name of a profile of the specified module stream.
    softwareSourceId string
    The OCID of the software source that contains the module stream.
    streamName string
    The name of a stream of the specified module.
    module_name str
    The name of a module.
    profile_name str
    The name of a profile of the specified module stream.
    software_source_id str
    The OCID of the software source that contains the module stream.
    stream_name str
    The name of a stream of the specified module.
    moduleName String
    The name of a module.
    profileName String
    The name of a profile of the specified module stream.
    softwareSourceId String
    The OCID of the software source that contains the module stream.
    streamName String
    The name of a stream of the specified module.

    GetScheduledJobOperationManageModuleStreamsDetailRemove

    ModuleName string
    The name of a module.
    ProfileName string
    The name of a profile of the specified module stream.
    SoftwareSourceId string
    The OCID of the software source that contains the module stream.
    StreamName string
    The name of a stream of the specified module.
    ModuleName string
    The name of a module.
    ProfileName string
    The name of a profile of the specified module stream.
    SoftwareSourceId string
    The OCID of the software source that contains the module stream.
    StreamName string
    The name of a stream of the specified module.
    moduleName String
    The name of a module.
    profileName String
    The name of a profile of the specified module stream.
    softwareSourceId String
    The OCID of the software source that contains the module stream.
    streamName String
    The name of a stream of the specified module.
    moduleName string
    The name of a module.
    profileName string
    The name of a profile of the specified module stream.
    softwareSourceId string
    The OCID of the software source that contains the module stream.
    streamName string
    The name of a stream of the specified module.
    module_name str
    The name of a module.
    profile_name str
    The name of a profile of the specified module stream.
    software_source_id str
    The OCID of the software source that contains the module stream.
    stream_name str
    The name of a stream of the specified module.
    moduleName String
    The name of a module.
    profileName String
    The name of a profile of the specified module stream.
    softwareSourceId String
    The OCID of the software source that contains the module stream.
    streamName String
    The name of a stream of the specified module.

    GetScheduledJobOperationSwitchModuleStreamsDetail

    ModuleName string
    The name of a module.
    SoftwareSourceId string
    The OCID of the software source that contains the module stream.
    StreamName string
    The name of a stream of the specified module.
    ModuleName string
    The name of a module.
    SoftwareSourceId string
    The OCID of the software source that contains the module stream.
    StreamName string
    The name of a stream of the specified module.
    moduleName String
    The name of a module.
    softwareSourceId String
    The OCID of the software source that contains the module stream.
    streamName String
    The name of a stream of the specified module.
    moduleName string
    The name of a module.
    softwareSourceId string
    The OCID of the software source that contains the module stream.
    streamName string
    The name of a stream of the specified module.
    module_name str
    The name of a module.
    software_source_id str
    The OCID of the software source that contains the module stream.
    stream_name str
    The name of a stream of the specified module.
    moduleName String
    The name of a module.
    softwareSourceId String
    The OCID of the software source that contains the module stream.
    streamName String
    The name of a stream of the specified module.

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v2.11.0 published on Thursday, Sep 19, 2024 by Pulumi