New-AzAutomationWebhook

  • リファレンス
モジュール:
Az.Automation

Automation Runbook の Webhook を作成します。

構文

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 コマンドレットは、Azure Automation Runbook の Webhook を作成します。 このコマンドレットが返す Webhook URL は、再度取得できないため、必ず保存してください。

例

例 1: Webhook を作成する

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

このコマンドは、AutomationAccount01 という名前の Automation アカウントで、ContosoRunbook という名前の Runbook に 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変数に格納します。 2 番目のコマンドは、AutomationAccount01 という名前の Automation アカウントに ContosoRunbook という Runbook の Webhook11 という名前の Webhook を作成します。 このコマンドは、$Paramsのパラメーターを webhook に割り当てます。

パラメーター

-AutomationAccountName

このコマンドレットが Webhook を作成する Automation アカウントの名前を指定します。

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

-Confirm

コマンドレットの実行前に確認を求めるメッセージが表示されます。

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

-DefaultProfile

Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ExpiryTime

Webhook の有効期限を DateTimeOffset オブジェクトとして指定します。 有効な DateTimeOffset に変換できる文字列または DateTime を指定できます。

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

-Force

ps_force

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

-IsEnabled

Webhook が有効かどうかを指定します。

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

-Name

Webhook の名前を指定します。

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

-Parameters

キーと値のペアのディクショナリを指定します。 キーは Runbook パラメーター名です。 値は Runbook パラメーターの値です。 Webhook に応答して Runbook が開始されると、これらのパラメーターが Runbook に渡されます。

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

-ResourceGroupName

このコマンドレットで Webhook を作成するリソース グループの名前を指定します。

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

-RunbookName

Webhook に関連付ける Runbook の名前を指定します。

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

-RunOn

Runbook を実行するハイブリッド worker グループの省略可能な名前

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

-WhatIf

コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。

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

入力

String

Boolean

DateTimeOffset

出力

Webhook