New-AzAutomationWebhook

Reference

Module:: Az.Automation

Creates a webhook for an Automation runbook.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Syntax

New-AzAutomationWebhook
   [-Name] <String>
   [-RunbookName] <String>
   [-IsEnabled] <Boolean>
   [-ExpiryTime] <DateTimeOffset>
   [-Parameters <IDictionary>]
   [-Force]
   [-RunOn <String>]
   [-ResourceGroupName] <String>
   [-AutomationAccountName] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The New-AzAutomationWebhook cmdlet creates a webhook for an Azure Automation runbook. Be sure to save the webhook URL that this cmdlet returns, because it cannot be retrieved again.

Examples

Example 1: Create a webhook

PS C:\>$Webhook = New-AzAutomationWebhook -Name "Webhook06" -IsEnabled $True -ExpiryTime "10/2/2016" -RunbookName "ContosoRunbook" -ResourceGroupName "ResourceGroup01" -AutomationAccountName "AutomationAccount01" -Force

This command creates a webhook named Webhook06 for the runbook named ContosoRunbook in the Automation account named AutomationAccount01. The command stores the webhook in the $Webhook variable. The webhook is enabled. The webhook expires at the specified time. This command does not provide any values for webhook parameters. This command specifies the Force parameter. Therefore, it does not prompt you for confirmation.

Example 2: Create a webhook with parameters

PS C:\>$Params = @{"StringParam"="Hello World";"IntegerParam"=32}
PS C:\> $Webhook = New-AzAutomationWebhook -Name "Webhook11" -Parameters $Params -IsEnabled $True -ExpiryTime "10/2/2016" -RunbookName "ContosoRunbook" -ResourceGroupName "ResourceGroup01" -AutomationAccountName "AutomationAccount01" -Force

The first command creates a dictionary of parameters, and stores them in the $Params variable. The second command creates a webhook named Webhook11 for the runbook named ContosoRunbook in the Automation account named AutomationAccount01. The command assigns the parameters in $Params to the webhook.

Parameters

-AutomationAccountName

Specifies the name of an Automation account in which this cmdlet creates a webhook.

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	False
Accept pipeline input:	False
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
Accept pipeline input:	False
Accept wildcard characters:	False

-ExpiryTime

Specifies the expiry time for the webhook as a DateTimeOffset object. You can specify a string or a DateTime that can be converted to a valid DateTimeOffset.

Type:	DateTimeOffset
Position:	5
Default value:	None
Accept pipeline input:	True
Accept wildcard characters:	False

-Force

ps_force

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

-IsEnabled

Specifies whether the webhook is enabled.

Type:	Boolean
Position:	4
Default value:	None
Accept pipeline input:	True
Accept wildcard characters:	False

-Name

Specifies a name for the webhook.

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

-Parameters

Specifies a dictionary of key/value pairs. The keys are the runbook parameter names. The values are the runbook parameter values. When the runbook starts in response to a webhook, these parameters are passed to the runbook.

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

-ResourceGroupName

Specifies the name of the resource group for which this cmdlet creates a webhook.

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

-RunbookName

Specifies the name of the runbook to associate to the webhook.

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

-RunOn

Optional name of the hybrid worker group which should execute the runbook

Type:	String
Aliases:	HybridWorker
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

String

Boolean

DateTimeOffset

Outputs

Webhook