azure.automation.RunBook (v4)

Azure v4.42.0 (4.x), Mar 9 26

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

Go to latest version

Schema (JSON)

pulumi/pulumi-azure

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

Go to latest version

Schema (JSON)

pulumi/pulumi-azure

Example Usage

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new Azure.Core.ResourceGroupArgs
        {
            Location = "West Europe",
        });
        var exampleAccount = new Azure.Automation.Account("exampleAccount", new Azure.Automation.AccountArgs
        {
            Location = exampleResourceGroup.Location,
            ResourceGroupName = exampleResourceGroup.Name,
            SkuName = "Basic",
        });
        var exampleRunBook = new Azure.Automation.RunBook("exampleRunBook", new Azure.Automation.RunBookArgs
        {
            Location = exampleResourceGroup.Location,
            ResourceGroupName = exampleResourceGroup.Name,
            AutomationAccountName = exampleAccount.Name,
            LogVerbose = true,
            LogProgress = true,
            Description = "This is an example runbook",
            RunbookType = "PowerShellWorkflow",
            PublishContentLink = new Azure.Automation.Inputs.RunBookPublishContentLinkArgs
            {
                Uri = "https://raw.githubusercontent.com/Azure/azure-quickstart-templates/c4935ffb69246a6058eb24f54640f53f69d3ac9f/101-automation-runbook-getvms/Runbooks/Get-AzureVMTutorial.ps1",
            },
        });
    }

}

package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/automation"
	"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/core"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleAccount, err := automation.NewAccount(ctx, "exampleAccount", &automation.AccountArgs{
			Location:          exampleResourceGroup.Location,
			ResourceGroupName: exampleResourceGroup.Name,
			SkuName:           pulumi.String("Basic"),
		})
		if err != nil {
			return err
		}
		_, err = automation.NewRunBook(ctx, "exampleRunBook", &automation.RunBookArgs{
			Location:              exampleResourceGroup.Location,
			ResourceGroupName:     exampleResourceGroup.Name,
			AutomationAccountName: exampleAccount.Name,
			LogVerbose:            pulumi.Bool(true),
			LogProgress:           pulumi.Bool(true),
			Description:           pulumi.String("This is an example runbook"),
			RunbookType:           pulumi.String("PowerShellWorkflow"),
			PublishContentLink: &automation.RunBookPublishContentLinkArgs{
				Uri: pulumi.String("https://raw.githubusercontent.com/Azure/azure-quickstart-templates/c4935ffb69246a6058eb24f54640f53f69d3ac9f/101-automation-runbook-getvms/Runbooks/Get-AzureVMTutorial.ps1"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

Example coming soon!

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",
});
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",
    publishContentLink: {
        uri: "https://raw.githubusercontent.com/Azure/azure-quickstart-templates/c4935ffb69246a6058eb24f54640f53f69d3ac9f/101-automation-runbook-getvms/Runbooks/Get-AzureVMTutorial.ps1",
    },
});

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=azure.automation.RunBookPublishContentLinkArgs(
        uri="https://raw.githubusercontent.com/Azure/azure-quickstart-templates/c4935ffb69246a6058eb24f54640f53f69d3ac9f/101-automation-runbook-getvms/Runbooks/Get-AzureVMTutorial.ps1",
    ))

Example coming soon!

Create RunBook Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

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

@overload
def RunBook(resource_name: str,
            args: RunBookArgs,
            opts: Optional[ResourceOptions] = None)

@overload
def RunBook(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            automation_account_name: Optional[str] = None,
            log_progress: Optional[bool] = None,
            log_verbose: Optional[bool] = None,
            resource_group_name: Optional[str] = None,
            runbook_type: Optional[str] = None,
            content: Optional[str] = None,
            description: Optional[str] = None,
            job_schedules: Optional[Sequence[RunBookJobScheduleArgs]] = None,
            location: Optional[str] = None,
            name: Optional[str] = None,
            publish_content_link: Optional[RunBookPublishContentLinkArgs] = None,
            tags: Optional[Mapping[str, str]] = None)

func NewRunBook(ctx *Context, name string, args RunBookArgs, opts ...ResourceOption) (*RunBook, error)

public RunBook(string name, RunBookArgs args, CustomResourceOptions? opts = null)

public RunBook(String name, RunBookArgs args)
public RunBook(String name, RunBookArgs args, CustomResourceOptions options)

