< Back

Set-AzureRmAutomationRunbook

Tue Jan 29, 2019 9:33 pm

NAME Set-AzureRmAutomationRunbook



SYNOPSIS

Modifies a runbook.





SYNTAX

Set-AzureRmAutomationRunbook [-ResourceGroupName] <String> [-AutomationAccountName] <String> [-Name] <String> [-DefaultProfile

<IAzureContextContainer>] [-Description <String>] [-LogProgress <Boolean>] [-LogVerbose <Boolean>] [-Tag <IDictionary>] [<CommonParameters>]





DESCRIPTION

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





PARAMETERS

-AutomationAccountName <String>

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



Required? true

Position? 1

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-DefaultProfile <IAzureContextContainer>

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



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Description <String>

Specifies a description for the runbook.



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-LogProgress <Boolean>

Specifies whether the runbook logs progress.



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-LogVerbose <Boolean>

Specifies whether logging includes detailed information.



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Name <String>

Specifies the name of the runbook that this cmdlet modifies.



Required? true

Position? 2

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-ResourceGroupName <String>

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



Required? true

Position? 0

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Tag <IDictionary>

The runbook tags.



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

None

This cmdlet does not accept any input.





OUTPUTS

Microsoft.Azure.Commands.Automation.Model.Runbook







NOTES









Example 1: Enable verbose logging for a runbook



PS C:\\>Set-AzureRmAutomationRunbook -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.







RELATED LINKS

Online Version: https://docs.microsoft.com/en-us/powers ... ionrunbook

Export-AzureRmAutomationRunbook

Get-AzureRmAutomationRunbook

Import-AzureRmAutomationRunbook

New-AzureRmAutomationRunbook

New-AzureRmAutomationRunbook

Publish-AzureRmAutomationRunbook

Remove-AzureRmAutomationRunbook

Start-AzureRmAutomationRunbook