webhooks

Creates, updates, deletes, gets or lists a webhooks resource.

Overview

Name	webhooks
Type	Resource
Id	azure.automation.webhooks

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
properties	object	Gets or sets the webhook properties.

list_by_automation_account

Name	Datatype	Description
properties	object	Gets or sets the webhook properties.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, automationAccountName, webhookName, subscriptionId		Retrieve the webhook identified by webhook name.
list_by_automation_account	select	resourceGroupName, automationAccountName, subscriptionId	$filter	Retrieve a list of webhooks.
create_or_update	insert	resourceGroupName, automationAccountName, webhookName, subscriptionId, data__name, data__properties		Create the webhook identified by webhook name.
update	update	resourceGroupName, automationAccountName, webhookName, subscriptionId		Update the webhook identified by webhook name.
delete	delete	resourceGroupName, automationAccountName, webhookName, subscriptionId		Delete the webhook by name.
generate_uri	exec	resourceGroupName, automationAccountName, subscriptionId		Generates a Uri for use in creating a webhook.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
automationAccountName	string	The name of the automation account.
resourceGroupName	string	Name of an Azure Resource group.
subscriptionId	string	Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
webhookName	string	The webhook name.
$filter	string	The filter to apply on the operation.

SELECT examples

get

Retrieve the webhook identified by webhook name.

SELECT
properties
FROM azure.automation.webhooks
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND automationAccountName = '{{ automationAccountName }}' -- required
AND webhookName = '{{ webhookName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_automation_account

Retrieve a list of webhooks.

SELECT
properties
FROM azure.automation.webhooks
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND automationAccountName = '{{ automationAccountName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND $filter = '{{ $filter }}'
;

INSERT examples

create_or_update

Create the webhook identified by webhook name.

INSERT INTO azure.automation.webhooks (
data__name,
data__properties,
resourceGroupName,
automationAccountName,
webhookName,
subscriptionId
)
SELECT 
'{{ name }}' /* required */,
'{{ properties }}' /* required */,
'{{ resourceGroupName }}',
'{{ automationAccountName }}',
'{{ webhookName }}',
'{{ subscriptionId }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: webhooks
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the webhooks resource.
    - name: automationAccountName
      value: string
      description: Required parameter for the webhooks resource.
    - name: webhookName
      value: string
      description: Required parameter for the webhooks resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the webhooks resource.
    - name: name
      value: string
      description: |
        Gets or sets the name of the webhook.
    - name: properties
      value: object
      description: |
        Gets or sets the properties of the webhook.

UPDATE examples

update

Update the webhook identified by webhook name.

UPDATE azure.automation.webhooks
SET 
data__name = '{{ name }}',
data__properties = '{{ properties }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND automationAccountName = '{{ automationAccountName }}' --required
AND webhookName = '{{ webhookName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
RETURNING
properties;

DELETE examples

delete

Delete the webhook by name.

DELETE FROM azure.automation.webhooks
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND automationAccountName = '{{ automationAccountName }}' --required
AND webhookName = '{{ webhookName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;

Lifecycle Methods

generate_uri

Generates a Uri for use in creating a webhook.

EXEC azure.automation.webhooks.generate_uri 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@automationAccountName='{{ automationAccountName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;