1. Docs
  2. Reference
  3. API
  4. @pulumi/azure
  5. automation

Module automation

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.

Resources

Functions

Others

Resources

Resource Account

class Account extends CustomResource

Manages a Automation Account.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleAccount = new azure.automation.Account("exampleAccount", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    skuName: "Basic",
    tags: {
        environment: "development",
    },
});

constructor

new Account(name: string, args: AccountArgs, opts?: pulumi.CustomResourceOptions)

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

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

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: AccountState, opts?: pulumi.CustomResourceOptions): Account

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Account

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

property dscPrimaryAccessKey

public dscPrimaryAccessKey: pulumi.Output<string>;

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

property dscSecondaryAccessKey

public dscSecondaryAccessKey: pulumi.Output<string>;

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

property dscServerEndpoint

public dscServerEndpoint: pulumi.Output<string>;

The DSC Server Endpoint associated with this Automation Account.

property id

id: Output<ID>;

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

property location

public location: pulumi.Output<string>;

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

property name

public name: pulumi.Output<string>;

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

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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

property skuName

public skuName: pulumi.Output<string>;

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

property tags

public tags: pulumi.Output<{[key: string]: string} | undefined>;

A mapping of tags to assign to the resource.

property urn

urn: Output<URN>;

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

Resource BoolVariable

class BoolVariable extends CustomResource

Manages a boolean variable in Azure Automation

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West US"});
const exampleAccount = new azure.automation.Account("exampleAccount", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    sku: [{
        name: "Basic",
    }],
});
const exampleBoolVariable = new azure.automation.BoolVariable("exampleBoolVariable", {
    resourceGroupName: exampleResourceGroup.name,
    automationAccountName: exampleAccount.name,
    value: false,
});

constructor

new BoolVariable(name: string, args: BoolVariableArgs, opts?: pulumi.CustomResourceOptions)

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

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

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: BoolVariableState, opts?: pulumi.CustomResourceOptions): BoolVariable

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is BoolVariable

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

property automationAccountName

public automationAccountName: pulumi.Output<string>;

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

property description

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

The description of the Automation Variable.

property encrypted

public encrypted: pulumi.Output<boolean | undefined>;

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

property id

id: Output<ID>;

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

property name

public name: pulumi.Output<string>;

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

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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

property urn

urn: Output<URN>;

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

property value

public value: pulumi.Output<boolean | undefined>;

The value of the Automation Variable as a boolean.

Resource Certificate

class Certificate extends CustomResource

Manages an Automation Certificate.

constructor

new Certificate(name: string, args: CertificateArgs, opts?: pulumi.CustomResourceOptions)

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

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

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: CertificateState, opts?: pulumi.CustomResourceOptions): Certificate

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Certificate

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

property automationAccountName

public automationAccountName: pulumi.Output<string>;

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

property base64

public base64: pulumi.Output<string>;

Base64 encoded value of the certificate.

property description

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

The description of this Automation Certificate.

property exportable

public exportable: pulumi.Output<boolean>;

property id

id: Output<ID>;

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

property name

public name: pulumi.Output<string>;

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

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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

property thumbprint

public thumbprint: pulumi.Output<string>;

The thumbprint for the certificate.

property urn

urn: Output<URN>;

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

Resource Credential

class Credential extends CustomResource

Manages a Automation Credential.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleAccount = new azure.automation.Account("exampleAccount", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    sku: [{
        name: "Basic",
    }],
});
const exampleCredential = new azure.automation.Credential("exampleCredential", {
    resourceGroupName: exampleResourceGroup.name,
    automationAccountName: exampleAccount.name,
    username: "example_user",
    password: "example_pwd",
    description: "This is an example credential",
});

constructor

new Credential(name: string, args: CredentialArgs, opts?: pulumi.CustomResourceOptions)

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

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

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: CredentialState, opts?: pulumi.CustomResourceOptions): Credential

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Credential

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

property automationAccountName

public automationAccountName: pulumi.Output<string>;

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

property description

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

The description associated with this Automation Credential.

property id

id: Output<ID>;

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

property name

public name: pulumi.Output<string>;

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

property password

public password: pulumi.Output<string>;

The password associated with this Automation Credential.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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

property urn

urn: Output<URN>;

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

property username

public username: pulumi.Output<string>;

The username associated with this Automation Credential.

Resource DateTimeVariable

class DateTimeVariable extends CustomResource

