Edit

New-AzAutomationRunbook

  • Reference
Module:
Az.Automation

Creates an Automation runbook.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Syntax

New-AzAutomationRunbook
   [-Name] <String>
   [-Description <String>]
   [-Tags <IDictionary>]
   -Type <String>
   [-LogProgress <Boolean>]
   [-LogVerbose <Boolean>]
   [-ResourceGroupName] <String>
   [-AutomationAccountName] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The New-AzAutomationRunbook cmdlet creates an empty Azure Automation runbook by using APS. Specify a name for the runbook.

Examples

Example 1: Create a runbook

PS C:\>New-AzAutomationRunbook -AutomationAccountName "Contoso17" -Name "Runbook02" -ResourceGroupName "ResourceGroup01"

This command creates a runbook named Runbook02 in the Azure Automation account named Contoso17.

Example 2

Creates an Automation runbook. (autogenerated)

New-AzAutomationRunbook -AutomationAccountName 'Contoso17' -Name 'Runbook02' -ResourceGroupName 'ResourceGroup01' -Type PowerShell

Parameters

-AutomationAccountName

Specifies the name of the Automation account in which this cmdlet creates a runbook.

Type:String
Position:1
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-DefaultProfile

The credentials, account, tenant, and subscription used for communication with azure

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Description

Specifies a description for the runbook.

Type:String
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-LogProgress

Specifies whether the runbook logs progress.

Type:Nullable<T>[Boolean]
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-LogVerbose

Specifies whether logging includes detailed information.

Type:Nullable<T>[Boolean]
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-Name

Specifies a name for the runbook.

Type:String
Aliases:RunbookName
Position:2
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-ResourceGroupName

Specifies the name of the resource group for which this cmdlet creates a runbook.

Type:String
Position:0
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-Tags

Key-value pairs in the form of a hash table. For example: @{key0="value0";key1=$null;key2="value2"}

Type:IDictionary
Aliases:Tag
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-Type

Specifies the type of runbook that this cmdlet creates. Valid values are:

  • PowerShell
  • GraphicalPowerShell
  • PowerShellWorkflow
  • GraphicalPowerShellWorkflow
  • Graph
  • Python2 The value Graph is obsolete. It is equivalent to GraphicalPowerShellWorkflow.
Type:String
Accepted values:PowerShell, GraphicalPowerShell, PowerShellWorkflow, GraphicalPowerShellWorkflow, Graph, Python2, Python3
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Inputs

String

IDictionary

Nullable<T>[[System.Boolean, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

Outputs

Runbook