你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

New-AzAutomationWebhook

为自动化 Runbook 创建 Webhook。

语法

Default (默认值)

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

说明

New-AzAutomationWebhook cmdlet 为 Azure 自动化 Runbook 创建 Webhook。 请务必保存此 cmdlet 返回的 Webhook URL,因为它无法再次检索。

示例

示例 1:创建 Webhook

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

此命令为名为 ContosoRunbook 的 Runbook 在名为 AutomationAccount01 的自动化帐户中创建名为 Webhook06 的 Webhook。 该命令将 webhook 存储在$Webhook变量中。 已启用 Webhook。 Webhook 在指定时间过期。 此命令不提供 Webhook 参数的任何值。 此命令指定 Force 参数。 因此,它不会提示你进行确认。

示例 2:使用参数创建 Webhook

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

第一个命令创建参数字典,并将其存储在$Params变量中。 第二个命令为名为 ContosoRunbook 的 Runbook 在名为 AutomationAccount01 的自动化帐户中创建名为 Webhook11 的 Webhook。 该命令将$Params中的参数分配给 Webhook。

参数

-AutomationAccountName

指定此 cmdlet 在其中创建 Webhook 的自动化帐户的名称。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:1
必需:True
来自管道的值:False
来自管道的值(按属性名称):True
来自剩余参数的值:False

-Confirm

在运行 cmdlet 之前,提示你进行确认。

参数属性

类型:SwitchParameter
默认值:False
支持通配符:False
不显示:False
别名:cf

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-DefaultProfile

用于与 azure 通信的凭据、帐户、租户和订阅

参数属性

类型:IAzureContextContainer
默认值:None
支持通配符:False
不显示:False
别名:AzContext, AzureRmContext, AzureCredential

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-ExpiryTime

将 Webhook 的到期时间指定为 DateTimeOffset 对象。 可以指定可转换为有效 DateTimeOffset 的字符串或 DateTime

参数属性

类型:DateTimeOffset
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:5
必需:True
来自管道的值:False
来自管道的值(按属性名称):True
来自剩余参数的值:False

-Force

ps_force

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-IsEnabled

指定是否启用 Webhook。

参数属性

类型:Boolean
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:4
必需:True
来自管道的值:False
来自管道的值(按属性名称):True
来自剩余参数的值:False

-Name

指定 Webhook 的名称。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:2
必需:True
来自管道的值:False
来自管道的值(按属性名称):True
来自剩余参数的值:False

-Parameters

指定键/值对的字典。 密钥是 Runbook 参数名称。 这些值是 Runbook 参数值。 当 Runbook 开始响应 Webhook 时,这些参数将传递给 Runbook。

参数属性

类型:IDictionary
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-ResourceGroupName

指定此 cmdlet 为其创建 Webhook 的资源组的名称。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:0
必需:True
来自管道的值:False
来自管道的值(按属性名称):True
来自剩余参数的值:False

-RunbookName

指定要关联到 Webhook 的 Runbook 的名称。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:3
必需:True
来自管道的值:False
来自管道的值(按属性名称):True
来自剩余参数的值:False

-RunOn

应执行 Runbook 的混合辅助角色组的可选名称

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False
别名:HybridWorker

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-WhatIf

显示 cmdlet 运行时会发生什么情况。 命令脚本未运行。

参数属性

类型:SwitchParameter
默认值:False
支持通配符:False
不显示:False
别名:无线

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

CommonParameters

此 cmdlet 支持通用参数:-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 有关详细信息,请参阅 about_CommonParameters

输入

String

Boolean

DateTimeOffset

输出

Webhook