New-AzAutomationWebhook
語法
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>]
Description
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
此命令會在名為 AutomationAccount01 的自動化帳戶中,為名為 ContosoRunbook 的 Runbook 建立名為 Webhook06 的 Webhook。
此命令會將 Webhook 儲存在 $Webhook 變數中。
Webhook 已啟用。
Webhook 會在指定時間到期。
此命令不提供 Webhook 參數的任何值。
此指令指定 「力」 參數。
因此,它不會提示您確認。
範例 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變數中。
第二個命令會在名為 AutomationAccount01 的自動化帳戶中,為名為 ContosoRunbook 的 Runbook 建立名為 Webhook11 的 Webhook。
此命令會將$Params中的參數指派給 Webhook。
參數
-AutomationAccountName
指定此 Cmdlet 建立 Webhook 的自動化帳戶名稱。
參數屬性
| 類型: | String
|
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | 1 |
| 必要: | True |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | True |
| 來自剩餘引數的值: | False |
-Confirm
在執行 Cmdlet 之前,提示您進行確認。
參數屬性
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-DefaultProfile
用來與 Azure 通訊的認證、帳戶、租用戶和訂用帳戶
參數屬性
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-ExpiryTime
將 Webhook 的到期時間指定為 DateTimeOffset 物件。
您可以指定可轉換成有效 DateTimeOffset 的字串或 DateTime。
參數屬性
參數集
(All)
| Position: | 5 |
| 必要: | True |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | True |
| 來自剩餘引數的值: | False |
-Force
ps_force
參數屬性
參數集
(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。
參數屬性
參數集
(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 |
| 別名: | 混合工作者 |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-WhatIf
顯示 Cmdlet 執行時會發生什麼事。
指令未執行。
參數屬性
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
CommonParameters
此 cmdlet 支援常見參數:-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 如需詳細資訊,請參閱 about_CommonParameters。
輸出