Skip to content

Latest commit

 

History

History
167 lines (121 loc) · 3.5 KB

Set-AzureAutomationRunbook.md

File metadata and controls

167 lines (121 loc) · 3.5 KB
external help file ms.assetid online version schema
Microsoft.Azure.Commands.Automation.dll-Help.xml
C24CFC83-3151-452D-A7B9-E78466493474
2.0.0

Set-AzureAutomationRunbook

SYNOPSIS

Modifies the configuration of a runbook.

[!INCLUDE rdfe-banner]

SYNTAX

Set-AzureAutomationRunbook -Name <String> [-Description <String>] [-Tags <String[]>] [-LogProgress <Boolean>]
 [-LogVerbose <Boolean>] -AutomationAccountName <String> [-Profile <AzureSMProfile>] [<CommonParameters>]

DESCRIPTION

[!INCLUDE aa-deprecation]

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

EXAMPLES

Example 1: Enable verbose logging for a runbook

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

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

PARAMETERS

-AutomationAccountName

Specifies the name of an Automation account.

Type: String
Parameter Sets: (All)
Aliases: 

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Description

Specifies a description for the runbook.

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-LogProgress

Type: Boolean
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-LogVerbose

Indicates whether to use verbose logging.

Type: Boolean
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Name

Specifies a name.

Type: String
Parameter Sets: (All)
Aliases: RunbookName

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
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
Parameter Sets: (All)
Aliases: 

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

-Tags

Specifies an array of tags.

Type: String[]
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

OUTPUTS

Microsoft.Azure.Commands.Automation.Model.Runbook

NOTES

RELATED LINKS

Get-AzureAutomationRunbook

New-AzureAutomationRunbook

Publish-AzureAutomationRunbook

Remove-AzureAutomationRunbook

Start-AzureAutomationRunbook