Run
data class RunBookArgs(val automationAccountName: Output<String>? = null, val content: Output<String>? = null, val description: Output<String>? = null, val draft: Output<RunBookDraftArgs>? = null, val jobSchedules: Output<List<RunBookJobScheduleArgs>>? = null, val location: Output<String>? = null, val logActivityTraceLevel: Output<Int>? = null, val logProgress: Output<Boolean>? = null, val logVerbose: Output<Boolean>? = null, val name: Output<String>? = null, val publishContentLink: Output<RunBookPublishContentLinkArgs>? = null, val resourceGroupName: Output<String>? = null, val runbookType: Output<String>? = null, val tags: Output<Map<String, String>>? = null) : ConvertibleToJava<RunBookArgs>
Manages a Automation Runbook.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const example = new azure.core.ResourceGroup("example", {
name: "example-resources",
location: "West Europe",
});
const exampleAccount = new azure.automation.Account("example", {
name: "account1",
location: example.location,
resourceGroupName: example.name,
skuName: "Basic",
});
const exampleRunBook = new azure.automation.RunBook("example", {
name: "Get-AzureVMTutorial",
location: example.location,
resourceGroupName: example.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",
},
});Content copied to clipboard
import pulumi
import pulumi_azure as azure
example = azure.core.ResourceGroup("example",
name="example-resources",
location="West Europe")
example_account = azure.automation.Account("example",
name="account1",
location=example.location,
resource_group_name=example.name,
sku_name="Basic")
example_run_book = azure.automation.RunBook("example",
name="Get-AzureVMTutorial",
location=example.location,
resource_group_name=example.name,
automation_account_name=example_account.name,
log_verbose=True,
log_progress=True,
description="This is an example runbook",
runbook_type="PowerShellWorkflow",
publish_content_link={
"uri": "https://raw.githubusercontent.com/Azure/azure-quickstart-templates/c4935ffb69246a6058eb24f54640f53f69d3ac9f/101-automation-runbook-getvms/Runbooks/Get-AzureVMTutorial.ps1",
})Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
return await Deployment.RunAsync(() =>
{
var example = new Azure.Core.ResourceGroup("example", new()
{
Name = "example-resources",
Location = "West Europe",
});
var exampleAccount = new Azure.Automation.Account("example", new()
{
Name = "account1",
Location = example.Location,
ResourceGroupName = example.Name,
SkuName = "Basic",
});
var exampleRunBook = new Azure.Automation.RunBook("example", new()
{
Name = "Get-AzureVMTutorial",
Location = example.Location,
ResourceGroupName = example.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",
},
});
});Content copied to clipboard
package main
import (
"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/automation"
"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
Name: pulumi.String("example-resources"),
Location: pulumi.String("West Europe"),
})
if err != nil {
return err
}
exampleAccount, err := automation.NewAccount(ctx, "example", &automation.AccountArgs{
Name: pulumi.String("account1"),
Location: example.Location,
ResourceGroupName: example.Name,
SkuName: pulumi.String("Basic"),
})
if err != nil {
return err
}
_, err = automation.NewRunBook(ctx, "example", &automation.RunBookArgs{
Name: pulumi.String("Get-AzureVMTutorial"),
Location: example.Location,
ResourceGroupName: example.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
})
}Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.automation.Account;
import com.pulumi.azure.automation.AccountArgs;
import com.pulumi.azure.automation.RunBook;
import com.pulumi.azure.automation.RunBookArgs;
import com.pulumi.azure.automation.inputs.RunBookPublishContentLinkArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new ResourceGroup("example", ResourceGroupArgs.builder()
.name("example-resources")
.location("West Europe")
.build());
var exampleAccount = new Account("exampleAccount", AccountArgs.builder()
.name("account1")
.location(example.location())
.resourceGroupName(example.name())
.skuName("Basic")
.build());
var exampleRunBook = new RunBook("exampleRunBook", RunBookArgs.builder()
.name("Get-AzureVMTutorial")
.location(example.location())
.resourceGroupName(example.name())
.automationAccountName(exampleAccount.name())
.logVerbose("true")
.logProgress("true")
.description("This is an example runbook")
.runbookType("PowerShellWorkflow")
.publishContentLink(RunBookPublishContentLinkArgs.builder()
.uri("https://raw.githubusercontent.com/Azure/azure-quickstart-templates/c4935ffb69246a6058eb24f54640f53f69d3ac9f/101-automation-runbook-getvms/Runbooks/Get-AzureVMTutorial.ps1")
.build())
.build());
}
}Content copied to clipboard
resources:
example:
type: azure:core:ResourceGroup
properties:
name: example-resources
location: West Europe
exampleAccount:
type: azure:automation:Account
name: example
properties:
name: account1
location: ${example.location}
resourceGroupName: ${example.name}
skuName: Basic
exampleRunBook:
type: azure:automation:RunBook
name: example
properties:
name: Get-AzureVMTutorial
location: ${example.location}
resourceGroupName: ${example.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.ps1Content copied to clipboard
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-AzureVMTutorialContent copied to clipboard
Constructors
Link copied to clipboard
constructor(automationAccountName: Output<String>? = null, content: Output<String>? = null, description: Output<String>? = null, draft: Output<RunBookDraftArgs>? = null, jobSchedules: Output<List<RunBookJobScheduleArgs>>? = null, location: Output<String>? = null, logActivityTraceLevel: Output<Int>? = null, logProgress: Output<Boolean>? = null, logVerbose: Output<Boolean>? = null, name: Output<String>? = null, publishContentLink: Output<RunBookPublishContentLinkArgs>? = null, resourceGroupName: Output<String>? = null, runbookType: Output<String>? = null, tags: Output<Map<String, String>>? = null)
Properties
Link copied to clipboard
The name of the automation account in which the Runbook is created. Changing this forces a new resource to be created.
Link copied to clipboard
A description for this credential.
Link copied to clipboard
A draft block as defined below.
Link copied to clipboard
One or more job_schedule block as defined below.
Link copied to clipboard
Specifies the activity-level tracing options of the runbook, available only for Graphical runbooks. Possible values are 0 for None, 9 for Basic, and 15 for Detailed. Must turn on Verbose logging in order to see the tracing.
Link copied to clipboard
Progress log option.
Link copied to clipboard
Verbose log option.
Link copied to clipboard
One publish_content_link block as defined below.
Link copied to clipboard
The name of the resource group in which the Runbook is created. Changing this forces a new resource to be created.
Link copied to clipboard
The type of the runbook - can be either Graph, GraphPowerShell, GraphPowerShellWorkflow, PowerShellWorkflow, PowerShell, PowerShell72, Python3, Python2 or Script. Changing this forces a new resource to be created.