Import-​Azure​Rm​Automation​Runbook

Imports an Automation runbook.

Syntax

Import-AzureRmAutomationRunbook
      [-ResourceGroupName] <String>
      [-AutomationAccountName] <String>
      [-Path] <String>
      [-Description <String>]
      [-Force]
      [-LogProgress <Boolean>]
      [-LogVerbose <Boolean>]
      [-Name <String>]
      [-Published]
      [-Tags <IDictionary>]
      -Type <String>
      [-Confirm]
      [-WhatIf]
      [<CommonParameters>]

Description

The Import-AzureRmAutomationRunbook cmdlet imports an Azure Automation runbook. Specify the path to a wps_2 script (.ps1 ) file to import for wps_2 and wps_2 Workflow runbooks, or to a graphical runbook (.graphrunbook) file for graphical runbooks. The name of the file becomes the name of the runbook. For wps_2 Workflow runbooks, the script must contain a single wps_2 Workflow definition that matches the name of the file.

Examples

Example 1: Import a runbook from a file

PS C:\>$Tags = @{"tag01"='value01"; "tag02"="value02"}
PS C:\> Import-AzureRmAutomationRunbook -Path .\GraphicalRunbook06.graphrunbook -Tags $Tags -ResourceGroup "ResourceGroup01" -AutomationAccountName "AutomationAccount01" -Type GraphicalPowershell

The first command assigns two key/value pairs to the $Tags variable.

The second command imports a graphical runbook called GraphicalRunbook06 into the Automation account named AutomationAccount01. The command also assigns the tags stored in $Tags.

Required Parameters

-AutomationAccountName

Specifies the name of the Automation account into which this cmdlet imports a runbook.

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

Specifies the path of a .ps1 or .graphrunbook file that this cmdlet imports.

Type:String
Aliases:SourcePath
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 imports 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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False
-Description

Specifies a description for the imported runbook.

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

ps_force

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

Specifies whether the runbook logs progress information.

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

Specifies whether the runbook logs detailed information.

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

Specifies the name of the runbook that this cmdlet imports.

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

Indicates that this cmdlet publishes the runbook that it imports.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Tags

Specifies a dictionary of tags for the imported runbook.

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

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False