automation

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.automation.Account(resource_name, opts=None, location=None, name=None, resource_group_name=None, sku=None, sku_name=None, tags=None, __props__=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]) – Specifies the name of the Automation Account. Changing this forces a new resource to be created.

  • 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 described below.

  • sku_name (pulumi.Input[str]) – The SKU name of the account - only Basic is supported at this time.

  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

The sku object supports the following:

  • name (pulumi.Input[str]) - Specifies the name of the Automation Account. Changing this forces a new resource to be created.

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

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

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 described below.

  • name (str) - Specifies the name of the Automation Account. Changing this forces a new resource to be created.

sku_name = None

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

tags = None

A mapping of tags to assign to the resource.

static get(resource_name, id, opts=None, dsc_primary_access_key=None, dsc_secondary_access_key=None, dsc_server_endpoint=None, location=None, name=None, resource_group_name=None, sku=None, sku_name=None, tags=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • dsc_primary_access_key (pulumi.Input[str]) – The Primary Access Key for the DSC Endpoint associated with this Automation Account.

  • dsc_secondary_access_key (pulumi.Input[str]) – The Secondary Access Key for the DSC Endpoint associated with this Automation Account.

  • dsc_server_endpoint (pulumi.Input[str]) – The DSC Server Endpoint associated with this Automation Account.

  • 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 Automation Account. Changing this forces a new resource to be created.

  • 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 described below.

  • sku_name (pulumi.Input[str]) – The SKU name of the account - only Basic is supported at this time.

  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

The sku object supports the following:

  • name (pulumi.Input[str]) - Specifies the name of the Automation Account. 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.AwaitableGetBoolVariableResult(automation_account_name=None, description=None, encrypted=None, name=None, resource_group_name=None, value=None, id=None)
class pulumi_azure.automation.AwaitableGetDateTimeVariableResult(automation_account_name=None, description=None, encrypted=None, name=None, resource_group_name=None, value=None, id=None)
class pulumi_azure.automation.AwaitableGetIntVariableResult(automation_account_name=None, description=None, encrypted=None, name=None, resource_group_name=None, value=None, id=None)
class pulumi_azure.automation.AwaitableGetStringVariableResult(automation_account_name=None, description=None, encrypted=None, name=None, resource_group_name=None, value=None, id=None)
class pulumi_azure.automation.BoolVariable(resource_name, opts=None, automation_account_name=None, description=None, encrypted=None, name=None, resource_group_name=None, value=None, __props__=None, __name__=None, __opts__=None)

Manages a boolean variable in Azure Automation

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 Variable is created. Changing this forces a new resource to be created.

  • description (pulumi.Input[str]) – The description of the Automation Variable.

  • encrypted (pulumi.Input[bool]) – Specifies if the Automation Variable is encrypted. Defaults to false.

  • name (pulumi.Input[str]) – The name of the Automation Variable. Changing this forces a new resource to be created.

  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the Automation Variable. Changing this forces a new resource to be created.

  • value (pulumi.Input[bool]) – The value of the Automation Variable as a boolean.

automation_account_name = None

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

description = None

The description of the Automation Variable.

encrypted = None

Specifies if the Automation Variable is encrypted. Defaults to false.

name = None

The name of the Automation Variable. Changing this forces a new resource to be created.

resource_group_name = None

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

value = None

The value of the Automation Variable as a boolean.

static get(resource_name, id, opts=None, automation_account_name=None, description=None, encrypted=None, name=None, resource_group_name=None, value=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • automation_account_name (pulumi.Input[str]) – The name of the automation account in which the Variable is created. Changing this forces a new resource to be created.

  • description (pulumi.Input[str]) – The description of the Automation Variable.

  • encrypted (pulumi.Input[bool]) – Specifies if the Automation Variable is encrypted. Defaults to false.

  • name (pulumi.Input[str]) – The name of the Automation Variable. Changing this forces a new resource to be created.

  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the Automation Variable. Changing this forces a new resource to be created.

  • value (pulumi.Input[bool]) – The value of the Automation Variable as a boolean.

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, __props__=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.

static get(resource_name, id, opts=None, account_name=None, description=None, name=None, password=None, resource_group_name=None, username=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • 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.

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.DateTimeVariable(resource_name, opts=None, automation_account_name=None, description=None, encrypted=None, name=None, resource_group_name=None, value=None, __props__=None, __name__=None, __opts__=None)

Manages a date/time variable in Azure Automation

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 Variable is created. Changing this forces a new resource to be created.

  • description (pulumi.Input[str]) – The description of the Automation Variable.

  • encrypted (pulumi.Input[bool]) – Specifies if the Automation Variable is encrypted. Defaults to false.

  • name (pulumi.Input[str]) – The name of the Automation Variable. Changing this forces a new resource to be created.

  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the Automation Variable. Changing this forces a new resource to be created.

  • value (pulumi.Input[str]) – The value of the Automation Variable in the RFC3339 Section 5.6 Internet Date/Time Format.

automation_account_name = None

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

description = None

The description of the Automation Variable.

encrypted = None

Specifies if the Automation Variable is encrypted. Defaults to false.

name = None

The name of the Automation Variable. Changing this forces a new resource to be created.

resource_group_name = None

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

value = None

The value of the Automation Variable in the RFC3339 Section 5.6 Internet Date/Time Format.

static get(resource_name, id, opts=None, automation_account_name=None, description=None, encrypted=None, name=None, resource_group_name=None, value=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • automation_account_name (pulumi.Input[str]) – The name of the automation account in which the Variable is created. Changing this forces a new resource to be created.

  • description (pulumi.Input[str]) – The description of the Automation Variable.

  • encrypted (pulumi.Input[bool]) – Specifies if the Automation Variable is encrypted. Defaults to false.

  • name (pulumi.Input[str]) – The name of the Automation Variable. Changing this forces a new resource to be created.

  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the Automation Variable. Changing this forces a new resource to be created.

  • value (pulumi.Input[str]) –

    The value of the Automation Variable in the RFC3339 Section 5.6 Internet Date/Time Format.

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, __props__=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.

static get(resource_name, id, opts=None, automation_account_name=None, content_embedded=None, description=None, location=None, log_verbose=None, name=None, resource_group_name=None, state=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • 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.

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, __props__=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.

static get(resource_name, id, opts=None, automation_account_name=None, configuration_name=None, content_embedded=None, name=None, resource_group_name=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • 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.

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.GetBoolVariableResult(automation_account_name=None, description=None, encrypted=None, name=None, resource_group_name=None, value=None, id=None)

A collection of values returned by getBoolVariable.

description = None

The description of the Automation Variable.

encrypted = None

Specifies if the Automation Variable is encrypted. Defaults to false.

value = None

The value of the Automation Variable as a boolean.

id = None

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

class pulumi_azure.automation.GetDateTimeVariableResult(automation_account_name=None, description=None, encrypted=None, name=None, resource_group_name=None, value=None, id=None)

A collection of values returned by getDateTimeVariable.

description = None

The description of the Automation Variable.

encrypted = None

Specifies if the Automation Variable is encrypted. Defaults to false.

value = None

The value of the Automation Variable in the RFC3339 Section 5.6 Internet Date/Time Format.

id = None

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

class pulumi_azure.automation.GetIntVariableResult(automation_account_name=None, description=None, encrypted=None, name=None, resource_group_name=None, value=None, id=None)

A collection of values returned by getIntVariable.

description = None

The description of the Automation Variable.

encrypted = None

Specifies if the Automation Variable is encrypted. Defaults to false.

value = None

The value of the Automation Variable as a integer.

id = None

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

class pulumi_azure.automation.GetStringVariableResult(automation_account_name=None, description=None, encrypted=None, name=None, resource_group_name=None, value=None, id=None)

A collection of values returned by getStringVariable.

description = None

The description of the Automation Variable.

encrypted = None

Specifies if the Automation Variable is encrypted. Defaults to false.

value = None

The value of the Automation Variable as a string.

id = None

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

class pulumi_azure.automation.IntVariable(resource_name, opts=None, automation_account_name=None, description=None, encrypted=None, name=None, resource_group_name=None, value=None, __props__=None, __name__=None, __opts__=None)

Manages a integer variable in Azure Automation

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 Variable is created. Changing this forces a new resource to be created.

  • description (pulumi.Input[str]) – The description of the Automation Variable.

  • encrypted (pulumi.Input[bool]) – Specifies if the Automation Variable is encrypted. Defaults to false.

  • name (pulumi.Input[str]) – The name of the Automation Variable. Changing this forces a new resource to be created.

  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the Automation Variable. Changing this forces a new resource to be created.

  • value (pulumi.Input[float]) – The value of the Automation Variable as a integer.

automation_account_name = None

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

description = None

The description of the Automation Variable.

encrypted = None

Specifies if the Automation Variable is encrypted. Defaults to false.

name = None

The name of the Automation Variable. Changing this forces a new resource to be created.

resource_group_name = None

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

value = None

The value of the Automation Variable as a integer.

static get(resource_name, id, opts=None, automation_account_name=None, description=None, encrypted=None, name=None, resource_group_name=None, value=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • automation_account_name (pulumi.Input[str]) – The name of the automation account in which the Variable is created. Changing this forces a new resource to be created.

  • description (pulumi.Input[str]) – The description of the Automation Variable.

  • encrypted (pulumi.Input[bool]) – Specifies if the Automation Variable is encrypted. Defaults to false.

  • name (pulumi.Input[str]) – The name of the Automation Variable. Changing this forces a new resource to be created.

  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the Automation Variable. Changing this forces a new resource to be created.

  • value (pulumi.Input[float]) – The value of the Automation Variable as a integer.

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, __props__=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.

The module_link object supports the following:

  • hash (pulumi.Input[dict])

    • algorithm (pulumi.Input[str])

    • value (pulumi.Input[str])

  • uri (pulumi.Input[str]) - The uri of the module content (zip or nupkg).

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.

  • hash (dict)

    • algorithm (str)

    • value (str)

  • uri (str) - The uri of the module content (zip or nupkg).

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.

static get(resource_name, id, opts=None, automation_account_name=None, module_link=None, name=None, resource_group_name=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • 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.

The module_link object supports the following:

  • hash (pulumi.Input[dict])

    • algorithm (pulumi.Input[str])

    • value (pulumi.Input[str])

  • uri (pulumi.Input[str]) - The uri of the module content (zip or nupkg).

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, __props__=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.

The publish_content_link object supports the following:

  • hash (pulumi.Input[dict])

    • algorithm (pulumi.Input[str])

    • value (pulumi.Input[str])

  • uri (pulumi.Input[str]) - The uri of the runbook content.

  • version (pulumi.Input[str])

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.

  • hash (dict)

    • algorithm (str)

    • value (str)

  • uri (str) - The uri of the runbook content.

  • version (str)

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.

static get(resource_name, id, 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)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • 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.

The publish_content_link object supports the following:

  • hash (pulumi.Input[dict])

    • algorithm (pulumi.Input[str])

    • value (pulumi.Input[str])

  • uri (pulumi.Input[str]) - The uri of the runbook content.

  • version (pulumi.Input[str])

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, __props__=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.

  • automation_account_name (pulumi.Input[str]) – The name of the automation account in which the Schedule is created. Changing this forces a new resource to be created.

  • description (pulumi.Input[str]) – A description for this Schedule.

  • expiry_time (pulumi.Input[str]) – The end time of the schedule.

  • frequency (pulumi.Input[str]) – The frequency of the schedule. - can be either OneTime, Day, Hour, Week, or Month.

  • interval (pulumi.Input[float]) – The number of frequencys between runs. Only valid when frequency is Day, Hour, Week, or Month and defaults to 1.

  • month_days (pulumi.Input[list]) – 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 (pulumi.Input[list]) – List of occurrences of days within a month. Only valid when frequency is Month. The monthly_occurrence block supports fields documented below.

  • name (pulumi.Input[str]) – Specifies the name of the Schedule. Changing this forces a new resource to be created.

  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which the Schedule is created. Changing this forces a new resource to be created.

  • start_time (pulumi.Input[str]) – 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 (pulumi.Input[str]) – 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 (pulumi.Input[list]) – List of days of the week that the job should execute on. Only valid when frequency is Week.

The monthly_occurrences object supports the following:

  • day (pulumi.Input[str])

  • occurrence (pulumi.Input[float])

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.

  • day (str)

  • occurrence (float)

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.

static get(resource_name, id, 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)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • automation_account_name (pulumi.Input[str]) – The name of the automation account in which the Schedule is created. Changing this forces a new resource to be created.

  • description (pulumi.Input[str]) – A description for this Schedule.

  • expiry_time (pulumi.Input[str]) – The end time of the schedule.

  • frequency (pulumi.Input[str]) – The frequency of the schedule. - can be either OneTime, Day, Hour, Week, or Month.

  • interval (pulumi.Input[float]) – The number of frequencys between runs. Only valid when frequency is Day, Hour, Week, or Month and defaults to 1.

  • month_days (pulumi.Input[list]) – 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 (pulumi.Input[list]) – List of occurrences of days within a month. Only valid when frequency is Month. The monthly_occurrence block supports fields documented below.

  • name (pulumi.Input[str]) – Specifies the name of the Schedule. Changing this forces a new resource to be created.

  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which the Schedule is created. Changing this forces a new resource to be created.

  • start_time (pulumi.Input[str]) – 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 (pulumi.Input[str]) – 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 (pulumi.Input[list]) – List of days of the week that the job should execute on. Only valid when frequency is Week.

The monthly_occurrences object supports the following:

  • day (pulumi.Input[str])

  • occurrence (pulumi.Input[float])

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.StringVariable(resource_name, opts=None, automation_account_name=None, description=None, encrypted=None, name=None, resource_group_name=None, value=None, __props__=None, __name__=None, __opts__=None)

Manages a string variable in Azure Automation

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 Variable is created. Changing this forces a new resource to be created.

  • description (pulumi.Input[str]) – The description of the Automation Variable.

  • encrypted (pulumi.Input[bool]) – Specifies if the Automation Variable is encrypted. Defaults to false.

  • name (pulumi.Input[str]) – The name of the Automation Variable. Changing this forces a new resource to be created.

  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the Automation Variable. Changing this forces a new resource to be created.

  • value (pulumi.Input[str]) – The value of the Automation Variable as a string.

automation_account_name = None

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

description = None

The description of the Automation Variable.

encrypted = None

Specifies if the Automation Variable is encrypted. Defaults to false.

name = None

The name of the Automation Variable. Changing this forces a new resource to be created.

resource_group_name = None

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

value = None

The value of the Automation Variable as a string.

static get(resource_name, id, opts=None, automation_account_name=None, description=None, encrypted=None, name=None, resource_group_name=None, value=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • automation_account_name (pulumi.Input[str]) – The name of the automation account in which the Variable is created. Changing this forces a new resource to be created.

  • description (pulumi.Input[str]) – The description of the Automation Variable.

  • encrypted (pulumi.Input[bool]) – Specifies if the Automation Variable is encrypted. Defaults to false.

  • name (pulumi.Input[str]) – The name of the Automation Variable. Changing this forces a new resource to be created.

  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the Automation Variable. Changing this forces a new resource to be created.

  • value (pulumi.Input[str]) – The value of the Automation Variable as a string.

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.automation.get_bool_variable(automation_account_name=None, name=None, resource_group_name=None, opts=None)

Use this data source to access information about an existing Automation Bool Variable.

Parameters
  • automation_account_name (str) – The name of the automation account in which the Automation Variable exists.

  • name (str) – The name of the Automation Variable.

  • resource_group_name (str) – The Name of the Resource Group where the automation account exists.

pulumi_azure.automation.get_date_time_variable(automation_account_name=None, name=None, resource_group_name=None, opts=None)

Use this data source to access information about an existing Automation Datetime Variable.

Parameters
  • automation_account_name (str) – The name of the automation account in which the Automation Variable exists.

  • name (str) – The name of the Automation Variable.

  • resource_group_name (str) – The Name of the Resource Group where the automation account exists.

pulumi_azure.automation.get_int_variable(automation_account_name=None, name=None, resource_group_name=None, opts=None)

Use this data source to access information about an existing Automation Int Variable.

Parameters
  • automation_account_name (str) – The name of the automation account in which the Automation Variable exists.

  • name (str) – The name of the Automation Variable.

  • resource_group_name (str) – The Name of the Resource Group where the automation account exists.

pulumi_azure.automation.get_string_variable(automation_account_name=None, name=None, resource_group_name=None, opts=None)

Use this data source to access information about an existing Automation String Variable.

Parameters
  • automation_account_name (str) – The name of the automation account in which the Automation Variable exists.

  • name (str) – The name of the Automation Variable.

  • resource_group_name (str) – The Name of the Resource Group where the automation account exists.