Module scheduler

@pulumi/azure > scheduler

Index

scheduler/getJobCollection.ts scheduler/job.ts scheduler/jobCollection.ts

class Job

Manages a Scheduler Job.

~> NOTE: Support for Scheduler Job has been deprecated by Microsoft in favour of Logic Apps (more information can be found at this link) - as such we plan to remove support for this resource as a part of version 2.0 of the AzureRM Provider.

constructor

new Job(name: string, args: JobArgs, opts?: pulumi.CustomResourceOptions)

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

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: JobState): Job

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property actionStorageQueue

public actionStorageQueue: pulumi.Output<{ ... } | undefined>;

A action_storage_queue block defining a storage queue job action as described below. Note this is identical to an error_action_storage_queue block.

property actionWeb

public actionWeb: pulumi.Output<{ ... } | undefined>;

A action_web block defining the job action as described below. Note this is identical to an error_action_web block.

property errorActionStorageQueue

public errorActionStorageQueue: pulumi.Output<{ ... } | undefined>;

A error_action_storage_queue block defining the a web action to take on an error as described below. Note this is identical to an action_storage_queue block.

property errorActionWeb

public errorActionWeb: pulumi.Output<{ ... } | undefined>;

A error_action_web block defining the action to take on an error as described below. Note this is identical to an action_web block.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property jobCollectionName

public jobCollectionName: pulumi.Output<string>;

Specifies the name of the Scheduler Job Collection in which the Job should exist. Changing this forces a new resource to be created.

property name

public name: pulumi.Output<string>;

The name of the Scheduler Job. Changing this forces a new resource to be created.

property recurrence

public recurrence: pulumi.Output<{ ... } | undefined>;

A recurrence block defining a job occurrence schedule.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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

property retry

public retry: pulumi.Output<{ ... } | undefined>;

A retry block defining how to retry as described below.

property startTime

public startTime: pulumi.Output<string>;

The time the first instance of the job is to start running at.

property state

public state: pulumi.Output<string>;

The sets or gets the current state of the job. Can be set to either Enabled or Completed

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

class JobCollection

Manages a Scheduler Job Collection.

~> NOTE: Support for Scheduler Job Collections has been deprecated by Microsoft in favour of Logic Apps (more information can be found at this link) - as such we plan to remove support for this resource as a part of version 2.0 of the AzureRM Provider.

constructor

new JobCollection(name: string, args: JobCollectionArgs, opts?: pulumi.CustomResourceOptions)

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

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: JobCollectionState): JobCollection

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property location

public location: pulumi.Output<string>;

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

property name

public name: pulumi.Output<string>;

Specifies the name of the Scheduler Job Collection. Changing this forces a new resource to be created.

property quota

public quota: pulumi.Output<{ ... } | undefined>;

Configures the Job collection quotas as documented in the quota block below.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

The name of the resource group in which to create the Scheduler Job Collection. Changing this forces a new resource to be created.

property sku

public sku: pulumi.Output<string>;

Sets the Job Collection’s pricing level’s SKU. Possible values include: Standard, Free, P10Premium, P20Premium.

property state

public state: pulumi.Output<string | undefined>;

Sets Job Collection’s state. Possible values include: Enabled, Disabled, Suspended.

property tags

public tags: pulumi.Output<{ ... }>;

A mapping of tags to assign to the resource.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

function getJobCollection

getJobCollection(args: GetJobCollectionArgs, opts?: pulumi.InvokeOptions): Promise<GetJobCollectionResult>

Use this data source to access information about an existing Scheduler Job Collection.

~> NOTE: Support for Scheduler Job Collections has been deprecated by Microsoft in favour of Logic Apps (more information can be found at this link) - as such we plan to remove support for this data source as a part of version 2.0 of the AzureRM Provider.

interface GetJobCollectionArgs

A collection of arguments for invoking getJobCollection.

property name

name: string;

Specifies the name of the Scheduler Job Collection.

property resourceGroupName

resourceGroupName: string;

Specifies the name of the resource group in which the Scheduler Job Collection resides.

interface GetJobCollectionResult

A collection of values returned by getJobCollection.

property id

id: string;

id is the provider-assigned unique ID for this managed resource.

property location

location: string;

The Azure location where the resource exists.

property quotas

quotas: { ... }[];

The Job collection quotas as documented in the quota block below.

property sku

sku: string;

The Job Collection’s pricing level’s SKU.

property state

state: string;

The Job Collection’s state.

property tags

tags: { ... };

A mapping of tags assigned to the resource.

interface JobArgs

The set of arguments for constructing a Job resource.

property actionStorageQueue

actionStorageQueue?: pulumi.Input<{ ... }>;

