This page documents the language specification for the azure package. If you're looking for help working with the inputs, outputs, or functions of azure resources in a Pulumi program, please see the resource documentation for examples and API reference.

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_name=None, tags=None, __props__=None, __name__=None, __opts__=None)¶

Manages a Automation Account.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_account = azure.automation.Account("exampleAccount",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    sku_name="Basic",
    tags={
        "environment": "development",
    })

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

dsc_primary_access_key: pulumi.Output[str] = None¶: The Primary Access Key for the DSC Endpoint associated with this Automation Account.

dsc_secondary_access_key: pulumi.Output[str] = None¶: The Secondary Access Key for the DSC Endpoint associated with this Automation Account.

dsc_server_endpoint: pulumi.Output[str] = None¶: The DSC Server Endpoint associated with this Automation Account.

location: pulumi.Output[str] = None¶: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

name: pulumi.Output[str] = None¶: Specifies the name of the Automation Account. Changing this forces a new resource to be created.

resource_group_name: pulumi.Output[str] = None¶: The name of the resource group in which the Automation Account is created. Changing this forces a new resource to be created.

sku_name: pulumi.Output[str] = None¶: The SKU name of the account - only Basic is supported at this time.

tags: pulumi.Output[dict] = 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_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_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.

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.AwaitableGetAccountResult(endpoint=None, id=None, name=None, primary_key=None, resource_group_name=None, secondary_key=None)¶

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

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

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