Manages a DateTime variable in Azure Automation

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West US"});
const exampleAccount = new azure.automation.Account("exampleAccount", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    sku: [{
        name: "Basic",
    }],
});
const exampleDateTimeVariable = new azure.automation.DateTimeVariable("exampleDateTimeVariable", {
    resourceGroupName: exampleResourceGroup.name,
    automationAccountName: exampleAccount.name,
    value: "2019-04-24T21:40:54.074Z",
});

constructor

new DateTimeVariable(name: string, args: DateTimeVariableArgs, opts?: pulumi.CustomResourceOptions)

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

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

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: DateTimeVariableState, opts?: pulumi.CustomResourceOptions): DateTimeVariable

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is DateTimeVariable

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

property automationAccountName

public automationAccountName: pulumi.Output<string>;

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

property description

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

The description of the Automation Variable.

property encrypted

public encrypted: pulumi.Output<boolean | undefined>;

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

property id

id: Output<ID>;

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

property name

public name: pulumi.Output<string>;

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

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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

property urn

urn: Output<URN>;

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

property value

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

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

Resource DscConfiguration

class DscConfiguration extends CustomResource

Manages a Automation DSC Configuration.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleAccount = new azure.automation.Account("exampleAccount", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    sku: [{
        name: "Basic",
    }],
});
const exampleDscConfiguration = new azure.automation.DscConfiguration("exampleDscConfiguration", {
    resourceGroupName: exampleResourceGroup.name,
    automationAccountName: exampleAccount.name,
    location: exampleResourceGroup.location,
    contentEmbedded: "configuration test {}",
});

constructor

new DscConfiguration(name: string, args: DscConfigurationArgs, opts?: pulumi.CustomResourceOptions)

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

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

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: DscConfigurationState, opts?: pulumi.CustomResourceOptions): DscConfiguration

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is DscConfiguration

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

property automationAccountName

public automationAccountName: pulumi.Output<string>;

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

property contentEmbedded

public contentEmbedded: pulumi.Output<string>;

The PowerShell DSC Configuration script.

property description

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

Description to go with DSC Configuration.

property id

id: Output<ID>;

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

property location

public location: pulumi.Output<string>;

Must be the same location as the Automation Account.

property logVerbose

public logVerbose: pulumi.Output<boolean | undefined>;

Verbose log option.

property name

public name: pulumi.Output<string>;

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

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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

property state

public state: pulumi.Output<string>;

property tags

public tags: pulumi.Output<{[key: string]: string} | undefined>;

A mapping of tags to assign to the resource.

property urn

urn: Output<URN>;

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

Resource DscNodeConfiguration

class DscNodeConfiguration extends CustomResource

Manages a Automation DSC Node Configuration.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleAccount = new azure.automation.Account("exampleAccount", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    sku: [{
        name: "Basic",
    }],
});
const exampleDscConfiguration = new azure.automation.DscConfiguration("exampleDscConfiguration", {
    resourceGroupName: exampleResourceGroup.name,
    automationAccountName: exampleAccount.name,
    location: exampleResourceGroup.location,
    contentEmbedded: "configuration test {}",
});
const exampleDscNodeConfiguration = new azure.automation.DscNodeConfiguration("exampleDscNodeConfiguration", {
    resourceGroupName: exampleResourceGroup.name,
    automationAccountName: exampleAccount.name,
    contentEmbedded: `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";
};
`,
});

constructor

new DscNodeConfiguration(name: string, args: DscNodeConfigurationArgs, opts?: pulumi.CustomResourceOptions)

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

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

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: DscNodeConfigurationState, opts?: pulumi.CustomResourceOptions): DscNodeConfiguration

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is DscNodeConfiguration

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

property automationAccountName

public automationAccountName: pulumi.Output<string>;

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

property configurationName

public configurationName: pulumi.Output<string>;

property contentEmbedded

public contentEmbedded: pulumi.Output<string>;

The PowerShell DSC Node Configuration (mof content).

property id

id: Output<ID>;

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

property name

public name: pulumi.Output<string>;

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

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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

property urn

urn: Output<URN>;

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

Resource IntVariable

class IntVariable extends CustomResource

Manages a integer variable in Azure Automation

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West US"});
const exampleAccount = new azure.automation.Account("exampleAccount", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    sku: [{
        name: "Basic",
    }],
});
const exampleIntVariable = new azure.automation.IntVariable("exampleIntVariable", {
    resourceGroupName: exampleResourceGroup.name,
    automationAccountName: exampleAccount.name,
    value: 1234,
});