A action_storage_queue block defining a storage queue job action as described below. Note this is identical to an error_action_storage_queue block.

property actionWeb

actionWeb?: pulumi.Input<{ ... }>;

A action_web block defining the job action as described below. Note this is identical to an error_action_web block.

property errorActionStorageQueue

errorActionStorageQueue?: pulumi.Input<{ ... }>;

A error_action_storage_queue block defining the a web action to take on an error as described below. Note this is identical to an action_storage_queue block.

property errorActionWeb

errorActionWeb?: pulumi.Input<{ ... }>;

A error_action_web block defining the action to take on an error as described below. Note this is identical to an action_web block.

property jobCollectionName

jobCollectionName: pulumi.Input<string>;

Specifies the name of the Scheduler Job Collection in which the Job should exist. Changing this forces a new resource to be created.

property name

name?: pulumi.Input<string>;

The name of the Scheduler Job. Changing this forces a new resource to be created.

property recurrence

recurrence?: pulumi.Input<{ ... }>;

A recurrence block defining a job occurrence schedule.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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

property retry

retry?: pulumi.Input<{ ... }>;

A retry block defining how to retry as described below.

property startTime

startTime?: pulumi.Input<string>;

The time the first instance of the job is to start running at.

property state

state?: pulumi.Input<string>;

The sets or gets the current state of the job. Can be set to either Enabled or Completed

interface JobCollectionArgs

The set of arguments for constructing a JobCollection resource.

property location

location: pulumi.Input<string>;

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

property name

name?: pulumi.Input<string>;

Specifies the name of the Scheduler Job Collection. Changing this forces a new resource to be created.

property quota

quota?: pulumi.Input<{ ... }>;

Configures the Job collection quotas as documented in the quota block below.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

The name of the resource group in which to create the Scheduler Job Collection. Changing this forces a new resource to be created.

property sku

sku: pulumi.Input<string>;

Sets the Job Collection’s pricing level’s SKU. Possible values include: Standard, Free, P10Premium, P20Premium.

property state

state?: pulumi.Input<string>;

Sets Job Collection’s state. Possible values include: Enabled, Disabled, Suspended.

property tags

tags?: pulumi.Input<{ ... }>;

A mapping of tags to assign to the resource.

interface JobCollectionState

Input properties used for looking up and filtering JobCollection resources.

property location

location?: pulumi.Input<string>;

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

property name

name?: pulumi.Input<string>;

Specifies the name of the Scheduler Job Collection. Changing this forces a new resource to be created.

property quota

quota?: pulumi.Input<{ ... }>;

Configures the Job collection quotas as documented in the quota block below.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

The name of the resource group in which to create the Scheduler Job Collection. Changing this forces a new resource to be created.

property sku

sku?: pulumi.Input<string>;

Sets the Job Collection’s pricing level’s SKU. Possible values include: Standard, Free, P10Premium, P20Premium.

property state

state?: pulumi.Input<string>;

Sets Job Collection’s state. Possible values include: Enabled, Disabled, Suspended.

property tags

tags?: pulumi.Input<{ ... }>;

A mapping of tags to assign to the resource.

interface JobState

Input properties used for looking up and filtering Job resources.

property actionStorageQueue

actionStorageQueue?: pulumi.Input<{ ... }>;

A action_storage_queue block defining a storage queue job action as described below. Note this is identical to an error_action_storage_queue block.

property actionWeb

actionWeb?: pulumi.Input<{ ... }>;

A action_web block defining the job action as described below. Note this is identical to an error_action_web block.

property errorActionStorageQueue

errorActionStorageQueue?: pulumi.Input<{ ... }>;

A error_action_storage_queue block defining the a web action to take on an error as described below. Note this is identical to an action_storage_queue block.

property errorActionWeb

errorActionWeb?: pulumi.Input<{ ... }>;

A error_action_web block defining the action to take on an error as described below. Note this is identical to an action_web block.

property jobCollectionName

jobCollectionName?: pulumi.Input<string>;

Specifies the name of the Scheduler Job Collection in which the Job should exist. Changing this forces a new resource to be created.

property name

name?: pulumi.Input<string>;

The name of the Scheduler Job. Changing this forces a new resource to be created.

property recurrence

recurrence?: pulumi.Input<{ ... }>;

A recurrence block defining a job occurrence schedule.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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

property retry

retry?: pulumi.Input<{ ... }>;

A retry block defining how to retry as described below.

property startTime

startTime?: pulumi.Input<string>;

The time the first instance of the job is to start running at.

property state

state?: pulumi.Input<string>;

The sets or gets the current state of the job. Can be set to either Enabled or Completed