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-AzureAutomationRunbook

Set-AzureAutomationRunbook

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

Synopsis

Modifies the configuration of a runbook.

Syntax

Set-AzureAutomationRunbook [-Name] [-Description] [-Tags] [-LogDebug] [-LogProgress] [-LogVerbose] [-AutomationAccountName] [<CommonParameters>]

Set-AzureAutomationRunbook [-Id] [-Description] [-Tags] [-LogDebug] [-LogProgress] [-LogVerbose] [-AutomationAccountName] [<CommonParameters>]

Detailed Description

The Set-AzureAutomationRunbook cmdlet modifies the configuration of a Microsoft Azure Automation runbook.

Parameters

-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

-Description <String>

Specifies a description for the runbook.

Aliases

None

Required?

false

Position

named

Default value

none

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

false

-Tags <String[]>

Specifies one or more runbook tags.

Aliases

None

Required?

false

Position

named

Default value

none

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

false

-LogDebug <Nullable`1[Boolean]>

Indicates whether debug output is logged for jobs of this runbook.

Aliases

None

Required?

false

Position

named

Default value

none

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

false

-LogProgress <Nullable`1[Boolean]>

Indicates whether progress output is logged for jobs of this runbook.

Aliases

None

Required?

false

Position

named

Default value

none

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

false

-LogVerbose <Nullable`1[Boolean]>

Indicates whether verbose output is logged for jobs of this 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: Enable verbose logging for a runbook --------------------------

This command enables verbose logging for the jobs of the specified runbook in the Azure Automation account named Contoso17.

PS C:\>Set-AzureAutomationRunbook -AutomationAccountName "Contoso17" -Name "MyRunbook" -LogVerbose $True

Online Version
Get-AzureAutomationRunbook
New-AzureAutomationRunbook
Publish-AzureAutomationRunbook
Remove-AzureAutomationRunbook
Start-AzureAutomationRunbook