constructor

new IntVariable(name: string, args: IntVariableArgs, opts?: pulumi.CustomResourceOptions)

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

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

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: IntVariableState, opts?: pulumi.CustomResourceOptions): IntVariable

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is IntVariable

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

property automationAccountName

public automationAccountName: pulumi.Output<string>;

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

property description

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

The description of the Automation Variable.

property encrypted

public encrypted: pulumi.Output<boolean | undefined>;

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

property id

id: Output<ID>;

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

property name

public name: pulumi.Output<string>;

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

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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

property urn

urn: Output<URN>;

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

property value

public value: pulumi.Output<number | undefined>;

The value of the Automation Variable as a integer.

Resource JobSchedule

class JobSchedule extends CustomResource

Links an Automation Runbook and Schedule.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = new azure.automation.JobSchedule("example", {
    automationAccountName: "tf-automation-account",
    parameters: {
        resourcegroup: "tf-rgr-vm",
        vmname: "TF-VM-01",
    },
    resourceGroupName: "tf-rgr-automation",
    runbookName: "Get-VirtualMachine",
    scheduleName: "hour",
});

constructor

new JobSchedule(name: string, args: JobScheduleArgs, opts?: pulumi.CustomResourceOptions)

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

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

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: JobScheduleState, opts?: pulumi.CustomResourceOptions): JobSchedule

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is JobSchedule

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

property automationAccountName

public automationAccountName: pulumi.Output<string>;

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

property id

id: Output<ID>;

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

property jobScheduleId

public jobScheduleId: pulumi.Output<string>;

The UUID identifying the Automation Job Schedule.

property parameters

public parameters: pulumi.Output<{[key: string]: string} | undefined>;

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.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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

property runOn

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

Name of a Hybrid Worker Group the Runbook will be executed on. Changing this forces a new resource to be created.

property runbookName

public runbookName: pulumi.Output<string>;

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.

property scheduleName

public scheduleName: pulumi.Output<string>;

property urn

urn: Output<URN>;

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

Resource Module

class Module extends CustomResource

Manages a Automation Module.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleAccount = new azure.automation.Account("exampleAccount", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    sku: [{
        name: "Basic",
    }],
});
const exampleModule = new azure.automation.Module("exampleModule", {
    resourceGroupName: exampleResourceGroup.name,
    automationAccountName: exampleAccount.name,
    module_link: {
        uri: "https://devopsgallerystorage.blob.core.windows.net/packages/xactivedirectory.2.19.0.nupkg",
    },
});

constructor

new Module(name: string, args: ModuleArgs, opts?: pulumi.CustomResourceOptions)

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

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

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ModuleState, opts?: pulumi.CustomResourceOptions): Module

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Module

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

property automationAccountName

public automationAccountName: pulumi.Output<string>;

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

property id

id: Output<ID>;

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

public moduleLink: pulumi.Output<ModuleModuleLink>;

The published Module link.

property name

public name: pulumi.Output<string>;

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

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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

property urn

urn: Output<URN>;

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

Resource RunBook

class RunBook extends CustomResource

Manages a Automation Runbook.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleAccount = new azure.automation.Account("exampleAccount", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    sku: [{
        name: "Basic",
    }],
});
const exampleRunBook = new azure.automation.RunBook("exampleRunBook", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    automationAccountName: exampleAccount.name,
    logVerbose: "true",
    logProgress: "true",
    description: "This is an example runbook",
    runbookType: "PowerShellWorkflow",
    publish_content_link: {
        uri: "https://raw.githubusercontent.com/Azure/azure-quickstart-templates/c4935ffb69246a6058eb24f54640f53f69d3ac9f/101-automation-runbook-getvms/Runbooks/Get-AzureVMTutorial.ps1",
    },
});

constructor

new RunBook(name: string, args: RunBookArgs, opts?: pulumi.CustomResourceOptions)

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

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

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: RunBookState, opts?: pulumi.CustomResourceOptions): RunBook

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is RunBook

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

property automationAccountName

public automationAccountName: pulumi.Output<string>;

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

property content

public content: pulumi.Output<string>;

The desired content of the runbook.

property description

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

A description for this credential.

property id

id: Output<ID>;

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

property location

public location: pulumi.Output<string>;

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

property logProgress

public logProgress: pulumi.Output<boolean>;

Progress log option.

property logVerbose

