Powershell input parameters with runbook

Question

Greetings...

I'm exploring different options to execute an azure automation runbook written in powershell that has a few input parameters. I have looked at the microsoft documentation but still not clear on how to implement this. Now, how would I pass the input parameters along with the webhook uri to execute the underlying azure automation runbook.

Powershell:

$uri = "https://webhook.us.azure-automation.net/webhooks?token=abc"  
Invoke-WebRequest -Method Post -Uri $uri   
  
#Input parameter  
  
Param(  
 [string]$user,  
 [string]$password  
)  

Thank you in advance.

Answer 1

Hi @Raj D ,

let's start with a simple Automation Runbook with a simple PowerShell script.

Create a new Automation Runbook and add the following PowerShell script:

param  
(  
    [Parameter(Mandatory = $false)]  
    [object] $WebhookData  
)  
$Inputs = ConvertFrom-Json $webhookdata.RequestBody  
Write-Output "Name of VM = $($Inputs.vmName)"  
Write-Output "Name of ResourceGroup = $($Inputs.rgName)"  

Create a webhook for the Runbook and save the URL

Run the following PowerShell script on your computer to start the Azure Automation Runbook with input parameters :

$webhookURI = '<your-webhook-URI>'  
$params  = @{  
vmName ="TestVM1";  
rgName ="test1-rg"  
}  
$body = ConvertTo-Json -InputObject $params  
$response = Invoke-WebRequest -Method Post -Uri $webhookURI -Body $body -UseBasicParsing  
$response  

The output of the Runbook should look like this:

----------

(If the reply was helpful please don't forget to upvote and/or accept as answer, thank you)

Regards
Andreas Baumgarten

Answer 2

Hi there,

To receive data from the client, the runbook supports a single parameter called WebhookData. This parameter defines an object containing data that the client includes in a POST request.

In this case you need to use and parse a standard variable $WebhookData

Param(  
     $WebhookData  
 )  
  
 # Payload comes in as a json object so convert the body into PowerShell friendly object.  
$RequestBody = ConvertFrom-Json $WebhookData.RequestBody  
  
# Get the results from the table object  
$Result =  $RequestBody.data.SearchResult.tables  

https://learn.microsoft.com/en-us/azure/automation/automation-webhooks?tabs=portal#parameters-used-when-the-webhook-starts-a-runbook

Answer 3

Hi @Raj D ,

Here is a different approach: https://learn.microsoft.com/en-us/azure/automation/runbook-input-parameters

----------

(If the reply was helpful please don't forget to upvote and/or accept as answer, thank you)

Regards
Andreas Baumgarten