Edit

Set-AzAutomationRunbook

  • Reference
Module:
Az.Automation

Modifies a runbook.

Syntax

Set-AzAutomationRunbook
   [-Name] <String>
   [-Description <String>]
   [-Tag <IDictionary>]
   [-LogProgress <Boolean>]
   [-LogVerbose <Boolean>]
   [-ResourceGroupName] <String>
   [-AutomationAccountName] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The Set-AzAutomationRunbook cmdlet modifies the configuration of an Azure Automation runbook in APS.

Examples

Example 1: Enable verbose logging for a runbook

Set-AzAutomationRunbook -AutomationAccountName "Contoso17" -Name "Runbook02" -LogVerbose $True -ResourceGroupName "ResourceGroup01"

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

Parameters

-AutomationAccountName

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

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

-DefaultProfile

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

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Description

Specifies a description for the runbook.

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

-LogProgress

Specifies whether the runbook logs progress.

Type:Nullable<T>[Boolean]
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-LogVerbose

Specifies whether logging includes detailed information.

Type:Nullable<T>[Boolean]
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Name

Specifies the name of the runbook that this cmdlet modifies.

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

-ResourceGroupName

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

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

-Tag

The runbook tags.

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

Inputs

String

IDictionary

Nullable<T>[[System.Boolean, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

Outputs

Runbook