public logVerbose: pulumi.Output<boolean>;

Verbose log option.

property name

public name: pulumi.Output<string>;

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

public publishContentLink: pulumi.Output<RunBookPublishContentLink | undefined>;

The published runbook content link.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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

property runbookType

public runbookType: pulumi.Output<string>;

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

property tags

public tags: pulumi.Output<{[key: string]: string} | undefined>;

A mapping of tags to assign to the resource.

property urn

urn: Output<URN>;

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

Resource Schedule

class Schedule extends CustomResource

Manages a Automation Schedule.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleAccount = new azure.automation.Account("exampleAccount", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    sku: [{
        name: "Basic",
    }],
});
const exampleSchedule = new azure.automation.Schedule("exampleSchedule", {
    resourceGroupName: exampleResourceGroup.name,
    automationAccountName: exampleAccount.name,
    frequency: "Week",
    interval: 1,
    timezone: "Central Europe Standard Time",
    startTime: "2014-04-15T18:00:15+02:00",
    description: "This is an example schedule",
    weekDays: ["Friday"],
});

constructor

new Schedule(name: string, args: ScheduleArgs, opts?: pulumi.CustomResourceOptions)

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

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

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ScheduleState, opts?: pulumi.CustomResourceOptions): Schedule

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Schedule

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

property automationAccountName

public automationAccountName: pulumi.Output<string>;

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

property description

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

A description for this Schedule.

property expiryTime

public expiryTime: pulumi.Output<string>;

The end time of the schedule.

property frequency

public frequency: pulumi.Output<string>;

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

property id

id: Output<ID>;

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

property interval

public interval: pulumi.Output<number>;

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

property monthDays

public monthDays: pulumi.Output<number[] | undefined>;

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.

property monthlyOccurrences

public monthlyOccurrences: pulumi.Output<ScheduleMonthlyOccurrence[] | undefined>;

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

property name

public name: pulumi.Output<string>;

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

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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

property startTime

public startTime: pulumi.Output<string>;

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.

property timezone

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

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

property urn

urn: Output<URN>;

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

property weekDays

public weekDays: pulumi.Output<string[] | undefined>;

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

Resource StringVariable

class StringVariable extends CustomResource

Manages a string variable in Azure Automation

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West US"});
const exampleAccount = new azure.automation.Account("exampleAccount", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    sku: [{
        name: "Basic",
    }],
});
const exampleStringVariable = new azure.automation.StringVariable("exampleStringVariable", {
    resourceGroupName: exampleResourceGroup.name,
    automationAccountName: exampleAccount.name,
    value: "Hello, Basic Test.",
});

constructor

new StringVariable(name: string, args: StringVariableArgs, opts?: pulumi.CustomResourceOptions)

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

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

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: StringVariableState, opts?: pulumi.CustomResourceOptions): StringVariable

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is StringVariable

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

property automationAccountName

public automationAccountName: pulumi.Output<string>;

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

property description

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

The description of the Automation Variable.

property encrypted

public encrypted: pulumi.Output<boolean | undefined>;

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

property id

id: Output<ID>;

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

property name

public name: pulumi.Output<string>;

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

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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

property urn

urn: Output<URN>;

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

property value

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

The value of the Automation Variable as a string.

Functions

Function getAccount

getAccount(args: GetAccountArgs, opts?: pulumi.InvokeOptions): Promise<GetAccountResult>

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

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = azure.automation.getAccount({
    name: "example-account",
    resourceGroupName: "example-resources",
});
export const automationAccountId = example.then(example => example.id);

Function getBoolVariable

getBoolVariable(args: GetBoolVariableArgs, opts?: pulumi.InvokeOptions): Promise<GetBoolVariableResult>

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

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = azure.automation.getBoolVariable({
    name: "tfex-example-var",
    resourceGroupName: "tfex-example-rg",
    automationAccountName: "tfex-example-account",
});
export const variableId = example.then(example => example.id);

Function getDateTimeVariable

getDateTimeVariable(args: GetDateTimeVariableArgs, opts?: pulumi.InvokeOptions): Promise<GetDateTimeVariableResult>

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

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = azure.automation.getDateTimeVariable({
    name: "tfex-example-var",
    resourceGroupName: "tfex-example-rg",
    automationAccountName: "tfex-example-account",
});
export const variableId = example.then(example => example.id);

Function getIntVariable

