Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Register-AzureAutomationScheduledRunbook

Register-AzureAutomationScheduledRunbook

microsoft.azure.commands.resourcemanager.automation.dll, microsoft.azure.commands.automation.dll, microsoft.windowsazure.commands.dll

Synopsis

Associates a runbook with a schedule.

Syntax

Register-AzureAutomationScheduledRunbook [-ScheduleName] [-Name] [-Parameters] [-AutomationAccountName] [<CommonParameters>]

Register-AzureAutomationScheduledRunbook [-ScheduleName] [-Id] [-Parameters] [-AutomationAccountName] [<CommonParameters>]

Detailed Description

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

Parameters

-ScheduleName <String>

Specifies the name of a schedule. To create a schedule in Azure Automation, use the New-AzureAutomationSchedule cmdlet.

Aliases

None

Required?

true

Position

named

Default value

none

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

false

-Name <String>

Specifies the name of a runbook.

Aliases

None

Required?

true

Position

named

Default value

none

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

false

-Parameters <IDictionary>

Specifies a hash table of key/value pairs. The keys in the hash table are the runbook parameter names. The values in the hash table are the runbook parameter values. When the runbook starts in response to when the associated schedule fires, these parameters are passed to the runbook.

Aliases

None

Required?

false

Position

named

Default value

none

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

false

-AutomationAccountName <String>

Specifies the name of an Azure Automation account.

Aliases

None

Required?

true

Position

0

Default value

none

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

false

-Id <Nullable`1[Guid]>

Specifies the ID of a runbook.

Aliases

None

Required?

true

Position

named

Default value

none

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

false

Input Type


Return Type


Notes

Examples

-------------------------- Example 1: Associate a runbook with a schedule --------------------------

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

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

Online Version
New-AzureAutomationSchedule
Unregister-AzureAutomationScheduledRunbook