RunBook

Manages a Automation Runbook.

Create a RunBook Resource

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

def RunBook(resource_name, opts=None, automation_account_name=None, content=None, description=None, location=None, log_progress=None, log_verbose=None, name=None, publish_content_link=None, resource_group_name=None, runbook_type=None, tags=None, __props__=None);

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

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

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.
opts ResourceOptions: A bag of options that control this 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.

RunBook Resource Properties

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

Inputs

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.
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 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.
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.
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.
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 Dict[RunBookPublishContentLink]: The published runbook content link.
tags Dict[str, str]: 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 str: The provider-assigned unique ID for this managed resource.

Look up an 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

static get(resource_name, id, opts=None, automation_account_name=None, content=None, description=None, location=None, log_progress=None, log_verbose=None, name=None, publish_content_link=None, resource_group_name=None, runbook_type=None, tags=None, __props__=None);

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)

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.

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.
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 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.
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 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.
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.
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 Dict[RunBookPublishContentLink]: 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 Dict[str, str]: A mapping of tags to assign to the resource.