automation

class pulumi_azure.automation.Account(resource_name, opts=None, location=None, name=None, resource_group_name=None, sku=None, tags=None, __name__=None, __opts__=None)

Manages a Automation Account.

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]) – The SKU name of the account - only Basic is supported at this time. Defaults to Basic.
  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which the Automation Account is created. Changing this forces a new resource to be created.
  • sku (pulumi.Input[dict]) – A sku block as defined below.
  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
dsc_primary_access_key = None

The Primary Access Key for the DSC Endpoint associated with this Automation Account.

dsc_secondary_access_key = None

The Secondary Access Key for the DSC Endpoint associated with this Automation Account.

dsc_server_endpoint = None

The DSC Server Endpoint associated with this Automation Account.

location = None

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

name = None

The SKU name of the account - only Basic is supported at this time. Defaults to Basic.

resource_group_name = None

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

sku = None

A sku block as defined below.

tags = None

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
class pulumi_azure.automation.Credential(resource_name, opts=None, account_name=None, description=None, name=None, password=None, resource_group_name=None, username=None, __name__=None, __opts__=None)

Manages a Automation Credential.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • account_name (pulumi.Input[str]) – The name of the automation account in which the Credential is created. Changing this forces a new resource to be created.
  • description (pulumi.Input[str]) – The description associated with this Automation Credential.
  • name (pulumi.Input[str]) – Specifies the name of the Credential. Changing this forces a new resource to be created.
  • password (pulumi.Input[str]) – The password associated with this Automation Credential.
  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which the Credential is created. Changing this forces a new resource to be created.
  • username (pulumi.Input[str]) – The username associated with this Automation Credential.
account_name = None

The name of the automation account in which the Credential is created. Changing this forces a new resource to be created.

description = None

The description associated with this Automation Credential.

name = None

Specifies the name of the Credential. Changing this forces a new resource to be created.

password = None

The password associated with this Automation Credential.

resource_group_name = None

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

username = None

The username associated with this Automation Credential.

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.automation.DscConfiguration(resource_name, opts=None, automation_account_name=None, content_embedded=None, description=None, location=None, log_verbose=None, name=None, resource_group_name=None, __name__=None, __opts__=None)

Manages a Automation DSC Configuration.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • automation_account_name (pulumi.Input[str]) – The name of the automation account in which the DSC Configuration is created. Changing this forces a new resource to be created.
  • content_embedded (pulumi.Input[str]) – The PowerShell DSC Configuration script.
  • description (pulumi.Input[str]) – Description to go with DSC Configuration.
  • location (pulumi.Input[str]) – Must be the same location as the Automation Account.
  • log_verbose (pulumi.Input[bool]) – Verbose log option.
  • name (pulumi.Input[str]) – Specifies the name of the DSC Configuration. Changing this forces a new resource to be created.
  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which the DSC Configuration is created. Changing this forces a new resource to be created.
automation_account_name = None

The name of the automation account in which the DSC Configuration is created. Changing this forces a new resource to be created.

content_embedded = None

The PowerShell DSC Configuration script.

description = None

Description to go with DSC Configuration.

location = None

Must be the same location as the Automation Account.

log_verbose = None

Verbose log option.

name = None

Specifies the name of the DSC Configuration. Changing this forces a new resource to be created.

resource_group_name = None

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

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.automation.DscNodeConfiguration(resource_name, opts=None, automation_account_name=None, content_embedded=None, name=None, resource_group_name=None, __name__=None, __opts__=None)

Manages a Automation DSC Node Configuration.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • automation_account_name (pulumi.Input[str]) – The name of the automation account in which the DSC Node Configuration is created. Changing this forces a new resource to be created.
  • content_embedded (pulumi.Input[str]) – The PowerShell DSC Node Configuration (mof content).
  • name (pulumi.Input[str]) – Specifies the name of the DSC Node Configuration. Changing this forces a new resource to be created.
  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which the DSC Node Configuration is created. Changing this forces a new resource to be created.
automation_account_name = None

The name of the automation account in which the DSC Node Configuration is created. Changing this forces a new resource to be created.

content_embedded = None

The PowerShell DSC Node Configuration (mof content).

name = None

Specifies the name of the DSC Node Configuration. Changing this forces a new resource to be created.

resource_group_name = None

The name of the resource group in which the DSC Node Configuration is created. Changing this forces a new resource to be created.

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.automation.Module(resource_name, opts=None, automation_account_name=None, module_link=None, name=None, resource_group_name=None, __name__=None, __opts__=None)

Manages a Automation Module.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • automation_account_name (pulumi.Input[str]) – The name of the automation account in which the Module is created. Changing this forces a new resource to be created.
  • module_link (pulumi.Input[dict]) – The published Module link.
  • name (pulumi.Input[str]) – Specifies the name of the Module. Changing this forces a new resource to be created.
  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which the Module is created. Changing this forces a new resource to be created.
automation_account_name = None

