New-​Azure​Rm​Automation​Runbook

Creates an Automation runbook.

Syntax

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

Description

The New-AzureRmAutomationRunbook 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-AzureRmAutomationRunbook -AutomationAccountName "Contoso17" -Name "Runbook02" -ResourceGroupName "ResourceGroup01"

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

Required Parameters

-AutomationAccountName

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

Type:String
Position:2
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-Name

Specifies a name for the runbook.

Type:String
Aliases:RunbookName
Position:3
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-ResourceGroupName

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

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

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

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

Optional Parameters

-Description

Specifies a description for the runbook.

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

Specifies whether the runbook logs progress.

Type:Boolean
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-LogVerbose

Specifies whether logging includes detailed information.

Type:Boolean
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-Tags

Specifies a dictionary of tags for the new runbook.

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

Outputs

Microsoft.Azure.Commands.Automation.Model.Job