getIntVariable(args: GetIntVariableArgs, opts?: pulumi.InvokeOptions): Promise<GetIntVariableResult>

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

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = azure.automation.getIntVariable({
    name: "tfex-example-var",
    resourceGroupName: "tfex-example-rg",
    automationAccountName: "tfex-example-account",
});
export const variableId = example.then(example => example.id);

Function getStringVariable

getStringVariable(args: GetStringVariableArgs, opts?: pulumi.InvokeOptions): Promise<GetStringVariableResult>

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

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = azure.automation.getStringVariable({
    name: "tfex-example-var",
    resourceGroupName: "tfex-example-rg",
    automationAccountName: "tfex-example-account",
});
export const variableId = example.then(example => example.id);

Others

interface AccountArgs

interface AccountArgs

The set of arguments for constructing a Account resource.

property location

location?: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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

property skuName

skuName: pulumi.Input<string>;

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

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

interface AccountState

interface AccountState

Input properties used for looking up and filtering Account resources.

property dscPrimaryAccessKey

dscPrimaryAccessKey?: pulumi.Input<string>;

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

property dscSecondaryAccessKey

dscSecondaryAccessKey?: pulumi.Input<string>;

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

property dscServerEndpoint

dscServerEndpoint?: pulumi.Input<string>;

The DSC Server Endpoint associated with this Automation Account.

property location

location?: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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

property skuName

skuName?: pulumi.Input<string>;

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

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

interface BoolVariableArgs

interface BoolVariableArgs

The set of arguments for constructing a BoolVariable resource.

property automationAccountName

automationAccountName: pulumi.Input<string>;

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

property description

description?: pulumi.Input<string>;

The description of the Automation Variable.

property encrypted

encrypted?: pulumi.Input<boolean>;

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

property name

name?: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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

property value

value?: pulumi.Input<boolean>;

The value of the Automation Variable as a boolean.

interface BoolVariableState

interface BoolVariableState

Input properties used for looking up and filtering BoolVariable resources.

property automationAccountName

automationAccountName?: pulumi.Input<string>;

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

property description

description?: pulumi.Input<string>;

The description of the Automation Variable.

property encrypted

encrypted?: pulumi.Input<boolean>;

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

property name

name?: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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

property value

value?: pulumi.Input<boolean>;

The value of the Automation Variable as a boolean.

interface CertificateArgs

interface CertificateArgs

The set of arguments for constructing a Certificate resource.

property automationAccountName

automationAccountName: pulumi.Input<string>;

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

property base64

base64: pulumi.Input<string>;

Base64 encoded value of the certificate.

property description

description?: pulumi.Input<string>;

The description of this Automation Certificate.

property name

name?: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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

interface CertificateState

interface CertificateState

Input properties used for looking up and filtering Certificate resources.

property automationAccountName

automationAccountName?: pulumi.Input<string>;

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

property base64

base64?: pulumi.Input<string>;

Base64 encoded value of the certificate.

property description

description?: pulumi.Input<string>;

The description of this Automation Certificate.

property exportable

exportable?: pulumi.Input<boolean>;

property name

name?: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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

property thumbprint

thumbprint?: pulumi.Input<string>;

The thumbprint for the certificate.

interface CredentialArgs

interface CredentialArgs

The set of arguments for constructing a Credential resource.

property automationAccountName

automationAccountName: pulumi.Input<string>;

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

property description

description?: pulumi.Input<string>;

The description associated with this Automation Credential.

property name

name?: pulumi.Input<string>;

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

property password

password: pulumi.Input<string>;

The password associated with this Automation Credential.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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

property username

username: pulumi.Input<string>;

The username associated with this Automation Credential.

interface CredentialState

interface CredentialState

Input properties used for looking up and filtering Credential resources.

property automationAccountName

automationAccountName?: pulumi.Input<string>;

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

property description

description?: pulumi.Input<string>;

The description associated with this Automation Credential.

property name

name?: pulumi.Input<string>;

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

property password

password?: pulumi.Input<string>;

The password associated with this Automation Credential.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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

property username

username?: pulumi.Input<string>;

The username associated with this Automation Credential.

interface DateTimeVariableArgs

interface DateTimeVariableArgs

The set of arguments for constructing a DateTimeVariable resource.

property automationAccountName

automationAccountName: pulumi.Input<string>;

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

property description

description?: pulumi.Input<string>;

The description of the Automation Variable.

property encrypted

encrypted?: pulumi.Input<boolean>;

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

property name

name?: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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

property value