The name of the automation account in which the Module is created. Changing this forces a new resource to be created.

The published Module link.

name = None

Specifies the name of the Module. Changing this forces a new resource to be created.

resource_group_name = None

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

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.automation.RunBook(resource_name, opts=None, account_name=None, content=None, description=None, location=None, log_progress=None, log_verbose=None, name=None, publish_content_link=None, resource_group_name=None, runbook_type=None, tags=None, __name__=None, __opts__=None)

Manages a Automation Runbook.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • account_name (pulumi.Input[str]) – The name of the automation account in which the Runbook is created. Changing this forces a new resource to be created.
  • content (pulumi.Input[str]) – The desired content of the runbook.
  • description (pulumi.Input[str]) – A description for this credential.
  • location (pulumi.Input[str]) – Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
  • log_progress (pulumi.Input[bool]) – Progress log option.
  • log_verbose (pulumi.Input[bool]) – Verbose log option.
  • name (pulumi.Input[str]) – Specifies the name of the Runbook. Changing this forces a new resource to be created.
  • publish_content_link (pulumi.Input[dict]) – The published runbook content link.
  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which the Runbook is created. Changing this forces a new resource to be created.
  • runbook_type (pulumi.Input[str]) – The type of the runbook - can be either Graph, GraphPowerShell, GraphPowerShellWorkflow, PowerShellWorkflow, PowerShell or Script.
  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
account_name = None

The name of the automation account in which the Runbook is created. Changing this forces a new resource to be created.

content = None

The desired content of the runbook.

description = None

A description for this credential.

location = None

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

log_progress = None

Progress log option.

log_verbose = None

Verbose log option.

name = None

Specifies the name of the Runbook. Changing this forces a new resource to be created.

The published runbook content link.

resource_group_name = None

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

runbook_type = None

The type of the runbook - can be either Graph, GraphPowerShell, GraphPowerShellWorkflow, PowerShellWorkflow, PowerShell or Script.

tags = None

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
class pulumi_azure.automation.Schedule(resource_name, opts=None, account_name=None, automation_account_name=None, description=None, expiry_time=None, frequency=None, interval=None, month_days=None, monthly_occurrences=None, name=None, resource_group_name=None, start_time=None, timezone=None, week_days=None, __name__=None, __opts__=None)

Manages a Automation Schedule.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.

:param pulumi.Input[str] account_name :param pulumi.Input[str] automation_account_name: The name of the automation account in which the Schedule is created. Changing this forces a new resource to be created. :param pulumi.Input[str] description: A description for this Schedule. :param pulumi.Input[str] expiry_time: The end time of the schedule. :param pulumi.Input[str] frequency: The frequency of the schedule. - can be either OneTime, Day, Hour, Week, or Month. :param pulumi.Input[int] interval: The number of frequencys between runs. Only valid when frequency is Day, Hour, Week, or Month and defaults to 1. :param pulumi.Input[list] month_days: List of days of the month that the job should execute on. Must be between 1 and 31. -1 for last day of the month. Only valid when frequency is Month. :param pulumi.Input[list] monthly_occurrences: List of occurrences of days within a month. Only valid when frequency is Month. The monthly_occurrence block supports fields documented below. :param pulumi.Input[str] name: Specifies the name of the Schedule. Changing this forces a new resource to be created. :param pulumi.Input[str] resource_group_name: The name of the resource group in which the Schedule is created. Changing this forces a new resource to be created. :param pulumi.Input[str] start_time: Start time of the schedule. Must be at least five minutes in the future. Defaults to seven minutes in the future from the time the resource is created. :param pulumi.Input[str] timezone: The timezone of the start time. Defaults to UTC. For possible values see: https://msdn.microsoft.com/en-us/library/ms912391(v=winembedded.11).aspx :param pulumi.Input[list] week_days: List of days of the week that the job should execute on. Only valid when frequency is Week.

automation_account_name = None

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

description = None

A description for this Schedule.

expiry_time = None

The end time of the schedule.

frequency = None

The frequency of the schedule. - can be either OneTime, Day, Hour, Week, or Month.

interval = None

The number of frequencys between runs. Only valid when frequency is Day, Hour, Week, or Month and defaults to 1.

month_days = None

List of days of the month that the job should execute on. Must be between 1 and 31. -1 for last day of the month. Only valid when frequency is Month.

monthly_occurrences = None

List of occurrences of days within a month. Only valid when frequency is Month. The monthly_occurrence block supports fields documented below.

name = None

Specifies the name of the Schedule. Changing this forces a new resource to be created.

resource_group_name = None

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

start_time = None

Start time of the schedule. Must be at least five minutes in the future. Defaults to seven minutes in the future from the time the resource is created.

timezone = None

The timezone of the start time. Defaults to UTC. For possible values see: https://msdn.microsoft.com/en-us/library/ms912391(v=winembedded.11).aspx

week_days = None

List of days of the week that the job should execute on. Only valid when frequency is Week.

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