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
 

Set-AzureAutomationRunbookDefinition

Set-AzureAutomationRunbookDefinition

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

Synopsis

Updates the draft definition of a runbook.

Syntax

Set-AzureAutomationRunbookDefinition [-AutomationAccountName] [-Overwrite] [-Name] [-Path] [<CommonParameters>]

Set-AzureAutomationRunbookDefinition [-AutomationAccountName] [-Overwrite] [-Id] [-Path] [<CommonParameters>]

Detailed Description

The Set-AzureAutomationRunbookDefinition cmdlet updates the draft definition of a Microsoft Azure Automation runbook. Provide a Windows PowerShell? script (.ps1) file that contains a runbook which becomes the draft runbook. If a draft already exists, use the Overwrite parameter to force the cmdlet to overwrite the existing draft.

Parameters

-AutomationAccountName <String>

Specifies the name of an automation account.

Aliases

none

Required?

true

Position

1

Default value

none

Accept pipeline input?

true(ByPropertyName)

Accept wildcard characters?

false

-Id <Guid>

Specifies the ID of a runbook.

Aliases

RunbookId

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

RunbookName

Required?

true

Position

named

Default value

none

Accept pipeline input?

true(ByPropertyName)

Accept wildcard characters?

false

-Overwrite <SwitchParameter>

Indicates that the new draft runbook overwrites the existing draft, if one exists.

Aliases

none

Required?

false

Position

named

Default value

none

Accept pipeline input?

true(ByPropertyName)

Accept wildcard characters?

false

-Path <String>

Specifies the path to the new draft runbook.

Aliases

RunbookPath

Required?

true

Position

named

Default value

none

Accept pipeline input?

true(ByPropertyName)

Accept wildcard characters?

false

Input Type


Return Type


Notes

None

Examples

Example 1: Overwrite an existing draft definition of a runbook

This command overwrites the existing draft definition of a runbook.

PS C:\>Set-AzureAutomationRunbookDefinition -AutomationAccountName "Contoso17" -Name "Runbk01" -Path App01.ps1 -Overwrite

Online Version
Get-AzureAutomationRunbookDefinition