Docs Packages
  1. Packages
  2. Azure Native
  3. API Docs
  4. automation
  5. Runbook
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.37.0 published on Monday, Apr 15, 2024 by Pulumi
pulumi/pulumi-azure-native

azure-native.automation.Runbook

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.37.0 published on Monday, Apr 15, 2024 by Pulumi
pulumi/pulumi-azure-native

    Definition of the runbook type. Azure REST API version: 2022-08-08. Prior API version in Azure Native 1.x: 2019-06-01.

    Other available API versions: 2023-05-15-preview, 2023-11-01.

    Example Usage

    Create or update runbook and publish it

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var runbook = new AzureNative.Automation.Runbook("runbook", new()
    {
        AutomationAccountName = "ContoseAutomationAccount",
        Description = "Description of the Runbook",
        Location = "East US 2",
        LogActivityTrace = 1,
        LogProgress = true,
        LogVerbose = false,
        Name = "Get-AzureVMTutorial",
        PublishContentLink = new AzureNative.Automation.Inputs.ContentLinkArgs
        {
            ContentHash = new AzureNative.Automation.Inputs.ContentHashArgs
            {
                Algorithm = "SHA256",
                Value = "115775B8FF2BE672D8A946BD0B489918C724DDE15A440373CA54461D53010A80",
            },
            Uri = "https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/101-automation-runbook-getvms/Runbooks/Get-AzureVMTutorial.ps1",
        },
        ResourceGroupName = "rg",
        RunbookName = "Get-AzureVMTutorial",
        RunbookType = AzureNative.Automation.RunbookTypeEnum.PowerShellWorkflow,
        Tags = 
        {
            { "tag01", "value01" },
            { "tag02", "value02" },
        },
    });

});

    package main

import (
	"github.com/pulumi/pulumi-azure-native-sdk/automation/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := automation.NewRunbook(ctx, "runbook", &automation.RunbookArgs{
			AutomationAccountName: pulumi.String("ContoseAutomationAccount"),
			Description:           pulumi.String("Description of the Runbook"),
			Location:              pulumi.String("East US 2"),
			LogActivityTrace:      pulumi.Int(1),
			LogProgress:           pulumi.Bool(true),
			LogVerbose:            pulumi.Bool(false),
			Name:                  pulumi.String("Get-AzureVMTutorial"),
			PublishContentLink: &automation.ContentLinkArgs{
				ContentHash: &automation.ContentHashArgs{
					Algorithm: pulumi.String("SHA256"),
					Value:     pulumi.String("115775B8FF2BE672D8A946BD0B489918C724DDE15A440373CA54461D53010A80"),
				},
				Uri: pulumi.String("https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/101-automation-runbook-getvms/Runbooks/Get-AzureVMTutorial.ps1"),
			},
			ResourceGroupName: pulumi.String("rg"),
			RunbookName:       pulumi.String("Get-AzureVMTutorial"),
			RunbookType:       pulumi.String(automation.RunbookTypeEnumPowerShellWorkflow),
			Tags: pulumi.StringMap{
				"tag01": pulumi.String("value01"),
				"tag02": pulumi.String("value02"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.automation.Runbook;
import com.pulumi.azurenative.automation.RunbookArgs;
import com.pulumi.azurenative.automation.inputs.ContentLinkArgs;
import com.pulumi.azurenative.automation.inputs.ContentHashArgs;
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 runbook = new Runbook("runbook", RunbookArgs.builder()        
            .automationAccountName("ContoseAutomationAccount")
            .description("Description of the Runbook")
            .location("East US 2")
            .logActivityTrace(1)
            .logProgress(true)
            .logVerbose(false)
            .name("Get-AzureVMTutorial")
            .publishContentLink(ContentLinkArgs.builder()
                .contentHash(ContentHashArgs.builder()
                    .algorithm("SHA256")
                    .value("115775B8FF2BE672D8A946BD0B489918C724DDE15A440373CA54461D53010A80")
                    .build())
                .uri("https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/101-automation-runbook-getvms/Runbooks/Get-AzureVMTutorial.ps1")
                .build())
            .resourceGroupName("rg")
            .runbookName("Get-AzureVMTutorial")
            .runbookType("PowerShellWorkflow")
            .tags(Map.ofEntries(
                Map.entry("tag01", "value01"),
                Map.entry("tag02", "value02")
            ))
            .build());

    }
}

    import pulumi
import pulumi_azure_native as azure_native

runbook = azure_native.automation.Runbook("runbook",
    automation_account_name="ContoseAutomationAccount",
    description="Description of the Runbook",
    location="East US 2",
    log_activity_trace=1,
    log_progress=True,
    log_verbose=False,
    name="Get-AzureVMTutorial",
    publish_content_link=azure_native.automation.ContentLinkArgs(
        content_hash=azure_native.automation.ContentHashArgs(
            algorithm="SHA256",
            value="115775B8FF2BE672D8A946BD0B489918C724DDE15A440373CA54461D53010A80",
        ),
        uri="https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/101-automation-runbook-getvms/Runbooks/Get-AzureVMTutorial.ps1",
    ),
    resource_group_name="rg",
    runbook_name="Get-AzureVMTutorial",
    runbook_type=azure_native.automation.RunbookTypeEnum.POWER_SHELL_WORKFLOW,
    tags={
        "tag01": "value01",
        "tag02": "value02",
    })

    import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const runbook = new azure_native.automation.Runbook("runbook", {
    automationAccountName: "ContoseAutomationAccount",
    description: "Description of the Runbook",
    location: "East US 2",
    logActivityTrace: 1,
    logProgress: true,
    logVerbose: false,
    name: "Get-AzureVMTutorial",
    publishContentLink: {
        contentHash: {
            algorithm: "SHA256",
            value: "115775B8FF2BE672D8A946BD0B489918C724DDE15A440373CA54461D53010A80",
        },
        uri: "https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/101-automation-runbook-getvms/Runbooks/Get-AzureVMTutorial.ps1",
    },
    resourceGroupName: "rg",
    runbookName: "Get-AzureVMTutorial",
    runbookType: azure_native.automation.RunbookTypeEnum.PowerShellWorkflow,
    tags: {
        tag01: "value01",
        tag02: "value02",
    },
});

    resources:
  runbook:
    type: azure-native:automation:Runbook
    properties:
      automationAccountName: ContoseAutomationAccount
      description: Description of the Runbook
      location: East US 2
      logActivityTrace: 1
      logProgress: true
      logVerbose: false
      name: Get-AzureVMTutorial
      publishContentLink:
        contentHash:
          algorithm: SHA256
          value: 115775B8FF2BE672D8A946BD0B489918C724DDE15A440373CA54461D53010A80
        uri: https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/101-automation-runbook-getvms/Runbooks/Get-AzureVMTutorial.ps1
      resourceGroupName: rg
      runbookName: Get-AzureVMTutorial
      runbookType: PowerShellWorkflow
      tags:
        tag01: value01
        tag02: value02

    Create runbook as draft

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var runbook = new AzureNative.Automation.Runbook("runbook", new()
    {
        AutomationAccountName = "ContoseAutomationAccount",
        Description = "Description of the Runbook",
        Draft = null,
        Location = "East US 2",
        LogProgress = false,
        LogVerbose = false,
        Name = "Get-AzureVMTutorial",
        ResourceGroupName = "rg",
        RunbookName = "Get-AzureVMTutorial",
        RunbookType = AzureNative.Automation.RunbookTypeEnum.PowerShellWorkflow,
        Tags = 
        {
            { "tag01", "value01" },
            { "tag02", "value02" },
        },
    });

});

    package main

