Leggere in inglese Modifica

Condividi tramite

Set-AzAutomationWebhook

Module:
Az.Automation Module

Modifies a webhook for an Automation runbook.

Syntax

Default (Default) 

Set-AzAutomationWebhook
    [-Name] <String>
    [-IsEnabled] <Boolean>
    [[-Parameters] <IDictionary>]
    [-RunOn <String>]
    [-ResourceGroupName] <String>
    [-AutomationAccountName] <String>
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

Description

The Set-AzAutomationWebhook cmdlet modifies a webhook for an Azure Automation runbook.

Examples

Example 1: Disable a webhook

Set-AzAutomationWebhook -Name "Webhook01" -ResourceGroupName "ResourceGroup01" -AutomationAccountName "AutomationAccount01" -IsEnabled $False

This command disables a webhook named Webhook01 in the Automation account named AutomationAccount01.

Example 2

Set-AzAutomationWebhook -Name "Webhook01" -ResourceGroupName "ResourceGroup01" -AutomationAccountName "AutomationAccount01" -RunOn 'Windows'

This command sets the run on value for the webhook and forces the runbook to be run on a Hybrid Worker group called Windows.

Example 3

Set-AzAutomationWebhook -Name "Webhook01" -ResourceGroupName "ResourceGroup01" -AutomationAccountName "AutomationAccount01" -RunOn $null

This command updates the run on value for the webhook and forces the runbook to be run on an Azure runbook worker.

Parameters

-AutomationAccountName

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:1
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-DefaultProfile

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

Parameter properties

Type:IAzureContextContainer
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AzContext, AzureRmContext, AzureCredential

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-IsEnabled

Specifies whether the webhook is enabled.

Parameter properties

Type:

Nullable<T>[Boolean]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:3
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-Name

Specifies a name of the webhook that this cmdlet modifies.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:2
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments: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.

Parameter properties

Type:IDictionary
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:4
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-ResourceGroupName

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:0
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-RunOn

Optional name of the hybrid agent which should execute the runbook

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:HybridWorker

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

String

Nullable<T>

IDictionary

Outputs

Webhook