New-AzureRmAutomationRunbook

NAME New-AzureRmAutomationRunbook



SYNOPSIS

Creates an Automation runbook.





SYNTAX

New-AzureRmAutomationRunbook [-ResourceGroupName] <String> [-AutomationAccountName] <String> [-Name] <String> [-DefaultProfile

<IAzureContextContainer>] [-Description <String>] [-LogProgress <Boolean>] [-LogVerbose <Boolean>] [-Tags <IDictionary>] -Type {PowerShell |

GraphicalPowerShell | PowerShellWorkflow | GraphicalPowerShellWorkflow | Graph} [<CommonParameters>]





DESCRIPTION

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





PARAMETERS

-AutomationAccountName <String>

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



Required? true

Position? 1

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-DefaultProfile <IAzureContextContainer>

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



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Description <String>

Specifies a description for the runbook.



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-LogProgress <Boolean>

Specifies whether the runbook logs progress.



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-LogVerbose <Boolean>

Specifies whether logging includes detailed information.



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Name <String>

Specifies a name for the runbook.



Required? true

Position? 2

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-ResourceGroupName <String>

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



Required? true

Position? 0

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Tags <IDictionary>

Key-value pairs in the form of a hash table. For example:



@{key0="value0";key1=$null;key2="value2"}



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Type <String>

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.





Required? true

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

None

This cmdlet does not accept any input.





OUTPUTS

Microsoft.Azure.Commands.Automation.Model.Job







NOTES









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.







RELATED LINKS

Online Version: https://docs.microsoft.com/en-us/powers ... ionrunbook

Export-AzureRmAutomationRunbook

Get-AzureRmAutomationRunbook

Import-AzureRmAutomationRunbook

Publish-AzureRmAutomationRunbook

Remove-AzureRmAutomationRunbook

Set-AzureRmAutomationRunbook

Start-AzureRmAutomationRunbook