webhook

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

Overview

Name	webhook
Type	Resource
Id	azure_extras.app_compliance_automation.webhook

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long
name	string	The name of the resource.
contentType	string	content type. "application/json"
deliveryStatus	string	webhook deliveryStatus. Known values are: "Succeeded", "Failed", and "NotStarted".
enableSslVerification	string	whether to enable ssl verification. Known values are: "true" and "false".
events	array	under which event notification should be sent.
payloadUrl	string	webhook payload url.
provisioningState	string	Azure Resource Provisioning State. Known values are: "Succeeded", "Failed", "Canceled", "Creating", "Deleting", "Fixing", "Verifying", and "Updating".
sendAllEvents	string	whether to send notification under any event. Known values are: "true" and "false".
status	string	Webhook status. Known values are: "Enabled" and "Disabled".
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tenantId	string	Tenant id.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
updateWebhookKey	string	whether to update webhookKey. Known values are: "true" and "false".
webhookId	string	Webhook id in database.
webhookKey	string	webhook secret token. If not set, this field value is null; otherwise, please set a string value.
webhookKeyEnabled	string	whether webhookKey is enabled. Known values are: "true" and "false".

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long
name	string	The name of the resource.
contentType	string	content type. "application/json"
deliveryStatus	string	webhook deliveryStatus. Known values are: "Succeeded", "Failed", and "NotStarted".
enableSslVerification	string	whether to enable ssl verification. Known values are: "true" and "false".
events	array	under which event notification should be sent.
payloadUrl	string	webhook payload url.
provisioningState	string	Azure Resource Provisioning State. Known values are: "Succeeded", "Failed", "Canceled", "Creating", "Deleting", "Fixing", "Verifying", and "Updating".
sendAllEvents	string	whether to send notification under any event. Known values are: "true" and "false".
status	string	Webhook status. Known values are: "Enabled" and "Disabled".
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tenantId	string	Tenant id.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
updateWebhookKey	string	whether to update webhookKey. Known values are: "true" and "false".
webhookId	string	Webhook id in database.
webhookKey	string	webhook secret token. If not set, this field value is null; otherwise, please set a string value.
webhookKeyEnabled	string	whether webhookKey is enabled. Known values are: "true" and "false".

Methods

The following methods are available for this resource:

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

SELECT examples

get

Get the AppComplianceAutomation webhook and its properties.

SELECT
id,
name,
contentType,
deliveryStatus,
enableSslVerification,
events,
payloadUrl,
provisioningState,
sendAllEvents,
status,
systemData,
tenantId,
type,
updateWebhookKey,
webhookId,
webhookKey,
webhookKeyEnabled
FROM azure_extras.app_compliance_automation.webhook
WHERE report_name = '{{ report_name }}' -- required
AND webhook_name = '{{ webhook_name }}' -- required
;

list

Get the AppComplianceAutomation webhook list.

SELECT
id,
name,
contentType,
deliveryStatus,
enableSslVerification,
events,
payloadUrl,
provisioningState,
sendAllEvents,
status,
systemData,
tenantId,
type,
updateWebhookKey,
webhookId,
webhookKey,
webhookKeyEnabled
FROM azure_extras.app_compliance_automation.webhook
WHERE report_name = '{{ report_name }}' -- 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.webhook (
properties,
report_name,
webhook_name
)
SELECT 
'{{ properties }}' /* required */,
'{{ report_name }}',
'{{ webhook_name }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: webhook
props:
  - name: report_name
    value: "{{ report_name }}"
    description: Required parameter for the webhook resource.
  - name: webhook_name
    value: "{{ webhook_name }}"
    description: Required parameter for the webhook resource.
  - name: properties
    description: |
      Webhook property. Required.
    value:
      webhookId: "{{ webhookId }}"
      status: "{{ status }}"
      tenantId: "{{ tenantId }}"
      sendAllEvents: "{{ sendAllEvents }}"
      events:
        - "{{ events }}"
      payloadUrl: "{{ payloadUrl }}"
      contentType: "{{ contentType }}"
      webhookKey: "{{ webhookKey }}"
      updateWebhookKey: "{{ updateWebhookKey }}"
      webhookKeyEnabled: "{{ webhookKeyEnabled }}"
      enableSslVerification: "{{ enableSslVerification }}"
      deliveryStatus: "{{ deliveryStatus }}"
      provisioningState: "{{ provisioningState }}"

UPDATE examples

update

Update an exiting AppComplianceAutomation webhook.

UPDATE azure_extras.app_compliance_automation.webhook
SET 
properties = '{{ properties }}'
WHERE 
report_name = '{{ report_name }}' --required
AND webhook_name = '{{ webhook_name }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

REPLACE examples

create_or_update

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

REPLACE azure_extras.app_compliance_automation.webhook
SET 
properties = '{{ properties }}'
WHERE 
report_name = '{{ report_name }}' --required
AND webhook_name = '{{ webhook_name }}' --required
AND properties = '{{ properties }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Delete an AppComplianceAutomation webhook.

DELETE FROM azure_extras.app_compliance_automation.webhook
WHERE report_name = '{{ report_name }}' --required
AND webhook_name = '{{ webhook_name }}' --required
;