import (
	"github.com/pulumi/pulumi-azure-native-sdk/automation/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := automation.NewRunbook(ctx, "runbook", &automation.RunbookArgs{
			AutomationAccountName: pulumi.String("ContoseAutomationAccount"),
			Description:           pulumi.String("Description of the Runbook"),
			Draft:                 nil,
			Location:              pulumi.String("East US 2"),
			LogProgress:           pulumi.Bool(false),
			LogVerbose:            pulumi.Bool(false),
			Name:                  pulumi.String("Get-AzureVMTutorial"),
			ResourceGroupName:     pulumi.String("rg"),
			RunbookName:           pulumi.String("Get-AzureVMTutorial"),
			RunbookType:           pulumi.String(automation.RunbookTypeEnumPowerShellWorkflow),
			Tags: pulumi.StringMap{
				"tag01": pulumi.String("value01"),
				"tag02": pulumi.String("value02"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.automation.Runbook;
import com.pulumi.azurenative.automation.RunbookArgs;
import com.pulumi.azurenative.automation.inputs.RunbookDraftArgs;
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 runbook = new Runbook("runbook", RunbookArgs.builder()        
            .automationAccountName("ContoseAutomationAccount")
            .description("Description of the Runbook")
            .draft()
            .location("East US 2")
            .logProgress(false)
            .logVerbose(false)
            .name("Get-AzureVMTutorial")
            .resourceGroupName("rg")
            .runbookName("Get-AzureVMTutorial")
            .runbookType("PowerShellWorkflow")
            .tags(Map.ofEntries(
                Map.entry("tag01", "value01"),
                Map.entry("tag02", "value02")
            ))
            .build());

    }
}

    import pulumi
import pulumi_azure_native as azure_native

runbook = azure_native.automation.Runbook("runbook",
    automation_account_name="ContoseAutomationAccount",
    description="Description of the Runbook",
    draft=azure_native.automation.RunbookDraftArgs(),
    location="East US 2",
    log_progress=False,
    log_verbose=False,
    name="Get-AzureVMTutorial",
    resource_group_name="rg",
    runbook_name="Get-AzureVMTutorial",
    runbook_type=azure_native.automation.RunbookTypeEnum.POWER_SHELL_WORKFLOW,
    tags={
        "tag01": "value01",
        "tag02": "value02",
    })

    import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const runbook = new azure_native.automation.Runbook("runbook", {
    automationAccountName: "ContoseAutomationAccount",
    description: "Description of the Runbook",
    draft: {},
    location: "East US 2",
    logProgress: false,
    logVerbose: false,
    name: "Get-AzureVMTutorial",
    resourceGroupName: "rg",
    runbookName: "Get-AzureVMTutorial",
    runbookType: azure_native.automation.RunbookTypeEnum.PowerShellWorkflow,
    tags: {
        tag01: "value01",
        tag02: "value02",
    },
});

    resources:
  runbook:
    type: azure-native:automation:Runbook
    properties:
      automationAccountName: ContoseAutomationAccount
      description: Description of the Runbook
      draft: {}
      location: East US 2
      logProgress: false
      logVerbose: false
      name: Get-AzureVMTutorial
      resourceGroupName: rg
      runbookName: Get-AzureVMTutorial
      runbookType: PowerShellWorkflow
      tags:
        tag01: value01
        tag02: value02

    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,
            runbook_type: Optional[Union[str, RunbookTypeEnum]] = None,
            resource_group_name: Optional[str] = None,
            location: Optional[str] = None,
            log_activity_trace: Optional[int] = None,
            log_progress: Optional[bool] = None,
            log_verbose: Optional[bool] = None,
            name: Optional[str] = None,
            publish_content_link: Optional[ContentLinkArgs] = None,
            draft: Optional[RunbookDraftArgs] = None,
            runbook_name: Optional[str] = None,
            description: Optional[str] = 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-native: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.

    Example

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

    var runbookResource = new AzureNative.Automation.Runbook("runbookResource", new()
{
    AutomationAccountName = "string",
    RunbookType = "string",
    ResourceGroupName = "string",
    Location = "string",
    LogActivityTrace = 0,
    LogProgress = false,
    LogVerbose = false,
    Name = "string",
    PublishContentLink = new AzureNative.Automation.Inputs.ContentLinkArgs
    {
        ContentHash = new AzureNative.Automation.Inputs.ContentHashArgs
        {
            Algorithm = "string",
            Value = "string",
        },
        Uri = "string",
        Version = "string",
    },
    Draft = new AzureNative.Automation.Inputs.RunbookDraftArgs
    {
        CreationTime = "string",
        DraftContentLink = new AzureNative.Automation.Inputs.ContentLinkArgs
        {
            ContentHash = new AzureNative.Automation.Inputs.ContentHashArgs
            {
                Algorithm = "string",
                Value = "string",
            },
            Uri = "string",
            Version = "string",
        },
        InEdit = false,
        LastModifiedTime = "string",
        OutputTypes = new[]
        {
            "string",
        },
        Parameters = 
        {
            { "string", new AzureNative.Automation.Inputs.RunbookParameterArgs
            {
                DefaultValue = "string",
                IsMandatory = false,
                Position = 0,
                Type = "string",
            } },
        },
    },
    RunbookName = "string",
    Description = "string",
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := automation.NewRunbook(ctx, "runbookResource", &automation.RunbookArgs{
AutomationAccountName: pulumi.String("string"),
RunbookType: pulumi.String("string"),
ResourceGroupName: pulumi.String("string"),
Location: pulumi.String("string"),
LogActivityTrace: pulumi.Int(0),
LogProgress: pulumi.Bool(false),
LogVerbose: pulumi.Bool(false),
Name: pulumi.String("string"),
PublishContentLink: &automation.ContentLinkArgs{
ContentHash: &automation.ContentHashArgs{
Algorithm: pulumi.String("string"),
Value: pulumi.String("string"),
},
Uri: pulumi.String("string"),
Version: pulumi.String("string"),
},
Draft: &automation.RunbookDraftArgs{
CreationTime: pulumi.String("string"),
DraftContentLink: &automation.ContentLinkArgs{
ContentHash: &automation.ContentHashArgs{
Algorithm: pulumi.String("string"),
Value: pulumi.String("string"),
},
Uri: pulumi.String("string"),
Version: pulumi.String("string"),
},
InEdit: pulumi.Bool(false),
LastModifiedTime: pulumi.String("string"),
OutputTypes: pulumi.StringArray{
pulumi.String("string"),
},
Parameters: automation.RunbookParameterMap{
"string": &automation.RunbookParameterArgs{
DefaultValue: pulumi.String("string"),
IsMandatory: pulumi.Bool(false),
Position: pulumi.Int(0),
Type: pulumi.String("string"),
},
},
},
RunbookName: pulumi.String("string"),
Description: pulumi.String("string"),
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
})

    var runbookResource = new Runbook("runbookResource", RunbookArgs.builder()        
    .automationAccountName("string")
    .runbookType("string")
    .resourceGroupName("string")
    .location("string")
    .logActivityTrace(0)
    .logProgress(false)
    .logVerbose(false)
    .name("string")
    .publishContentLink(ContentLinkArgs.builder()
        .contentHash(ContentHashArgs.builder()
            .algorithm("string")
            .value("string")
            .build())
        .uri("string")
        .version("string")
        .build())
    .draft(RunbookDraftArgs.builder()
        .creationTime("string")
        .draftContentLink(ContentLinkArgs.builder()
            .contentHash(ContentHashArgs.builder()
                .algorithm("string")
                .value("string")
                .build())
            .uri("string")
            .version("string")
            .build())
        .inEdit(false)
        .lastModifiedTime("string")
        .outputTypes("string")
        .parameters(Map.of("string", Map.ofEntries(
            Map.entry("defaultValue", "string"),
            Map.entry("isMandatory", false),
            Map.entry("position", 0),
            Map.entry("type", "string")
        )))
        .build())
    .runbookName("string")
    .description("string")
    .tags(Map.of("string", "string"))
    .build());

    runbook_resource = azure_native.automation.Runbook("runbookResource",
    automation_account_name="string",
    runbook_type="string",
    resource_group_name="string",
    location="string",
    log_activity_trace=0,
    log_progress=False,
    log_verbose=False,
    name="string",
    publish_content_link=azure_native.automation.ContentLinkArgs(
        content_hash=azure_native.automation.ContentHashArgs(
            algorithm="string",
            value="string",
        ),
        uri="string",
        version="string",
    ),
    draft=azure_native.automation.RunbookDraftArgs(
        creation_time="string",
        draft_content_link=azure_native.automation.ContentLinkArgs(
            content_hash=azure_native.automation.ContentHashArgs(
                algorithm="string",
                value="string",
            ),
            uri="string",
            version="string",
        ),
        in_edit=False,
        last_modified_time="string",
        output_types=["string"],
        parameters={
            "string": azure_native.automation.RunbookParameterArgs(
                default_value="string",
                is_mandatory=False,
                position=0,
                type="string",
            ),
        },
    ),
    runbook_name="string",
    description="string",
    tags={
        "string": "string",
    })

    const runbookResource = new azure_native.automation.Runbook("runbookResource", {
    automationAccountName: "string",
    runbookType: "string",
    resourceGroupName: "string",
    location: "string",
    logActivityTrace: 0,
    logProgress: false,
    logVerbose: false,
    name: "string",
    publishContentLink: {
        contentHash: {
            algorithm: "string",
            value: "string",
        },
        uri: "string",
        version: "string",
    },
    draft: {
        creationTime: "string",
        draftContentLink: {
            contentHash: {
                algorithm: "string",
                value: "string",
            },
            uri: "string",
            version: "string",
        },
        inEdit: false,
        lastModifiedTime: "string",
        outputTypes: ["string"],
        parameters: {
            string: {
                defaultValue: "string",
                isMandatory: false,
                position: 0,
                type: "string",
            },
        },
    },
    runbookName: "string",
    description: "string",
    tags: {
        string: "string",
    },
});

    type: azure-native:automation:Runbook
properties:
    automationAccountName: string
    description: string
    draft:
        creationTime: string
        draftContentLink:
            contentHash:
                algorithm: string
                value: string
            uri: string
            version: string
        inEdit: false
        lastModifiedTime: string
        outputTypes:
            - string
        parameters:
            string:
                defaultValue: string
                isMandatory: false
                position: 0
                type: string
    location: string
    logActivityTrace: 0
    logProgress: false
    logVerbose: false
    name: string
    publishContentLink:
        contentHash:
            algorithm: string
            value: string
        uri: string
        version: string
    resourceGroupName: string
    runbookName: 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

    The Runbook resource accepts the following input properties:

    AutomationAccountName string
    The name of the automation account.
    ResourceGroupName string
    Name of an Azure Resource group.
    RunbookType string | Pulumi.AzureNative.Automation.RunbookTypeEnum
    Gets or sets the type of the runbook.
    Description string
    Gets or sets the description of the runbook.
    Draft Pulumi.AzureNative.Automation.Inputs.RunbookDraft
    Gets or sets the draft runbook properties.
    Location string
    Gets or sets the location of the resource.
    LogActivityTrace int
    Gets or sets the activity-level tracing options of the runbook.
    LogProgress bool
    Gets or sets progress log option.
    LogVerbose bool
    Gets or sets verbose log option.
    Name string
    Gets or sets the name of the resource.
    PublishContentLink Pulumi.AzureNative.Automation.Inputs.ContentLink
    Gets or sets the published runbook content link.
    RunbookName string
    The runbook name.
    Tags Dictionary<string, string>
    Gets or sets the tags attached to the resource.
    AutomationAccountName string
    The name of the automation account.
    ResourceGroupName string
    Name of an Azure Resource group.
    RunbookType string | RunbookTypeEnum
    Gets or sets the type of the runbook.
    Description string
    Gets or sets the description of the runbook.
    Draft RunbookDraftArgs
    Gets or sets the draft runbook properties.
    Location string
    Gets or sets the location of the resource.
    LogActivityTrace int
    Gets or sets the activity-level tracing options of the runbook.
    LogProgress bool
    Gets or sets progress log option.
    LogVerbose bool
    Gets or sets verbose log option.
    Name string
    Gets or sets the name of the resource.
    PublishContentLink ContentLinkArgs
    Gets or sets the published runbook content link.
    RunbookName string
    The runbook name.
    Tags map[string]string
    Gets or sets the tags attached to the resource.
    automationAccountName String
    The name of the automation account.
    resourceGroupName String
    Name of an Azure Resource group.
    runbookType String | RunbookTypeEnum
    Gets or sets the type of the runbook.
    description String
    Gets or sets the description of the runbook.
    draft RunbookDraft
    Gets or sets the draft runbook properties.
    location String
    Gets or sets the location of the resource.
    logActivityTrace Integer
    Gets or sets the activity-level tracing options of the runbook.
    logProgress Boolean
    Gets or sets progress log option.
    logVerbose Boolean
    Gets or sets verbose log option.
    name String
    Gets or sets the name of the resource.
    publishContentLink ContentLink
    Gets or sets the published runbook content link.
    runbookName String
    The runbook name.
    tags Map<String,String>
    Gets or sets the tags attached to the resource.
    automationAccountName string
    The name of the automation account.
    resourceGroupName string
    Name of an Azure Resource group.
    runbookType string | RunbookTypeEnum
    Gets or sets the type of the runbook.
    description string
    Gets or sets the description of the runbook.
    draft RunbookDraft
    Gets or sets the draft runbook properties.
    location string
    Gets or sets the location of the resource.
    logActivityTrace number
    Gets or sets the activity-level tracing options of the runbook.
    logProgress boolean
    Gets or sets progress log option.
    logVerbose boolean
    Gets or sets verbose log option.
    name string
    Gets or sets the name of the resource.
    publishContentLink ContentLink
    Gets or sets the published runbook content link.
    runbookName string
    The runbook name.
    tags {[key: string]: string}
    Gets or sets the tags attached to the resource.
    automation_account_name str
    The name of the automation account.
    resource_group_name str
    Name of an Azure Resource group.
    runbook_type str | RunbookTypeEnum
    Gets or sets the type of the runbook.
    description str
    Gets or sets the description of the runbook.
    draft RunbookDraftArgs
    Gets or sets the draft runbook properties.
    location str
    Gets or sets the location of the resource.
    log_activity_trace int
    Gets or sets the activity-level tracing options of the runbook.
    log_progress bool
    Gets or sets progress log option.
    log_verbose bool
    Gets or sets verbose log option.
    name str
    Gets or sets the name of the resource.
    publish_content_link ContentLinkArgs
    Gets or sets the published runbook content link.
    runbook_name str
    The runbook name.
    tags Mapping[str, str]
    Gets or sets the tags attached to the resource.
    automationAccountName String
    The name of the automation account.
    resourceGroupName String
    Name of an Azure Resource group.
    runbookType String | "Script" | "Graph" | "PowerShellWorkflow" | "PowerShell" | "GraphPowerShellWorkflow" | "GraphPowerShell" | "Python2" | "Python3"
    Gets or sets the type of the runbook.
    description String
    Gets or sets the description of the runbook.
    draft Property Map
    Gets or sets the draft runbook properties.
    location String
    Gets or sets the location of the resource.
    logActivityTrace Number
    Gets or sets the activity-level tracing options of the runbook.
    logProgress Boolean
    Gets or sets progress log option.
    logVerbose Boolean
    Gets or sets verbose log option.
    name String
    Gets or sets the name of the resource.
    publishContentLink Property Map
    Gets or sets the published runbook content link.
    runbookName String
    The runbook name.
    tags Map<String>
    Gets or sets the tags attached 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.
    Type string
    The type of the resource.
    CreationTime string
    Gets or sets the creation time.
    Etag string
    Gets or sets the etag of the resource.
    JobCount int
    Gets or sets the job count of the runbook.
    LastModifiedBy string
    Gets or sets the last modified by.
    LastModifiedTime string
    Gets or sets the last modified time.
    OutputTypes List<string>
    Gets or sets the runbook output types.
    Parameters Dictionary<string, Pulumi.AzureNative.Automation.Outputs.RunbookParameterResponse>
    Gets or sets the runbook parameters.
    ProvisioningState string
    Gets or sets the provisioning state of the runbook.
    State string
    Gets or sets the state of the runbook.
    Id string
    The provider-assigned unique ID for this managed resource.
    Type string
    The type of the resource.
    CreationTime string
    Gets or sets the creation time.
    Etag string
    Gets or sets the etag of the resource.
    JobCount int
    Gets or sets the job count of the runbook.
    LastModifiedBy string
    Gets or sets the last modified by.
    LastModifiedTime string
    Gets or sets the last modified time.
    OutputTypes []string
    Gets or sets the runbook output types.
    Parameters map[string]RunbookParameterResponse
    Gets or sets the runbook parameters.
    ProvisioningState string
    Gets or sets the provisioning state of the runbook.
    State string
    Gets or sets the state of the runbook.
    id String
    The provider-assigned unique ID for this managed resource.
    type String
    The type of the resource.
    creationTime String
    Gets or sets the creation time.
    etag String
    Gets or sets the etag of the resource.
    jobCount Integer
    Gets or sets the job count of the runbook.
    lastModifiedBy String
    Gets or sets the last modified by.
    lastModifiedTime String
    Gets or sets the last modified time.
    outputTypes List<String>
    Gets or sets the runbook output types.
    parameters Map<String,RunbookParameterResponse>
    Gets or sets the runbook parameters.
    provisioningState String
    Gets or sets the provisioning state of the runbook.
    state String
    Gets or sets the state of the runbook.
    id string
    The provider-assigned unique ID for this managed resource.
    type string
    The type of the resource.
    creationTime string
    Gets or sets the creation time.
    etag string
    Gets or sets the etag of the resource.
    jobCount number
    Gets or sets the job count of the runbook.
    lastModifiedBy string
    Gets or sets the last modified by.
    lastModifiedTime string
    Gets or sets the last modified time.
    outputTypes string[]
    Gets or sets the runbook output types.
    parameters {[key: string]: RunbookParameterResponse}
    Gets or sets the runbook parameters.
    provisioningState string
    Gets or sets the provisioning state of the runbook.
    state string
    Gets or sets the state of the runbook.
    id str
    The provider-assigned unique ID for this managed resource.
    type str
    The type of the resource.
    creation_time str
    Gets or sets the creation time.
    etag str
    Gets or sets the etag of the resource.
    job_count int
    Gets or sets the job count of the runbook.
    last_modified_by str
    Gets or sets the last modified by.
    last_modified_time str
    Gets or sets the last modified time.
    output_types Sequence[str]
    Gets or sets the runbook output types.
    parameters Mapping[str, RunbookParameterResponse]
    Gets or sets the runbook parameters.
    provisioning_state str
    Gets or sets the provisioning state of the runbook.
    state str
    Gets or sets the state of the runbook.
    id String
    The provider-assigned unique ID for this managed resource.
    type String
    The type of the resource.
    creationTime String
    Gets or sets the creation time.
    etag String
    Gets or sets the etag of the resource.
    jobCount Number
    Gets or sets the job count of the runbook.
    lastModifiedBy String
    Gets or sets the last modified by.
    lastModifiedTime String
    Gets or sets the last modified time.
    outputTypes List<String>
    Gets or sets the runbook output types.
    parameters Map<Property Map>
    Gets or sets the runbook parameters.
    provisioningState String
    Gets or sets the provisioning state of the runbook.
    state String
    Gets or sets the state of the runbook.

    Supporting Types

    ContentHash, ContentHashArgs

    Algorithm string
    Gets or sets the content hash algorithm used to hash the content.
    Value string
    Gets or sets expected hash value of the content.
    Algorithm string
    Gets or sets the content hash algorithm used to hash the content.
    Value string
    Gets or sets expected hash value of the content.
    algorithm String
    Gets or sets the content hash algorithm used to hash the content.
    value String
    Gets or sets expected hash value of the content.
    algorithm string
    Gets or sets the content hash algorithm used to hash the content.
    value string
    Gets or sets expected hash value of the content.
    algorithm str
    Gets or sets the content hash algorithm used to hash the content.
    value str
    Gets or sets expected hash value of the content.
    algorithm String
    Gets or sets the content hash algorithm used to hash the content.
    value String
    Gets or sets expected hash value of the content.

    ContentHashResponse, ContentHashResponseArgs

    Algorithm string
    Gets or sets the content hash algorithm used to hash the content.
    Value string
    Gets or sets expected hash value of the content.
    Algorithm string
    Gets or sets the content hash algorithm used to hash the content.
    Value string
    Gets or sets expected hash value of the content.
    algorithm String
    Gets or sets the content hash algorithm used to hash the content.
    value String
    Gets or sets expected hash value of the content.
    algorithm string
    Gets or sets the content hash algorithm used to hash the content.
    value string
    Gets or sets expected hash value of the content.
    algorithm str
    Gets or sets the content hash algorithm used to hash the content.
    value str
    Gets or sets expected hash value of the content.
    algorithm String
    Gets or sets the content hash algorithm used to hash the content.
    value String
    Gets or sets expected hash value of the content.
    ContentHash Pulumi.AzureNative.Automation.Inputs.ContentHash
    Gets or sets the hash.
    Uri string
    Gets or sets the uri of the runbook content.
    Version string
    Gets or sets the version of the content.
    ContentHash ContentHash
    Gets or sets the hash.
    Uri string
    Gets or sets the uri of the runbook content.
    Version string
    Gets or sets the version of the content.
    contentHash ContentHash
    Gets or sets the hash.
    uri String
    Gets or sets the uri of the runbook content.
    version String
    Gets or sets the version of the content.
    contentHash ContentHash
    Gets or sets the hash.
    uri string
    Gets or sets the uri of the runbook content.
    version string
    Gets or sets the version of the content.
    content_hash ContentHash
    Gets or sets the hash.
    uri str
    Gets or sets the uri of the runbook content.
    version str
    Gets or sets the version of the content.
    contentHash Property Map
    Gets or sets the hash.
    uri String
    Gets or sets the uri of the runbook content.
    version String
    Gets or sets the version of the content.

    ContentLinkResponse, ContentLinkResponseArgs

    ContentHash Pulumi.AzureNative.Automation.Inputs.ContentHashResponse
    Gets or sets the hash.
    Uri string
    Gets or sets the uri of the runbook content.
    Version string
    Gets or sets the version of the content.
    ContentHash ContentHashResponse
    Gets or sets the hash.
    Uri string
    Gets or sets the uri of the runbook content.
    Version string
    Gets or sets the version of the content.
    contentHash ContentHashResponse
    Gets or sets the hash.
    uri String
    Gets or sets the uri of the runbook content.
    version String
    Gets or sets the version of the content.
    contentHash ContentHashResponse
    Gets or sets the hash.
    uri string
    Gets or sets the uri of the runbook content.
    version string
    Gets or sets the version of the content.
    content_hash ContentHashResponse
    Gets or sets the hash.
    uri str
    Gets or sets the uri of the runbook content.
    version str
    Gets or sets the version of the content.
    contentHash Property Map
    Gets or sets the hash.
    uri String
    Gets or sets the uri of the runbook content.
    version String
    Gets or sets the version of the content.

    RunbookDraft, RunbookDraftArgs

    CreationTime string
    Gets or sets the creation time of the runbook draft.
    DraftContentLink Pulumi.AzureNative.Automation.Inputs.ContentLink
    Gets or sets the draft runbook content link.
    InEdit bool
    Gets or sets whether runbook is in edit mode.
    LastModifiedTime string
    Gets or sets the last modified time of the runbook draft.
    OutputTypes List<string>
    Gets or sets the runbook output types.
    Parameters Dictionary<string, Pulumi.AzureNative.Automation.Inputs.RunbookParameter>
    Gets or sets the runbook draft parameters.
    CreationTime string
    Gets or sets the creation time of the runbook draft.
    DraftContentLink ContentLink
    Gets or sets the draft runbook content link.
    InEdit bool
    Gets or sets whether runbook is in edit mode.
    LastModifiedTime string
    Gets or sets the last modified time of the runbook draft.
    OutputTypes []string
    Gets or sets the runbook output types.
    Parameters map[string]RunbookParameter
    Gets or sets the runbook draft parameters.
    creationTime String
    Gets or sets the creation time of the runbook draft.
    draftContentLink ContentLink
    Gets or sets the draft runbook content link.
    inEdit Boolean
    Gets or sets whether runbook is in edit mode.
    lastModifiedTime String
    Gets or sets the last modified time of the runbook draft.
    outputTypes List<String>
    Gets or sets the runbook output types.
    parameters Map<String,RunbookParameter>
    Gets or sets the runbook draft parameters.
    creationTime string
    Gets or sets the creation time of the runbook draft.
    draftContentLink ContentLink
    Gets or sets the draft runbook content link.
    inEdit boolean
    Gets or sets whether runbook is in edit mode.
    lastModifiedTime string
    Gets or sets the last modified time of the runbook draft.
    outputTypes string[]
    Gets or sets the runbook output types.
    parameters {[key: string]: RunbookParameter}
    Gets or sets the runbook draft parameters.
    creation_time str
    Gets or sets the creation time of the runbook draft.
    draft_content_link ContentLink
    Gets or sets the draft runbook content link.
    in_edit bool
    Gets or sets whether runbook is in edit mode.
    last_modified_time str
    Gets or sets the last modified time of the runbook draft.
    output_types Sequence[str]
    Gets or sets the runbook output types.
    parameters Mapping[str, RunbookParameter]
    Gets or sets the runbook draft parameters.
    creationTime String
    Gets or sets the creation time of the runbook draft.
    draftContentLink Property Map
    Gets or sets the draft runbook content link.
    inEdit Boolean
    Gets or sets whether runbook is in edit mode.
    lastModifiedTime String
    Gets or sets the last modified time of the runbook draft.
    outputTypes List<String>
    Gets or sets the runbook output types.
    parameters Map<Property Map>
    Gets or sets the runbook draft parameters.

    RunbookDraftResponse, RunbookDraftResponseArgs

    CreationTime string
    Gets or sets the creation time of the runbook draft.
    DraftContentLink Pulumi.AzureNative.Automation.Inputs.ContentLinkResponse
    Gets or sets the draft runbook content link.
    InEdit bool
    Gets or sets whether runbook is in edit mode.
    LastModifiedTime string
    Gets or sets the last modified time of the runbook draft.
    OutputTypes List<string>
    Gets or sets the runbook output types.
    Parameters Dictionary<string, Pulumi.AzureNative.Automation.Inputs.RunbookParameterResponse>
    Gets or sets the runbook draft parameters.
    CreationTime string
    Gets or sets the creation time of the runbook draft.
    DraftContentLink ContentLinkResponse
    Gets or sets the draft runbook content link.
    InEdit bool
    Gets or sets whether runbook is in edit mode.
    LastModifiedTime string
    Gets or sets the last modified time of the runbook draft.
    OutputTypes []string
    Gets or sets the runbook output types.
    Parameters map[string]RunbookParameterResponse
    Gets or sets the runbook draft parameters.
    creationTime String
    Gets or sets the creation time of the runbook draft.
    draftContentLink ContentLinkResponse
    Gets or sets the draft runbook content link.
    inEdit Boolean
    Gets or sets whether runbook is in edit mode.
    lastModifiedTime String
    Gets or sets the last modified time of the runbook draft.
    outputTypes List<String>
    Gets or sets the runbook output types.
    parameters Map<String,RunbookParameterResponse>
    Gets or sets the runbook draft parameters.
    creationTime string
    Gets or sets the creation time of the runbook draft.
    draftContentLink ContentLinkResponse
    Gets or sets the draft runbook content link.
    inEdit boolean
    Gets or sets whether runbook is in edit mode.
    lastModifiedTime string
    Gets or sets the last modified time of the runbook draft.
    outputTypes string[]
    Gets or sets the runbook output types.
    parameters {[key: string]: RunbookParameterResponse}
    Gets or sets the runbook draft parameters.
    creation_time str
    Gets or sets the creation time of the runbook draft.
    draft_content_link ContentLinkResponse
    Gets or sets the draft runbook content link.
    in_edit bool
    Gets or sets whether runbook is in edit mode.
    last_modified_time str
    Gets or sets the last modified time of the runbook draft.
    output_types Sequence[str]
    Gets or sets the runbook output types.
    parameters Mapping[str, RunbookParameterResponse]
    Gets or sets the runbook draft parameters.
    creationTime String
    Gets or sets the creation time of the runbook draft.
    draftContentLink Property Map
    Gets or sets the draft runbook content link.
    inEdit Boolean
    Gets or sets whether runbook is in edit mode.
    lastModifiedTime String
    Gets or sets the last modified time of the runbook draft.
    outputTypes List<String>
    Gets or sets the runbook output types.
    parameters Map<Property Map>
    Gets or sets the runbook draft parameters.

    RunbookParameter, RunbookParameterArgs

    DefaultValue string
    Gets or sets the default value of parameter.
    IsMandatory bool
    Gets or sets a Boolean value to indicate whether the parameter is mandatory or not.
    Position int
    Get or sets the position of the parameter.
    Type string
    Gets or sets the type of the parameter.
    DefaultValue string
    Gets or sets the default value of parameter.
    IsMandatory bool
    Gets or sets a Boolean value to indicate whether the parameter is mandatory or not.
    Position int
    Get or sets the position of the parameter.
    Type string
    Gets or sets the type of the parameter.
    defaultValue String
    Gets or sets the default value of parameter.
    isMandatory Boolean
    Gets or sets a Boolean value to indicate whether the parameter is mandatory or not.
    position Integer
    Get or sets the position of the parameter.
    type String
    Gets or sets the type of the parameter.
    defaultValue string
    Gets or sets the default value of parameter.
    isMandatory boolean
    Gets or sets a Boolean value to indicate whether the parameter is mandatory or not.
    position number
    Get or sets the position of the parameter.
    type string
    Gets or sets the type of the parameter.
    default_value str
    Gets or sets the default value of parameter.
    is_mandatory bool
    Gets or sets a Boolean value to indicate whether the parameter is mandatory or not.
    position int
    Get or sets the position of the parameter.
    type str
    Gets or sets the type of the parameter.
    defaultValue String
    Gets or sets the default value of parameter.
    isMandatory Boolean
    Gets or sets a Boolean value to indicate whether the parameter is mandatory or not.
    position Number
    Get or sets the position of the parameter.
    type String
    Gets or sets the type of the parameter.

    RunbookParameterResponse, RunbookParameterResponseArgs

    DefaultValue string
    Gets or sets the default value of parameter.
    IsMandatory bool
    Gets or sets a Boolean value to indicate whether the parameter is mandatory or not.
    Position int
    Get or sets the position of the parameter.
    Type string
    Gets or sets the type of the parameter.
    DefaultValue string
    Gets or sets the default value of parameter.
    IsMandatory bool
    Gets or sets a Boolean value to indicate whether the parameter is mandatory or not.
    Position int
    Get or sets the position of the parameter.
    Type string
    Gets or sets the type of the parameter.
    defaultValue String
    Gets or sets the default value of parameter.
    isMandatory Boolean
    Gets or sets a Boolean value to indicate whether the parameter is mandatory or not.
    position Integer
    Get or sets the position of the parameter.
    type String
    Gets or sets the type of the parameter.
    defaultValue string
    Gets or sets the default value of parameter.
    isMandatory boolean
    Gets or sets a Boolean value to indicate whether the parameter is mandatory or not.
    position number
    Get or sets the position of the parameter.
    type string
    Gets or sets the type of the parameter.
    default_value str
    Gets or sets the default value of parameter.
    is_mandatory bool
    Gets or sets a Boolean value to indicate whether the parameter is mandatory or not.
    position int
    Get or sets the position of the parameter.
    type str
    Gets or sets the type of the parameter.
    defaultValue String
    Gets or sets the default value of parameter.
    isMandatory Boolean
    Gets or sets a Boolean value to indicate whether the parameter is mandatory or not.
    position Number
    Get or sets the position of the parameter.
    type String
    Gets or sets the type of the parameter.

    RunbookTypeEnum, RunbookTypeEnumArgs

    Script
    Script
    Graph
    Graph
    PowerShellWorkflow
    PowerShellWorkflow
    PowerShell
    PowerShell
    GraphPowerShellWorkflow
    GraphPowerShellWorkflow
    GraphPowerShell
    GraphPowerShell
    Python2
    Python2
    Python3
    Python3
    RunbookTypeEnumScript
    Script
    RunbookTypeEnumGraph
    Graph
    RunbookTypeEnumPowerShellWorkflow
    PowerShellWorkflow
    RunbookTypeEnumPowerShell
    PowerShell
    RunbookTypeEnumGraphPowerShellWorkflow
    GraphPowerShellWorkflow
    RunbookTypeEnumGraphPowerShell
    GraphPowerShell
    RunbookTypeEnumPython2
    Python2
    RunbookTypeEnumPython3
    Python3
    Script
    Script
    Graph
    Graph
    PowerShellWorkflow
    PowerShellWorkflow
    PowerShell
    PowerShell
    GraphPowerShellWorkflow
    GraphPowerShellWorkflow
    GraphPowerShell
    GraphPowerShell
    Python2
    Python2
    Python3
    Python3
    Script
    Script
    Graph
    Graph
    PowerShellWorkflow
    PowerShellWorkflow
    PowerShell
    PowerShell
    GraphPowerShellWorkflow
    GraphPowerShellWorkflow
    GraphPowerShell
    GraphPowerShell
    Python2
    Python2
    Python3
    Python3
    SCRIPT
    Script
    GRAPH
    Graph
    POWER_SHELL_WORKFLOW
    PowerShellWorkflow
    POWER_SHELL
    PowerShell
    GRAPH_POWER_SHELL_WORKFLOW
    GraphPowerShellWorkflow
    GRAPH_POWER_SHELL
    GraphPowerShell
    PYTHON2
    Python2
    PYTHON3
    Python3
    "Script"
    Script
    "Graph"
    Graph
    "PowerShellWorkflow"
    PowerShellWorkflow
    "PowerShell"
    PowerShell
    "GraphPowerShellWorkflow"
    GraphPowerShellWorkflow
    "GraphPowerShell"
    GraphPowerShell
    "Python2"
    Python2
    "Python3"
    Python3

    Import

    An existing resource can be imported using its type token, name, and identifier, e.g.

    $ pulumi import azure-native:automation:Runbook Get-AzureVMTutorial /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName}

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

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.37.0 published on Monday, Apr 15, 2024 by Pulumi
    pulumi/pulumi-azure-native