webhooks

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

Overview

Name	webhooks
Type	Resource
Id	azure_extras.app_compliance_automation.webhooks

Fields

The following fields are returned by SELECT queries:

get

Azure operation completed successfully.

Name	Datatype	Description
properties	object	Webhook property.

list

Azure operation completed successfully.

Name	Datatype	Description
properties	object	Webhook property.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	reportName, webhookName		Get the AppComplianceAutomation webhook and its properties.
list	select	reportName	$skipToken, $top, $select, $filter, $orderby, offerGuid, reportCreatorTenantId	Get the AppComplianceAutomation webhook list.
create_or_update	insert	reportName, webhookName, data__properties		Create a new AppComplianceAutomation webhook or update an exiting AppComplianceAutomation webhook.
update	update	reportName, webhookName		Update an exiting AppComplianceAutomation webhook.
delete	delete	reportName, webhookName		Delete an AppComplianceAutomation 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
reportName	string	Report Name.
webhookName	string	Webhook Name.
$filter	string	The filter to apply on the operation.
$orderby	string	OData order by query option.
$select	string	OData Select statement. Limits the properties on each entry to just those requested, e.g. ?$select=reportName,id.
$skipToken	string	Skip over when retrieving results.
$top	integer (int32)	Number of elements to return when retrieving results.
offerGuid	string	The offerGuid which mapping to the reports.
reportCreatorTenantId	string	The tenant id of the report creator.

SELECT examples

get

Get the AppComplianceAutomation webhook and its properties.

SELECT
properties
FROM azure_extras.app_compliance_automation.webhooks
WHERE reportName = '{{ reportName }}' -- required
AND webhookName = '{{ webhookName }}' -- required
;

list

Get the AppComplianceAutomation webhook list.

SELECT
properties
FROM azure_extras.app_compliance_automation.webhooks
WHERE reportName = '{{ reportName }}' -- required
AND $skipToken = '{{ $skipToken }}'
AND $top = '{{ $top }}'
AND $select = '{{ $select }}'
AND $filter = '{{ $filter }}'
AND $orderby = '{{ $orderby }}'
AND offerGuid = '{{ offerGuid }}'
AND reportCreatorTenantId = '{{ reportCreatorTenantId }}'
;

INSERT examples

create_or_update

Create a new AppComplianceAutomation webhook or update an exiting AppComplianceAutomation webhook.

INSERT INTO azure_extras.app_compliance_automation.webhooks (
data__properties,
reportName,
webhookName
)
SELECT 
'{{ properties }}' /* required */,
'{{ reportName }}',
'{{ webhookName }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: webhooks
  props:
    - name: reportName
      value: string
      description: Required parameter for the webhooks resource.
    - name: webhookName
      value: string
      description: Required parameter for the webhooks resource.
    - name: properties
      value: object
      description: |
        Webhook property.

UPDATE examples

update

Update an exiting AppComplianceAutomation webhook.

UPDATE azure_extras.app_compliance_automation.webhooks
SET 
data__properties = '{{ properties }}'
WHERE 
reportName = '{{ reportName }}' --required
AND webhookName = '{{ webhookName }}' --required
RETURNING
properties;

DELETE examples

delete

Delete an AppComplianceAutomation webhook.

DELETE FROM azure_extras.app_compliance_automation.webhooks
WHERE reportName = '{{ reportName }}' --required
AND webhookName = '{{ webhookName }}' --required
;