value?: pulumi.Input<string>;

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

interface DateTimeVariableState

interface DateTimeVariableState

Input properties used for looking up and filtering DateTimeVariable resources.

property automationAccountName

automationAccountName?: pulumi.Input<string>;

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

property description

description?: pulumi.Input<string>;

The description of the Automation Variable.

property encrypted

encrypted?: pulumi.Input<boolean>;

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

property name

name?: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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

property value

value?: pulumi.Input<string>;

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

interface DscConfigurationArgs

interface DscConfigurationArgs

The set of arguments for constructing a DscConfiguration resource.

property automationAccountName

automationAccountName: pulumi.Input<string>;

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

property contentEmbedded

contentEmbedded: pulumi.Input<string>;

The PowerShell DSC Configuration script.

property description

description?: pulumi.Input<string>;

Description to go with DSC Configuration.

property location

location?: pulumi.Input<string>;

Must be the same location as the Automation Account.

property logVerbose

logVerbose?: pulumi.Input<boolean>;

Verbose log option.

property name

name?: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

interface DscConfigurationState

interface DscConfigurationState

Input properties used for looking up and filtering DscConfiguration resources.

property automationAccountName

automationAccountName?: pulumi.Input<string>;

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

property contentEmbedded

contentEmbedded?: pulumi.Input<string>;

The PowerShell DSC Configuration script.

property description

description?: pulumi.Input<string>;

Description to go with DSC Configuration.

property location

location?: pulumi.Input<string>;

Must be the same location as the Automation Account.

property logVerbose

logVerbose?: pulumi.Input<boolean>;

Verbose log option.

property name

name?: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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

property state

state?: pulumi.Input<string>;

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

interface DscNodeConfigurationArgs

interface DscNodeConfigurationArgs

The set of arguments for constructing a DscNodeConfiguration resource.

property automationAccountName

automationAccountName: pulumi.Input<string>;

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

property contentEmbedded

contentEmbedded: pulumi.Input<string>;

The PowerShell DSC Node Configuration (mof content).

property name

name?: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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

interface DscNodeConfigurationState

interface DscNodeConfigurationState

Input properties used for looking up and filtering DscNodeConfiguration resources.

property automationAccountName

automationAccountName?: pulumi.Input<string>;

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

property configurationName

configurationName?: pulumi.Input<string>;

property contentEmbedded

contentEmbedded?: pulumi.Input<string>;

The PowerShell DSC Node Configuration (mof content).

property name

name?: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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

interface GetAccountArgs

interface GetAccountArgs

A collection of arguments for invoking getAccount.

property name

name: string;

The name of the Automation Account.

property resourceGroupName

resourceGroupName: string;

Specifies the name of the Resource Group where the Automation Account exists.

interface GetAccountResult

interface GetAccountResult

A collection of values returned by getAccount.

property endpoint

endpoint: string;

The Endpoint for this Auomation Account.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property name

name: string;

property primaryKey

primaryKey: string;

The Primary Access Key for the Automation Account.

property resourceGroupName

resourceGroupName: string;

property secondaryKey

secondaryKey: string;

The Secondary Access Key for the Automation Account.

interface GetBoolVariableArgs

interface GetBoolVariableArgs

A collection of arguments for invoking getBoolVariable.

property automationAccountName

automationAccountName: string;

The name of the automation account in which the Automation Variable exists.

property name

name: string;

The name of the Automation Variable.

property resourceGroupName

resourceGroupName: string;

The Name of the Resource Group where the automation account exists.

interface GetBoolVariableResult

interface GetBoolVariableResult

A collection of values returned by getBoolVariable.

property automationAccountName

automationAccountName: string;

property description

description: string;

The description of the Automation Variable.

property encrypted

encrypted: boolean;

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

property id

id: string;

The provider-assigned unique ID for this managed resource.

property name

name: string;

property resourceGroupName

resourceGroupName: string;

property value

value: boolean;

The value of the Automation Variable as a boolean.

interface GetDateTimeVariableArgs

interface GetDateTimeVariableArgs

A collection of arguments for invoking getDateTimeVariable.

property automationAccountName

automationAccountName: string;

The name of the automation account in which the Automation Variable exists.

property name

name: string;

The name of the Automation Variable.

property resourceGroupName

resourceGroupName: string;

The Name of the Resource Group where the automation account exists.

interface GetDateTimeVariableResult

interface GetDateTimeVariableResult