type: azure:automation:RunBook
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args RunBookArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args RunBookArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args RunBookArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args RunBookArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args RunBookArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var runBookResource = new Azure.Automation.RunBook("runBookResource", new()
{
    AutomationAccountName = "string",
    LogProgress = false,
    LogVerbose = false,
    ResourceGroupName = "string",
    RunbookType = "string",
    Content = "string",
    Description = "string",
    JobSchedules = new[]
    {
        new Azure.Automation.Inputs.RunBookJobScheduleArgs
        {
            ScheduleName = "string",
            JobScheduleId = "string",
            Parameters = 
            {
                { "string", "string" },
            },
            RunOn = "string",
        },
    },
    Location = "string",
    Name = "string",
    PublishContentLink = new Azure.Automation.Inputs.RunBookPublishContentLinkArgs
    {
        Uri = "string",
        Hash = new Azure.Automation.Inputs.RunBookPublishContentLinkHashArgs
        {
            Algorithm = "string",
            Value = "string",
        },
        Version = "string",
    },
    Tags = 
    {
        { "string", "string" },
    },
});

example, err := automation.NewRunBook(ctx, "runBookResource", &automation.RunBookArgs{
	AutomationAccountName: pulumi.String("string"),
	LogProgress:           pulumi.Bool(false),
	LogVerbose:            pulumi.Bool(false),
	ResourceGroupName:     pulumi.String("string"),
	RunbookType:           pulumi.String("string"),
	Content:               pulumi.String("string"),
	Description:           pulumi.String("string"),
	JobSchedules: automation.RunBookJobScheduleArray{
		&automation.RunBookJobScheduleArgs{
			ScheduleName:  pulumi.String("string"),
			JobScheduleId: pulumi.String("string"),
			Parameters: pulumi.StringMap{
				"string": pulumi.String("string"),
			},
			RunOn: pulumi.String("string"),
		},
	},
	Location: pulumi.String("string"),
	Name:     pulumi.String("string"),
	PublishContentLink: &automation.RunBookPublishContentLinkArgs{
		Uri: pulumi.String("string"),
		Hash: &automation.RunBookPublishContentLinkHashArgs{
			Algorithm: pulumi.String("string"),
			Value:     pulumi.String("string"),
		},
		Version: pulumi.String("string"),
	},
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

var runBookResource = new RunBook("runBookResource", RunBookArgs.builder()
    .automationAccountName("string")
    .logProgress(false)
    .logVerbose(false)
    .resourceGroupName("string")
    .runbookType("string")
    .content("string")
    .description("string")
    .jobSchedules(RunBookJobScheduleArgs.builder()
        .scheduleName("string")
        .jobScheduleId("string")
        .parameters(Map.of("string", "string"))
        .runOn("string")
        .build())
    .location("string")
    .name("string")
    .publishContentLink(RunBookPublishContentLinkArgs.builder()
        .uri("string")
        .hash(RunBookPublishContentLinkHashArgs.builder()
            .algorithm("string")
            .value("string")
            .build())
        .version("string")
        .build())
    .tags(Map.of("string", "string"))
    .build());

run_book_resource = azure.automation.RunBook("runBookResource",
    automation_account_name="string",
    log_progress=False,
    log_verbose=False,
    resource_group_name="string",
    runbook_type="string",
    content="string",
    description="string",
    job_schedules=[{
        "schedule_name": "string",
        "job_schedule_id": "string",
        "parameters": {
            "string": "string",
        },
        "run_on": "string",
    }],
    location="string",
    name="string",
    publish_content_link={
        "uri": "string",
        "hash": {
            "algorithm": "string",
            "value": "string",
        },
        "version": "string",
    },
    tags={
        "string": "string",
    })

const runBookResource = new azure.automation.RunBook("runBookResource", {
    automationAccountName: "string",
    logProgress: false,
    logVerbose: false,
    resourceGroupName: "string",
    runbookType: "string",
    content: "string",
    description: "string",
    jobSchedules: [{
        scheduleName: "string",
        jobScheduleId: "string",
        parameters: {
            string: "string",
        },
        runOn: "string",
    }],
    location: "string",
    name: "string",
    publishContentLink: {
        uri: "string",
        hash: {
            algorithm: "string",
            value: "string",
        },
        version: "string",
    },
    tags: {
        string: "string",
    },
});

type: azure:automation:RunBook
properties:
    automationAccountName: string
    content: string
    description: string
    jobSchedules:
        - jobScheduleId: string
          parameters:
            string: string
          runOn: string
          scheduleName: string
    location: string
    logProgress: false
    logVerbose: false
    name: string
    publishContentLink:
        hash:
            algorithm: string
            value: string
        uri: string
        version: string
    resourceGroupName: string
    runbookType: string
    tags:
        string: string

RunBook Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The RunBook resource accepts the following input properties:

AutomationAccountName string: The name of the automation account in which the Runbook is created. Changing this forces a new resource to be created.
LogProgress bool: Progress log option.
LogVerbose bool: Verbose log option.
ResourceGroupName string: The name of the resource group in which the Runbook is created. Changing this forces a new resource to be created.
RunbookType string: The type of the runbook - can be either Graph, GraphPowerShell, GraphPowerShellWorkflow, PowerShellWorkflow, PowerShell or Script.
Content string: The desired content of the runbook.
Description string: A description for this credential.
JobSchedules List<RunBookJobSchedule>
Location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name string: Specifies the name of the Runbook. Changing this forces a new resource to be created.
PublishContentLink RunBookPublishContentLink: The published runbook content link.
Tags Dictionary<string, string>: A mapping of tags to assign to the resource.

AutomationAccountName string: The name of the automation account in which the Runbook is created. Changing this forces a new resource to be created.
LogProgress bool: Progress log option.
LogVerbose bool: Verbose log option.
ResourceGroupName string: The name of the resource group in which the Runbook is created. Changing this forces a new resource to be created.
RunbookType string: The type of the runbook - can be either Graph, GraphPowerShell, GraphPowerShellWorkflow, PowerShellWorkflow, PowerShell or Script.
Content string: The desired content of the runbook.
Description string: A description for this credential.
JobSchedules []RunBookJobScheduleArgs
Location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name string: Specifies the name of the Runbook. Changing this forces a new resource to be created.
PublishContentLink RunBookPublishContentLinkArgs: The published runbook content link.
Tags map[string]string: A mapping of tags to assign to the resource.

automationAccountName String: The name of the automation account in which the Runbook is created. Changing this forces a new resource to be created.
logProgress Boolean: Progress log option.
logVerbose Boolean: Verbose log option.
resourceGroupName String: The name of the resource group in which the Runbook is created. Changing this forces a new resource to be created.
runbookType String: The type of the runbook - can be either Graph, GraphPowerShell, GraphPowerShellWorkflow, PowerShellWorkflow, PowerShell or Script.
content String: The desired content of the runbook.
description String: A description for this credential.
jobSchedules List<RunBookJobSchedule>
location String: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name String: Specifies the name of the Runbook. Changing this forces a new resource to be created.
publishContentLink RunBookPublishContentLink: The published runbook content link.
tags Map<String,String>: A mapping of tags to assign to the resource.

automationAccountName string: The name of the automation account in which the Runbook is created. Changing this forces a new resource to be created.
logProgress boolean: Progress log option.
logVerbose boolean: Verbose log option.
resourceGroupName string: The name of the resource group in which the Runbook is created. Changing this forces a new resource to be created.
runbookType string: The type of the runbook - can be either Graph, GraphPowerShell, GraphPowerShellWorkflow, PowerShellWorkflow, PowerShell or Script.
content string: The desired content of the runbook.
description string: A description for this credential.
jobSchedules RunBookJobSchedule[]
location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name string: Specifies the name of the Runbook. Changing this forces a new resource to be created.
publishContentLink RunBookPublishContentLink: The published runbook content link.
tags {[key: string]: string}: A mapping of tags to assign to the resource.

automation_account_name str: The name of the automation account in which the Runbook is created. Changing this forces a new resource to be created.
log_progress bool: Progress log option.
log_verbose bool: Verbose log option.
resource_group_name str: The name of the resource group in which the Runbook is created. Changing this forces a new resource to be created.
runbook_type str: The type of the runbook - can be either Graph, GraphPowerShell, GraphPowerShellWorkflow, PowerShellWorkflow, PowerShell or Script.
content str: The desired content of the runbook.
description str: A description for this credential.
job_schedules Sequence[RunBookJobScheduleArgs]
location str: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name str: Specifies the name of the Runbook. Changing this forces a new resource to be created.
publish_content_link RunBookPublishContentLinkArgs: The published runbook content link.
tags Mapping[str, str]: A mapping of tags to assign to the resource.

automationAccountName String: The name of the automation account in which the Runbook is created. Changing this forces a new resource to be created.
logProgress Boolean: Progress log option.
logVerbose Boolean: Verbose log option.
resourceGroupName String: The name of the resource group in which the Runbook is created. Changing this forces a new resource to be created.
runbookType String: The type of the runbook - can be either Graph, GraphPowerShell, GraphPowerShellWorkflow, PowerShellWorkflow, PowerShell or Script.
content String: The desired content of the runbook.
description String: A description for this credential.
jobSchedules List<Property Map>
location String: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name String: Specifies the name of the Runbook. Changing this forces a new resource to be created.
publishContentLink Property Map: The published runbook content link.
tags Map<String>: A mapping of tags to assign to the resource.

Outputs

All input properties are implicitly available as output properties. Additionally, the RunBook resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

Look up Existing RunBook Resource

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

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

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        automation_account_name: Optional[str] = None,
        content: Optional[str] = None,
        description: Optional[str] = None,
        job_schedules: Optional[Sequence[RunBookJobScheduleArgs]] = None,
        location: Optional[str] = None,
        log_progress: Optional[bool] = None,
        log_verbose: Optional[bool] = None,
        name: Optional[str] = None,
        publish_content_link: Optional[RunBookPublishContentLinkArgs] = None,
        resource_group_name: Optional[str] = None,
        runbook_type: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None) -> RunBook

func GetRunBook(ctx *Context, name string, id IDInput, state *RunBookState, opts ...ResourceOption) (*RunBook, error)

public static RunBook Get(string name, Input<string> id, RunBookState? state, CustomResourceOptions? opts = null)

public static RunBook get(String name, Output<String> id, RunBookState state, CustomResourceOptions options)

resources:  _:    type: azure:automation:RunBook    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

AutomationAccountName string: The name of the automation account in which the Runbook is created. Changing this forces a new resource to be created.
Content string: The desired content of the runbook.
Description string: A description for this credential.
JobSchedules List<RunBookJobSchedule>
Location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
LogProgress bool: Progress log option.
LogVerbose bool: Verbose log option.
Name string: Specifies the name of the Runbook. Changing this forces a new resource to be created.
PublishContentLink RunBookPublishContentLink: The published runbook content link.
ResourceGroupName string: The name of the resource group in which the Runbook is created. Changing this forces a new resource to be created.
RunbookType string: The type of the runbook - can be either Graph, GraphPowerShell, GraphPowerShellWorkflow, PowerShellWorkflow, PowerShell or Script.
Tags Dictionary<string, string>: A mapping of tags to assign to the resource.

AutomationAccountName string: The name of the automation account in which the Runbook is created. Changing this forces a new resource to be created.
Content string: The desired content of the runbook.
Description string: A description for this credential.
JobSchedules []RunBookJobScheduleArgs
Location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
LogProgress bool: Progress log option.
LogVerbose bool: Verbose log option.
Name string: Specifies the name of the Runbook. Changing this forces a new resource to be created.
PublishContentLink RunBookPublishContentLinkArgs: The published runbook content link.
ResourceGroupName string: The name of the resource group in which the Runbook is created. Changing this forces a new resource to be created.
RunbookType string: The type of the runbook - can be either Graph, GraphPowerShell, GraphPowerShellWorkflow, PowerShellWorkflow, PowerShell or Script.
Tags map[string]string: A mapping of tags to assign to the resource.

automationAccountName String: The name of the automation account in which the Runbook is created. Changing this forces a new resource to be created.
content String: The desired content of the runbook.
description String: A description for this credential.
jobSchedules List<RunBookJobSchedule>
location String: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
logProgress Boolean: Progress log option.
logVerbose Boolean: Verbose log option.
name String: Specifies the name of the Runbook. Changing this forces a new resource to be created.
publishContentLink RunBookPublishContentLink: The published runbook content link.
resourceGroupName String: The name of the resource group in which the Runbook is created. Changing this forces a new resource to be created.
runbookType String: The type of the runbook - can be either Graph, GraphPowerShell, GraphPowerShellWorkflow, PowerShellWorkflow, PowerShell or Script.
tags Map<String,String>: A mapping of tags to assign to the resource.

automationAccountName string: The name of the automation account in which the Runbook is created. Changing this forces a new resource to be created.
content string: The desired content of the runbook.
description string: A description for this credential.
jobSchedules RunBookJobSchedule[]
location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
logProgress boolean: Progress log option.
logVerbose boolean: Verbose log option.
name string: Specifies the name of the Runbook. Changing this forces a new resource to be created.
publishContentLink RunBookPublishContentLink: The published runbook content link.
resourceGroupName string: The name of the resource group in which the Runbook is created. Changing this forces a new resource to be created.
runbookType string: The type of the runbook - can be either Graph, GraphPowerShell, GraphPowerShellWorkflow, PowerShellWorkflow, PowerShell or Script.
tags {[key: string]: string}: A mapping of tags to assign to the resource.

automation_account_name str: The name of the automation account in which the Runbook is created. Changing this forces a new resource to be created.
content str: The desired content of the runbook.
description str: A description for this credential.
job_schedules Sequence[RunBookJobScheduleArgs]
location str: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
log_progress bool: Progress log option.
log_verbose bool: Verbose log option.
name str: Specifies the name of the Runbook. Changing this forces a new resource to be created.
publish_content_link RunBookPublishContentLinkArgs: The published runbook content link.
resource_group_name str: The name of the resource group in which the Runbook is created. Changing this forces a new resource to be created.
runbook_type str: The type of the runbook - can be either Graph, GraphPowerShell, GraphPowerShellWorkflow, PowerShellWorkflow, PowerShell or Script.
tags Mapping[str, str]: A mapping of tags to assign to the resource.

automationAccountName String: The name of the automation account in which the Runbook is created. Changing this forces a new resource to be created.
content String: The desired content of the runbook.
description String: A description for this credential.
jobSchedules List<Property Map>
location String: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
logProgress Boolean: Progress log option.
logVerbose Boolean: Verbose log option.
name String: Specifies the name of the Runbook. Changing this forces a new resource to be created.
publishContentLink Property Map: The published runbook content link.
resourceGroupName String: The name of the resource group in which the Runbook is created. Changing this forces a new resource to be created.
runbookType String: The type of the runbook - can be either Graph, GraphPowerShell, GraphPowerShellWorkflow, PowerShellWorkflow, PowerShell or Script.
tags Map<String>: A mapping of tags to assign to the resource.

Supporting Types

RunBookJobSchedule, RunBookJobScheduleArgs

ScheduleName string
JobScheduleId string
Parameters Dictionary<string, string>
RunOn string

ScheduleName string
JobScheduleId string
Parameters map[string]string
RunOn string

scheduleName String
jobScheduleId String
parameters Map<String,String>
runOn String

scheduleName string
jobScheduleId string
parameters {[key: string]: string}
runOn string

schedule_name str
job_schedule_id str
parameters Mapping[str, str]
run_on str

scheduleName String
jobScheduleId String
parameters Map<String>
runOn String

RunBookPublishContentLink, RunBookPublishContentLinkArgs

Uri string: The uri of the runbook content.
Hash RunBookPublishContentLinkHash
Version string

Uri string: The uri of the runbook content.
Hash RunBookPublishContentLinkHash
Version string

uri String: The uri of the runbook content.
hash RunBookPublishContentLinkHash
version String

uri string: The uri of the runbook content.
hash RunBookPublishContentLinkHash
version string

uri str: The uri of the runbook content.
hash RunBookPublishContentLinkHash
version str

uri String: The uri of the runbook content.
hash Property Map
version String

RunBookPublishContentLinkHash, RunBookPublishContentLinkHashArgs

Algorithm string
Value string

Algorithm string
Value string

algorithm String
value String

algorithm string
value string

algorithm str
value str

algorithm String
value String

Import

Automation Runbooks can be imported using the resource id, e.g.

 $ pulumi import azure:automation/runBook:RunBook Get-AzureVMTutorial /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.Automation/automationAccounts/account1/runbooks/Get-AzureVMTutorial

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository: Azure Classic pulumi/pulumi-azure
License: Apache-2.0
Notes: This Pulumi package is based on the azurerm Terraform Provider.

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

Go to latest version

Schema (JSON)

pulumi/pulumi-azure

azure.automation.RunBook

On this page

On this page

Example Usage

Create RunBook Resource

Constructor syntax

Parameters

Constructor example

RunBook Resource Properties

Inputs

Outputs

Look up Existing RunBook Resource

Supporting Types

RunBookJobSchedule, RunBookJobScheduleArgs

RunBookPublishContentLink, RunBookPublishContentLinkArgs

RunBookPublishContentLinkHash, RunBookPublishContentLinkHashArgs

Import

Package Details

On this page

On this page