Module scheduler

scheduler

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-azure repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-azurerm repo.
class pulumi_azure.scheduler.AwaitableGetJobCollectionResult(location=None, name=None, quotas=None, resource_group_name=None, sku=None, state=None, tags=None, id=None)
class pulumi_azure.scheduler.GetJobCollectionResult(location=None, name=None, quotas=None, resource_group_name=None, sku=None, state=None, tags=None, id=None)

A collection of values returned by getJobCollection.

location = None

The Azure location where the resource exists.

quotas = None

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

sku = None

The Job Collection’s pricing level’s SKU.

state = None

The Job Collection’s state.

tags = None

A mapping of tags assigned to the resource.

id = None

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

class pulumi_azure.scheduler.Job(resource_name, opts=None, action_storage_queue=None, action_web=None, error_action_storage_queue=None, error_action_web=None, job_collection_name=None, name=None, recurrence=None, resource_group_name=None, retry=None, start_time=None, state=None, __props__=None, __name__=None, __opts__=None)

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.
Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • action_storage_queue (pulumi.Input[dict]) – 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.
  • action_web (pulumi.Input[dict]) – A action_web block defining the job action as described below. Note this is identical to an error_action_web block.
  • error_action_storage_queue (pulumi.Input[dict]) – 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.
  • error_action_web (pulumi.Input[dict]) – 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.
  • job_collection_name (pulumi.Input[str]) – Specifies the name of the Scheduler Job Collection in which the Job should exist. Changing this forces a new resource to be created.
  • name (pulumi.Input[str]) – The name of the Scheduler Job. Changing this forces a new resource to be created.
  • recurrence (pulumi.Input[dict]) – A recurrence block defining a job occurrence schedule.
  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the Scheduler Job. Changing this forces a new resource to be created.
  • retry (pulumi.Input[dict]) – A retry block defining how to retry as described below.
  • start_time (pulumi.Input[str]) – The time the first instance of the job is to start running at.
  • state (pulumi.Input[str]) – The sets or gets the current state of the job. Can be set to either Enabled or Completed
action_storage_queue = None

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.

action_web = None

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

error_action_storage_queue = None

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.

error_action_web = None

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.

job_collection_name = None

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

name = None

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

recurrence = None

A recurrence block defining a job occurrence schedule.

resource_group_name = None

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

retry = None

A retry block defining how to retry as described below.

start_time = None

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

state = None

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

static get(resource_name, id, opts=None, action_storage_queue=None, action_web=None, error_action_storage_queue=None, error_action_web=None, job_collection_name=None, name=None, recurrence=None, resource_group_name=None, retry=None, start_time=None, state=None)

Get an existing Job resource’s state with the given name, id, and optional extra properties used to qualify the lookup. :param str resource_name: The unique name of the resulting resource. :param str id: The unique provider ID of the resource to lookup. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[dict] action_storage_queue: 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. :param pulumi.Input[dict] action_web: A action_web block defining the job action as described below. Note this is identical to an error_action_web block. :param pulumi.Input[dict] error_action_storage_queue: 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. :param pulumi.Input[dict] error_action_web: 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. :param pulumi.Input[str] job_collection_name: Specifies the name of the Scheduler Job Collection in which the Job should exist. Changing this forces a new resource to be created. :param pulumi.Input[str] name: The name of the Scheduler Job. Changing this forces a new resource to be created. :param pulumi.Input[dict] recurrence: A recurrence block defining a job occurrence schedule. :param pulumi.Input[str] resource_group_name: The name of the resource group in which to create the Scheduler Job. Changing this forces a new resource to be created. :param pulumi.Input[dict] retry: A retry block defining how to retry as described below. :param pulumi.Input[str] start_time: The time the first instance of the job is to start running at. :param pulumi.Input[str] state: The sets or gets the current state of the job. Can be set to either Enabled or Completed

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_azure.scheduler.JobCollection(resource_name, opts=None, location=None, name=None, quota=None, resource_group_name=None, sku=None, state=None, tags=None, __props__=None, __name__=None, __opts__=None)

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.
Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • location (pulumi.Input[str]) – Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
  • name (pulumi.Input[str]) – Specifies the name of the Scheduler Job Collection. Changing this forces a new resource to be created.
  • quota (pulumi.Input[dict]) – Configures the Job collection quotas as documented in the quota block below.
  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the Scheduler Job Collection. Changing this forces a new resource to be created.
  • sku (pulumi.Input[str]) – Sets the Job Collection’s pricing level’s SKU. Possible values include: Standard, Free, P10Premium, P20Premium.
  • state (pulumi.Input[str]) – Sets Job Collection’s state. Possible values include: Enabled, Disabled, Suspended.
  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
location = None

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

name = None

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

quota = None

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

resource_group_name = None

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

sku = None

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

state = None

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

tags = None

A mapping of tags to assign to the resource.

static get(resource_name, id, opts=None, location=None, name=None, quota=None, resource_group_name=None, sku=None, state=None, tags=None)

Get an existing JobCollection resource’s state with the given name, id, and optional extra properties used to qualify the lookup. :param str resource_name: The unique name of the resulting resource. :param str id: The unique provider ID of the resource to lookup. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[str] location: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created. :param pulumi.Input[str] name: Specifies the name of the Scheduler Job Collection. Changing this forces a new resource to be created. :param pulumi.Input[dict] quota: Configures the Job collection quotas as documented in the quota block below. :param pulumi.Input[str] resource_group_name: The name of the resource group in which to create the Scheduler Job Collection. Changing this forces a new resource to be created. :param pulumi.Input[str] sku: Sets the Job Collection’s pricing level’s SKU. Possible values include: Standard, Free, P10Premium, P20Premium. :param pulumi.Input[str] state: Sets Job Collection’s state. Possible values include: Enabled, Disabled, Suspended. :param pulumi.Input[dict] tags: A mapping of tags to assign to the resource.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
pulumi_azure.scheduler.get_job_collection(name=None, resource_group_name=None, opts=None)

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.

This content is derived from https://github.com/terraform-providers/terraform-provider-azurerm/blob/master/website/docs/d/scheduler_job_collection.html.markdown.