A collection of values returned by getDateTimeVariable.

property automationAccountName

automationAccountName: string;

property description

description: string;

The description of the Automation Variable.

property encrypted

encrypted: boolean;

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

property id

id: string;

The provider-assigned unique ID for this managed resource.

property name

name: string;

property resourceGroupName

resourceGroupName: string;

property value

value: string;

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

interface GetIntVariableArgs

interface GetIntVariableArgs

A collection of arguments for invoking getIntVariable.

property automationAccountName

automationAccountName: string;

The name of the automation account in which the Automation Variable exists.

property name

name: string;

The name of the Automation Variable.

property resourceGroupName

resourceGroupName: string;

The Name of the Resource Group where the automation account exists.

interface GetIntVariableResult

interface GetIntVariableResult

A collection of values returned by getIntVariable.

property automationAccountName

automationAccountName: string;

property description

description: string;

The description of the Automation Variable.

property encrypted

encrypted: boolean;

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

property id

id: string;

The provider-assigned unique ID for this managed resource.

property name

name: string;

property resourceGroupName

resourceGroupName: string;

property value

value: number;

The value of the Automation Variable as a integer.

interface GetStringVariableArgs

interface GetStringVariableArgs

A collection of arguments for invoking getStringVariable.

property automationAccountName

automationAccountName: string;

The name of the automation account in which the Automation Variable exists.

property name

name: string;

The name of the Automation Variable.

property resourceGroupName

resourceGroupName: string;

The Name of the Resource Group where the automation account exists.

interface GetStringVariableResult

interface GetStringVariableResult

A collection of values returned by getStringVariable.

property automationAccountName

automationAccountName: string;

property description

description: string;

The description of the Automation Variable.

property encrypted

encrypted: boolean;

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

property id

id: string;

The provider-assigned unique ID for this managed resource.

property name

name: string;

property resourceGroupName

resourceGroupName: string;

property value

value: string;

The value of the Automation Variable as a string.

interface IntVariableArgs

interface IntVariableArgs

The set of arguments for constructing a IntVariable resource.

property automationAccountName

automationAccountName: pulumi.Input<string>;

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

property description

description?: pulumi.Input<string>;

The description of the Automation Variable.

property encrypted

encrypted?: pulumi.Input<boolean>;

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

property name

name?: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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

property value

value?: pulumi.Input<number>;

The value of the Automation Variable as a integer.

interface IntVariableState

interface IntVariableState

Input properties used for looking up and filtering IntVariable resources.

property automationAccountName

automationAccountName?: pulumi.Input<string>;

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

property description

description?: pulumi.Input<string>;

The description of the Automation Variable.

property encrypted

encrypted?: pulumi.Input<boolean>;

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

property name

name?: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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

property value

value?: pulumi.Input<number>;

The value of the Automation Variable as a integer.

interface JobScheduleArgs

interface JobScheduleArgs

The set of arguments for constructing a JobSchedule resource.

property automationAccountName

automationAccountName: pulumi.Input<string>;

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

property jobScheduleId

jobScheduleId?: pulumi.Input<string>;

The UUID identifying the Automation Job Schedule.

property parameters

parameters?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

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.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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

property runOn

runOn?: pulumi.Input<string>;

Name of a Hybrid Worker Group the Runbook will be executed on. Changing this forces a new resource to be created.

property runbookName

runbookName: pulumi.Input<string>;

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.

property scheduleName

scheduleName: pulumi.Input<string>;

interface JobScheduleState

interface JobScheduleState

Input properties used for looking up and filtering JobSchedule resources.

property automationAccountName

automationAccountName?: pulumi.Input<string>;

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

property jobScheduleId

jobScheduleId?: pulumi.Input<string>;

The UUID identifying the Automation Job Schedule.

property parameters

parameters?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

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.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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

property runOn

runOn?: pulumi.Input<string>;

Name of a Hybrid Worker Group the Runbook will be executed on. Changing this forces a new resource to be created.

property runbookName

runbookName?: pulumi.Input<string>;

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.

property scheduleName

scheduleName?: pulumi.Input<string>;

interface ModuleArgs

interface ModuleArgs

The set of arguments for constructing a Module resource.

property automationAccountName

automationAccountName: pulumi.Input<string>;

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

moduleLink: pulumi.Input<ModuleModuleLink>;

The published Module link.

property name

name?: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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

interface ModuleState

interface ModuleState

Input properties used for looking up and filtering Module resources.