class pulumi_azure.automation.AwaitableGetStringVariableResult(automation_account_name=None, description=None, encrypted=None, id=None, name=None, resource_group_name=None, value=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

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West US")
example_account = azure.automation.Account("exampleAccount",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    sku=[{
        "name": "Basic",
    }])
example_bool_variable = azure.automation.BoolVariable("exampleBoolVariable",
    resource_group_name=example_resource_group.name,
    automation_account_name=example_account.name,
    value=False)

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: pulumi.Output[str] = None¶: The name of the automation account in which the Variable is created. Changing this forces a new resource to be created.

description: pulumi.Output[str] = None¶: The description of the Automation Variable.

encrypted: pulumi.Output[bool] = None¶: Specifies if the Automation Variable is encrypted. Defaults to false.

name: pulumi.Output[str] = None¶: The name of the Automation Variable. Changing this forces a new resource to be created.

resource_group_name: pulumi.Output[str] = None¶: The name of the resource group in which to create the Automation Variable. Changing this forces a new resource to be created.

value: pulumi.Output[bool] = 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.Certificate(resource_name, opts=None, automation_account_name=None, base64=None, description=None, name=None, resource_group_name=None, __props__=None, __name__=None, __opts__=None)¶

Manages an Automation Certificate.

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 Certificate is created. Changing this forces a new resource to be created.
base64 (pulumi.Input[str]) – Base64 encoded value of the certificate.
description (pulumi.Input[str]) – The description of this Automation Certificate.
name (pulumi.Input[str]) – Specifies the name of the Certificate. Changing this forces a new resource to be created.
resource_group_name (pulumi.Input[str]) – The name of the resource group in which the Certificate is created. Changing this forces a new resource to be created.

automation_account_name: pulumi.Output[str] = None¶: The name of the automation account in which the Certificate is created. Changing this forces a new resource to be created.

base64: pulumi.Output[str] = None¶: Base64 encoded value of the certificate.

description: pulumi.Output[str] = None¶: The description of this Automation Certificate.

name: pulumi.Output[str] = None¶: Specifies the name of the Certificate. Changing this forces a new resource to be created.

resource_group_name: pulumi.Output[str] = None¶: The name of the resource group in which the Certificate is created. Changing this forces a new resource to be created.

thumbprint: pulumi.Output[str] = None¶: The thumbprint for the certificate.

static get(resource_name, id, opts=None, automation_account_name=None, base64=None, description=None, exportable=None, name=None, resource_group_name=None, thumbprint=None)¶

Get an existing Certificate 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 Certificate is created. Changing this forces a new resource to be created.
base64 (pulumi.Input[str]) – Base64 encoded value of the certificate.
description (pulumi.Input[str]) – The description of this Automation Certificate.
name (pulumi.Input[str]) – Specifies the name of the Certificate. Changing this forces a new resource to be created.
resource_group_name (pulumi.Input[str]) – The name of the resource group in which the Certificate is created. Changing this forces a new resource to be created.
thumbprint (pulumi.Input[str]) – The thumbprint for the certificate.

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, automation_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.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_account = azure.automation.Account("exampleAccount",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    sku=[{
        "name": "Basic",
    }])
example_credential = azure.automation.Credential("exampleCredential",
    resource_group_name=example_resource_group.name,
    automation_account_name=example_account.name,
    username="example_user",
    password="example_pwd",
    description="This is an example credential")

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

automation_account_name: pulumi.Output[str] = None¶: The name of the automation account in which the Credential is created. Changing this forces a new resource to be created.

description: pulumi.Output[str] = None¶: The description associated with this Automation Credential.

name: pulumi.Output[str] = None¶: Specifies the name of the Credential. Changing this forces a new resource to be created.

password: pulumi.Output[str] = None¶: The password associated with this Automation Credential.

resource_group_name: pulumi.Output[str] = None¶: The name of the resource group in which the Credential is created. Changing this forces a new resource to be created.

username: pulumi.Output[str] = None¶: The username associated with this Automation Credential.

static get(resource_name, id, opts=None, automation_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.
automation_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 DateTime variable in Azure Automation

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West US")
example_account = azure.automation.Account("exampleAccount",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    sku=[{
        "name": "Basic",
    }])
example_date_time_variable = azure.automation.DateTimeVariable("exampleDateTimeVariable",
    resource_group_name=example_resource_group.name,
    automation_account_name=example_account.name,
    value="2019-04-24T21:40:54.074Z")

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: pulumi.Output[str] = None¶: The name of the automation account in which the Variable is created. Changing this forces a new resource to be created.

description: pulumi.Output[str] = None¶: The description of the Automation Variable.

encrypted: pulumi.Output[bool] = None¶: Specifies if the Automation Variable is encrypted. Defaults to false.

name: pulumi.Output[str] = None¶: The name of the Automation Variable. Changing this forces a new resource to be created.

resource_group_name: pulumi.Output[str] = None¶: The name of the resource group in which to create the Automation Variable. Changing this forces a new resource to be created.

value: pulumi.Output[str] = 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, tags=None, __props__=None, __name__=None, __opts__=None)¶

Manages a Automation DSC Configuration.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_account = azure.automation.Account("exampleAccount",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    sku=[{
        "name": "Basic",
    }])
example_dsc_configuration = azure.automation.DscConfiguration("exampleDscConfiguration",
    resource_group_name=example_resource_group.name,
    automation_account_name=example_account.name,
    location=example_resource_group.location,
    content_embedded="configuration test {}")

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.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

automation_account_name: pulumi.Output[str] = 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: pulumi.Output[str] = None¶: The PowerShell DSC Configuration script.

description: pulumi.Output[str] = None¶: Description to go with DSC Configuration.

location: pulumi.Output[str] = None¶: Must be the same location as the Automation Account.

log_verbose: pulumi.Output[bool] = None¶: Verbose log option.

name: pulumi.Output[str] = None¶: Specifies the name of the DSC Configuration. Changing this forces a new resource to be created.

resource_group_name: pulumi.Output[str] = None¶: The name of the resource group in which the DSC Configuration is created. Changing this forces a new resource to be created.

tags: pulumi.Output[dict] = None¶: A mapping of tags to assign to the resource.

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, tags=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.
tags (pulumi.Input[dict]) – 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.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.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_account = azure.automation.Account("exampleAccount",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    sku=[{
        "name": "Basic",
    }])
example_dsc_configuration = azure.automation.DscConfiguration("exampleDscConfiguration",
    resource_group_name=example_resource_group.name,
    automation_account_name=example_account.name,
    location=example_resource_group.location,
    content_embedded="configuration test {}")
example_dsc_node_configuration = azure.automation.DscNodeConfiguration("exampleDscNodeConfiguration",
    resource_group_name=example_resource_group.name,
    automation_account_name=example_account.name,
    content_embedded="""instance of MSFT_FileDirectoryConfiguration as $MSFT_FileDirectoryConfiguration1ref
{
  ResourceID = "[File]bla";
  Ensure = "Present";
  Contents = "bogus Content";
  DestinationPath = "c:\bogus.txt";
  ModuleName = "PSDesiredStateConfiguration";
  SourceInfo = "::3::9::file";
  ModuleVersion = "1.0";
  ConfigurationName = "bla";
};
instance of OMI_ConfigurationDocument
{
  Version="2.0.0";
  MinimumCompatibleVersion = "1.0.0";
  CompatibleVersionAdditionalProperties= {"Omi_BaseResource:ConfigurationName"};
  Author="bogusAuthor";
  GenerationDate="06/15/2018 14:06:24";
  GenerationHost="bogusComputer";
  Name="test";
};
""")

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: pulumi.Output[str] = 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: pulumi.Output[str] = None¶: The PowerShell DSC Node Configuration (mof content).

name: pulumi.Output[str] = None¶: Specifies the name of the DSC Node Configuration. Changing this forces a new resource to be created.

resource_group_name: pulumi.Output[str] = 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.GetAccountResult(endpoint=None, id=None, name=None, primary_key=None, resource_group_name=None, secondary_key=None)¶

A collection of values returned by getAccount.

endpoint = None¶: The Endpoint for this Auomation Account.

id = None¶: The provider-assigned unique ID for this managed resource.

primary_key = None¶: The Primary Access Key for the Automation Account.

secondary_key = None¶: The Secondary Access Key for the Automation Account.

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

id = None¶: The provider-assigned unique ID for this managed resource.

value = None¶: The value of the Automation Variable as a boolean.

class pulumi_azure.automation.GetDateTimeVariableResult(automation_account_name=None, description=None, encrypted=None, id=None, name=None, resource_group_name=None, value=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.

id = None¶: The provider-assigned unique ID for this managed resource.

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

class pulumi_azure.automation.GetIntVariableResult(automation_account_name=None, description=None, encrypted=None, id=None, name=None, resource_group_name=None, value=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.

id = None¶: The provider-assigned unique ID for this managed resource.

value = None¶: The value of the Automation Variable as a integer.

class pulumi_azure.automation.GetStringVariableResult(automation_account_name=None, description=None, encrypted=None, id=None, name=None, resource_group_name=None, value=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.

id = None¶: The provider-assigned unique ID for this managed resource.

value = None¶: The value of the Automation Variable as a string.

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

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West US")
example_account = azure.automation.Account("exampleAccount",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    sku=[{
        "name": "Basic",
    }])
example_int_variable = azure.automation.IntVariable("exampleIntVariable",
    resource_group_name=example_resource_group.name,
    automation_account_name=example_account.name,
    value=1234)

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: pulumi.Output[str] = None¶: The name of the automation account in which the Variable is created. Changing this forces a new resource to be created.

description: pulumi.Output[str] = None¶: The description of the Automation Variable.

encrypted: pulumi.Output[bool] = None¶: Specifies if the Automation Variable is encrypted. Defaults to false.

name: pulumi.Output[str] = None¶: The name of the Automation Variable. Changing this forces a new resource to be created.

resource_group_name: pulumi.Output[str] = None¶: The name of the resource group in which to create the Automation Variable. Changing this forces a new resource to be created.

value: pulumi.Output[float] = 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.JobSchedule(resource_name, opts=None, automation_account_name=None, job_schedule_id=None, parameters=None, resource_group_name=None, run_on=None, runbook_name=None, schedule_name=None, __props__=None, __name__=None, __opts__=None)¶

Links an Automation Runbook and Schedule.

import pulumi
import pulumi_azure as azure

example = azure.automation.JobSchedule("example",
    automation_account_name="tf-automation-account",
    parameters={
        "resourcegroup": "tf-rgr-vm",
        "vmname": "TF-VM-01",
    },
    resource_group_name="tf-rgr-automation",
    runbook_name="Get-VirtualMachine",
    schedule_name="hour")

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 Job Schedule is created. Changing this forces a new resource to be created.
job_schedule_id (pulumi.Input[str]) – The UUID identifying the Automation Job Schedule.
parameters (pulumi.Input[dict]) – A map of key/value pairs corresponding to the arguments that can be passed to the Runbook. Changing this forces a new resource to be created.
resource_group_name (pulumi.Input[str]) – The name of the resource group in which the Job Schedule is created. Changing this forces a new resource to be created.
run_on (pulumi.Input[str]) – Name of a Hybrid Worker Group the Runbook will be executed on. Changing this forces a new resource to be created.
runbook_name (pulumi.Input[str]) – The name of a Runbook to link to a Schedule. It needs to be in the same Automation Account as the Schedule and Job Schedule. Changing this forces a new resource to be created.

automation_account_name: pulumi.Output[str] = None¶: The name of the Automation Account in which the Job Schedule is created. Changing this forces a new resource to be created.

job_schedule_id: pulumi.Output[str] = None¶: The UUID identifying the Automation Job Schedule.

parameters: pulumi.Output[dict] = None¶: A map of key/value pairs corresponding to the arguments that can be passed to the Runbook. Changing this forces a new resource to be created.

resource_group_name: pulumi.Output[str] = None¶: The name of the resource group in which the Job Schedule is created. Changing this forces a new resource to be created.

run_on: pulumi.Output[str] = None¶: Name of a Hybrid Worker Group the Runbook will be executed on. Changing this forces a new resource to be created.

runbook_name: pulumi.Output[str] = None¶: The name of a Runbook to link to a Schedule. It needs to be in the same Automation Account as the Schedule and Job Schedule. Changing this forces a new resource to be created.

static get(resource_name, id, opts=None, automation_account_name=None, job_schedule_id=None, parameters=None, resource_group_name=None, run_on=None, runbook_name=None, schedule_name=None)¶

Get an existing JobSchedule 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 Job Schedule is created. Changing this forces a new resource to be created.
job_schedule_id (pulumi.Input[str]) – The UUID identifying the Automation Job Schedule.
parameters (pulumi.Input[dict]) – A map of key/value pairs corresponding to the arguments that can be passed to the Runbook. Changing this forces a new resource to be created.
resource_group_name (pulumi.Input[str]) – The name of the resource group in which the Job Schedule is created. Changing this forces a new resource to be created.
run_on (pulumi.Input[str]) – Name of a Hybrid Worker Group the Runbook will be executed on. Changing this forces a new resource to be created.
runbook_name (pulumi.Input[str]) – The name of a Runbook to link to a Schedule. It needs to be in the same Automation Account as the Schedule and Job Schedule. Changing this forces a new resource to be created.

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.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_account = azure.automation.Account("exampleAccount",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    sku=[{
        "name": "Basic",
    }])
example_module = azure.automation.Module("exampleModule",
    resource_group_name=example_resource_group.name,
    automation_account_name=example_account.name,
    module_link={
        "uri": "https://devopsgallerystorage.blob.core.windows.net/packages/xactivedirectory.2.19.0.nupkg",
    })

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: pulumi.Output[str] = None¶: The name of the automation account in which the Module is created. Changing this forces a new resource to be created.

module_link: pulumi.Output[dict] = None¶

The published Module link.

hash (dict)
- algorithm (str)
- value (str)
uri (str) - The uri of the module content (zip or nupkg).

name: pulumi.Output[str] = None¶: Specifies the name of the Module. Changing this forces a new resource to be created.

resource_group_name: pulumi.Output[str] = 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, automation_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.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_account = azure.automation.Account("exampleAccount",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    sku=[{
        "name": "Basic",
    }])
example_run_book = azure.automation.RunBook("exampleRunBook",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    automation_account_name=example_account.name,
    log_verbose="true",
    log_progress="true",
    description="This is an example runbook",
    runbook_type="PowerShellWorkflow",
    publish_content_link={
        "uri": "https://raw.githubusercontent.com/Azure/azure-quickstart-templates/c4935ffb69246a6058eb24f54640f53f69d3ac9f/101-automation-runbook-getvms/Runbooks/Get-AzureVMTutorial.ps1",
    })

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 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])

automation_account_name: pulumi.Output[str] = None¶: The name of the automation account in which the Runbook is created. Changing this forces a new resource to be created.

content: pulumi.Output[str] = None¶: The desired content of the runbook.

description: pulumi.Output[str] = None¶: A description for this credential.

location: pulumi.Output[str] = None¶: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

log_progress: pulumi.Output[bool] = None¶: Progress log option.

log_verbose: pulumi.Output[bool] = None¶: Verbose log option.

name: pulumi.Output[str] = None¶: Specifies the name of the Runbook. Changing this forces a new resource to be created.

publish_content_link: pulumi.Output[dict] = None¶

The published runbook content link.

hash (dict)
- algorithm (str)
- value (str)
uri (str) - The uri of the runbook content.
version (str)

resource_group_name: pulumi.Output[str] = None¶: The name of the resource group in which the Runbook is created. Changing this forces a new resource to be created.

runbook_type: pulumi.Output[str] = None¶: The type of the runbook - can be either Graph, GraphPowerShell, GraphPowerShellWorkflow, PowerShellWorkflow, PowerShell or Script.

tags: pulumi.Output[dict] = None¶: A mapping of tags to assign to the resource.

static get(resource_name, id, opts=None, automation_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.
automation_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, 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.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_account = azure.automation.Account("exampleAccount",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    sku=[{
        "name": "Basic",
    }])
example_schedule = azure.automation.Schedule("exampleSchedule",
    resource_group_name=example_resource_group.name,
    automation_account_name=example_account.name,
    frequency="Week",
    interval=1,
    timezone="Central Europe Standard Time",
    start_time="2014-04-15T18:00:15+02:00",
    description="This is an example schedule",
    week_days=["Friday"])

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]) - Day of the occurrence. Must be one of Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday.
occurrence (pulumi.Input[float]) - Occurrence of the week within the month. Must be between 1 and 5. -1 for last week within the month.

automation_account_name: pulumi.Output[str] = None¶: The name of the automation account in which the Schedule is created. Changing this forces a new resource to be created.

description: pulumi.Output[str] = None¶: A description for this Schedule.

expiry_time: pulumi.Output[str] = None¶: The end time of the schedule.

frequency: pulumi.Output[str] = None¶: The frequency of the schedule. - can be either OneTime, Day, Hour, Week, or Month.

interval: pulumi.Output[float] = None¶: The number of frequencys between runs. Only valid when frequency is Day, Hour, Week, or Month and defaults to 1.

month_days: pulumi.Output[list] = 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: pulumi.Output[list] = 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) - Day of the occurrence. Must be one of Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday.
occurrence (float) - Occurrence of the week within the month. Must be between 1 and 5. -1 for last week within the month.

