webhooks

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

Overview

Name	webhooks
Type	Resource
Id	azure.automation.webhooks

Fields

vw_webhooks

Name	Datatype	Description
description	text	field from the properties object
automationAccountName	text	field from the properties object
creation_time	text	field from the properties object
expiry_time	text	field from the properties object
is_enabled	text	field from the properties object
last_invoked_time	text	field from the properties object
last_modified_by	text	field from the properties object
last_modified_time	text	field from the properties object
parameters	text	field from the properties object
resourceGroupName	text	field from the properties object
run_on	text	field from the properties object
runbook	text	field from the properties object
subscriptionId	text	field from the properties object
uri	text	field from the properties object
webhookName	text	field from the properties object

webhooks

Name	Datatype	Description
properties	object	Definition of the webhook properties

Methods

Name	Accessible by	Required Params	Description
get	SELECT	automationAccountName, resourceGroupName, subscriptionId, webhookName	Retrieve the webhook identified by webhook name.
list_by_automation_account	SELECT	automationAccountName, resourceGroupName, subscriptionId	Retrieve a list of webhooks.
create_or_update	INSERT	automationAccountName, resourceGroupName, subscriptionId, webhookName, data__name, data__properties	Create the webhook identified by webhook name.
delete	DELETE	automationAccountName, resourceGroupName, subscriptionId, webhookName	Delete the webhook by name.
update	UPDATE	automationAccountName, resourceGroupName, subscriptionId, webhookName	Update the webhook identified by webhook name.
generate_uri	EXEC	automationAccountName, resourceGroupName, subscriptionId	Generates a Uri for use in creating a webhook.

SELECT examples

Retrieve a list of webhooks.

vw_webhooks

SELECT
description,
automationAccountName,
creation_time,
expiry_time,
is_enabled,
last_invoked_time,
last_modified_by,
last_modified_time,
parameters,
resourceGroupName,
run_on,
runbook,
subscriptionId,
uri,
webhookName
FROM azure.automation.vw_webhooks
WHERE automationAccountName = '{{ automationAccountName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

webhooks

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

INSERT example

Use the following StackQL query and manifest file to create a new webhooks resource.

All Properties

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

Manifest

- name: your_resource_model_name
  props:
    - name: name
      value: string
    - name: properties
      value:
        - name: isEnabled
          value: boolean
        - name: uri
          value: string
        - name: expiryTime
          value: string
        - name: parameters
          value: object
        - name: runbook
          value:
            - name: name
              value: string
        - name: runOn
          value: string

UPDATE example

Updates a webhooks resource.

/*+ update */
UPDATE azure.automation.webhooks
SET 
name = '{{ name }}',
properties = '{{ properties }}'
WHERE 
automationAccountName = '{{ automationAccountName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND webhookName = '{{ webhookName }}';

DELETE example

Deletes the specified webhooks resource.

/*+ delete */
DELETE FROM azure.automation.webhooks
WHERE automationAccountName = '{{ automationAccountName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND webhookName = '{{ webhookName }}';