Class JobSchedule

Links an Automation Runbook and Schedule.

Example Usage

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
public MyStack()
{
    var example = new Azure.Automation.JobSchedule("example", new Azure.Automation.JobScheduleArgs
    {
        AutomationAccountName = "tf-automation-account",
        Parameters = 
        {
            { "resourcegroup", "tf-rgr-vm" },
            { "vmname", "TF-VM-01" },
        },
        ResourceGroupName = "tf-rgr-automation",
        RunbookName = "Get-VirtualMachine",
        ScheduleName = "hour",
    });
}

}

Inheritance

System.Object

Resource

CustomResource

JobSchedule

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Azure.Automation

Assembly: Pulumi.Azure.dll

Syntax

public class JobSchedule : CustomResource

Constructors

JobSchedule(String, JobScheduleArgs, CustomResourceOptions)

Create a JobSchedule resource with the given unique name, arguments, and options.

Declaration

public JobSchedule(string name, JobScheduleArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
JobScheduleArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

AutomationAccountName

The name of the Automation Account in which the Job Schedule is created. Changing this forces a new resource to be created.

Declaration

public Output<string> AutomationAccountName { get; }

Property Value

Type	Description
Output<System.String>

JobScheduleId

The UUID identifying the Automation Job Schedule.

Declaration

public Output<string> JobScheduleId { get; }

Property Value

Type	Description
Output<System.String>

Parameters

A map of key/value pairs corresponding to the arguments that can be passed to the Runbook. Changing this forces a new resource to be created.

Declaration

public Output<ImmutableDictionary<string, string>> Parameters { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.String>>

ResourceGroupName

The name of the resource group in which the Job Schedule is created. Changing this forces a new resource to be created.

Declaration

public Output<string> ResourceGroupName { get; }

Property Value

Type	Description
Output<System.String>

RunbookName

The name of a Runbook to link to a Schedule. It needs to be in the same Automation Account as the Schedule and Job Schedule. Changing this forces a new resource to be created.

Declaration

public Output<string> RunbookName { get; }

Property Value

Type	Description
Output<System.String>

RunOn

Name of a Hybrid Worker Group the Runbook will be executed on. Changing this forces a new resource to be created.

Declaration

public Output<string> RunOn { get; }

Property Value

Type	Description
Output<System.String>

ScheduleName

Declaration

public Output<string> ScheduleName { get; }

Property Value

Type	Description
Output<System.String>

Methods

Get(String, Input<String>, JobScheduleState, CustomResourceOptions)

Get an existing JobSchedule resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration

public static JobSchedule Get(string name, Input<string> id, JobScheduleState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
JobScheduleState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
JobSchedule