name: pulumi.Output[str] = None¶: Specifies the name of the Schedule. Changing this forces a new resource to be created.

resource_group_name: pulumi.Output[str] = None¶: The name of the resource group in which the Schedule is created. Changing this forces a new resource to be created.

start_time: pulumi.Output[str] = 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: pulumi.Output[str] = 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: pulumi.Output[list] = 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, 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]) - Day of the occurrence. Must be one of Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday.
occurrence (pulumi.Input[float]) - Occurrence of the week within the month. Must be between 1 and 5. -1 for last week within the month.

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

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West US")
example_account = azure.automation.Account("exampleAccount",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    sku=[{
        "name": "Basic",
    }])
example_string_variable = azure.automation.StringVariable("exampleStringVariable",
    resource_group_name=example_resource_group.name,
    automation_account_name=example_account.name,
    value="Hello, Basic Test.")

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: pulumi.Output[str] = None¶: The name of the automation account in which the Variable is created. Changing this forces a new resource to be created.

description: pulumi.Output[str] = None¶: The description of the Automation Variable.

encrypted: pulumi.Output[bool] = None¶: Specifies if the Automation Variable is encrypted. Defaults to false.

name: pulumi.Output[str] = None¶: The name of the Automation Variable. Changing this forces a new resource to be created.