property automationAccountName

automationAccountName?: pulumi.Input<string>;

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

moduleLink?: pulumi.Input<ModuleModuleLink>;

The published Module link.

property name

name?: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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

interface RunBookArgs

interface RunBookArgs

The set of arguments for constructing a RunBook resource.

property automationAccountName

automationAccountName: pulumi.Input<string>;

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

property content

content?: pulumi.Input<string>;

The desired content of the runbook.

property description

description?: pulumi.Input<string>;

A description for this credential.

property location

location?: pulumi.Input<string>;

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

property logProgress

logProgress: pulumi.Input<boolean>;

Progress log option.

property logVerbose

logVerbose: pulumi.Input<boolean>;

Verbose log option.

property name

name?: pulumi.Input<string>;

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

publishContentLink?: pulumi.Input<RunBookPublishContentLink>;

The published runbook content link.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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

property runbookType

runbookType: pulumi.Input<string>;

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

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

interface RunBookState

interface RunBookState

Input properties used for looking up and filtering RunBook resources.

property automationAccountName

automationAccountName?: pulumi.Input<string>;

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

property content

content?: pulumi.Input<string>;

The desired content of the runbook.

property description

description?: pulumi.Input<string>;

A description for this credential.

property location

location?: pulumi.Input<string>;

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

property logProgress

logProgress?: pulumi.Input<boolean>;

Progress log option.

property logVerbose

logVerbose?: pulumi.Input<boolean>;

Verbose log option.

property name

name?: pulumi.Input<string>;

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

publishContentLink?: pulumi.Input<RunBookPublishContentLink>;

The published runbook content link.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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

property runbookType

runbookType?: pulumi.Input<string>;

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

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

interface ScheduleArgs

interface ScheduleArgs

The set of arguments for constructing a Schedule resource.

property automationAccountName

automationAccountName: pulumi.Input<string>;

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

property description

description?: pulumi.Input<string>;

A description for this Schedule.

property expiryTime

expiryTime?: pulumi.Input<string>;

The end time of the schedule.

property frequency

frequency: pulumi.Input<string>;

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

property interval

interval?: pulumi.Input<number>;

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

property monthDays

monthDays?: pulumi.Input<pulumi.Input<number>[]>;

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.

property monthlyOccurrences

monthlyOccurrences?: pulumi.Input<pulumi.Input<ScheduleMonthlyOccurrence>[]>;

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

property name

name?: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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

property startTime

startTime?: pulumi.Input<string>;

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.

property timezone

timezone?: pulumi.Input<string>;

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

property weekDays

weekDays?: pulumi.Input<pulumi.Input<string>[]>;

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

interface ScheduleState

interface ScheduleState

Input properties used for looking up and filtering Schedule resources.

property automationAccountName

automationAccountName?: pulumi.Input<string>;

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

property description

description?: pulumi.Input<string>;

A description for this Schedule.

property expiryTime

expiryTime?: pulumi.Input<string>;

The end time of the schedule.

property frequency

frequency?: pulumi.Input<string>;

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

property interval

interval?: pulumi.Input<number>;

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

property monthDays

monthDays?: pulumi.Input<pulumi.Input<number>[]>;

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.

property monthlyOccurrences

monthlyOccurrences?: pulumi.Input<pulumi.Input<ScheduleMonthlyOccurrence>[]>;

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

property name

name?: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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

property startTime

startTime?: pulumi.Input<string>;

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.

property timezone

timezone?: pulumi.Input<string>;

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

property weekDays

weekDays?: pulumi.Input<pulumi.Input<string>[]>;

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

interface StringVariableArgs

interface StringVariableArgs

The set of arguments for constructing a StringVariable resource.

property automationAccountName

automationAccountName: pulumi.Input<string>;

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

property description

description?: pulumi.Input<string>;

The description of the Automation Variable.

property encrypted

encrypted?: pulumi.Input<boolean>;

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

property name

name?: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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

property value

value?: pulumi.Input<string>;

The value of the Automation Variable as a string.

interface StringVariableState

interface StringVariableState

Input properties used for looking up and filtering StringVariable resources.

property automationAccountName

automationAccountName?: pulumi.Input<string>;

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

property description

description?: pulumi.Input<string>;

The description of the Automation Variable.

property encrypted

encrypted?: pulumi.Input<boolean>;

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

property name

name?: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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

property value

value?: pulumi.Input<string>;

The value of the Automation Variable as a string.