Register-AzureAutomationScheduledRunbook

Reference

Module:: Azure

Associates a runbook with a schedule.

Note

The cmdlets referenced in this documentation are for managing legacy Azure resources that use Service Management APIs. See the Az PowerShell module for cmdlets to manage Azure Resource Manager resources.

Syntax

Register-AzureAutomationScheduledRunbook
        -AutomationAccountName <String>
        [-Profile <AzureSMProfile>]
        [<CommonParameters>]

Register-AzureAutomationScheduledRunbook
        -RunbookName <String>
        -ScheduleName <String>
        [-Parameters <IDictionary>]
        -AutomationAccountName <String>
        [-Profile <AzureSMProfile>]
        [<CommonParameters>]

Description

Important

This PowerShell command for Azure Automation is longer supported as of 01/23/2020. The Azure Service Management model is deprecated for Azure Automation and was disabled on that date. Please use the commands which support the Azure Resource Management model in Az.Automation.

The Register-AzureAutomationScheduledRunbook cmdlet associates a runbook with a schedule. The runbook starts based on the schedule you specify using the ScheduleName parameter.

Examples

Example 1: Associate a runbook with a schedule

PS C:\> Register-AzureAutomationScheduledRunbook -AutomationAccountName "Contoso17" -Name "Runbk01" -ScheduleName "Sched01"

This command associates the runbook named Runbk01 with the schedule named Sched01 in the Azure Automation account named Contoso17.

Parameters

-AutomationAccountName

Specifies the name of an Automation account.

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

-Parameters

Type:	IDictionary
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-Profile

Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.

Type:	AzureSMProfile
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-RunbookName

Specifies the name of the runbook.

Type:	String
Aliases:	Name
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-ScheduleName

Specifies the name of the schedule.

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

Outputs

JobSchedule