resource_group_name: pulumi.Output[str] = None¶: The name of the resource group in which to create the Automation Variable. Changing this forces a new resource to be created.

value: pulumi.Output[str] = 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_account(name=None, resource_group_name=None, opts=None)¶

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

import pulumi
import pulumi_azure as azure

example = azure.automation.get_account(name="example-account",
    resource_group_name="example-resources")
pulumi.export("automationAccountId", example.id)

Parameters

name (str) – The name of the Automation Account.
resource_group_name (str) – Specifies the name of the Resource Group where the Automation Account exists.

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.

import pulumi
import pulumi_azure as azure

example = azure.automation.get_bool_variable(name="tfex-example-var",
    resource_group_name="tfex-example-rg",
    automation_account_name="tfex-example-account")
pulumi.export("variableId", example.id)

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.

import pulumi
import pulumi_azure as azure

example = azure.automation.get_date_time_variable(name="tfex-example-var",
    resource_group_name="tfex-example-rg",
    automation_account_name="tfex-example-account")
pulumi.export("variableId", example.id)

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.

import pulumi
import pulumi_azure as azure

example = azure.automation.get_int_variable(name="tfex-example-var",
    resource_group_name="tfex-example-rg",
    automation_account_name="tfex-example-account")
pulumi.export("variableId", example.id)

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.

import pulumi
import pulumi_azure as azure

example = azure.automation.get_string_variable(name="tfex-example-var",
    resource_group_name="tfex-example-rg",
    automation_account_name="tfex-example-account")
pulumi.export("variableId", example.id)

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.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

automation¶

On This Page