customer_events

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

Overview

Name	customer_events
Type	Resource
Id	azure_extras.testbase.customer_events

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
eventName	string	The name of the event subscribed to.
receivers	array	The notification event receivers.
systemData	object	The system metadata relating to this resource.
type	string	Resource type.

list_by_test_base_account

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
eventName	string	The name of the event subscribed to.
receivers	array	The notification event receivers.
systemData	object	The system metadata relating to this resource.
type	string	Resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, test_base_account_name, customer_event_name, subscription_id		Gets a Test Base CustomerEvent.
list_by_test_base_account	select	resource_group_name, test_base_account_name, subscription_id		Lists all notification events subscribed under a Test Base Account.
create	insert	resource_group_name, test_base_account_name, customer_event_name, subscription_id		Create or replace a Test Base Customer Event.
delete	delete	resource_group_name, test_base_account_name, customer_event_name, subscription_id		Deletes a Test Base Customer Event.

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
customer_event_name	string	The resource name of the Test Base Customer event. Required.
resource_group_name	string	The name of the resource group that contains the resource. Required.
subscription_id	string
test_base_account_name	string	The resource name of the Test Base Account. Required.

SELECT examples

get

Gets a Test Base CustomerEvent.

SELECT
id,
name,
eventName,
receivers,
systemData,
type
FROM azure_extras.testbase.customer_events
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND test_base_account_name = '{{ test_base_account_name }}' -- required
AND customer_event_name = '{{ customer_event_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_test_base_account

Lists all notification events subscribed under a Test Base Account.

SELECT
id,
name,
eventName,
receivers,
systemData,
type
FROM azure_extras.testbase.customer_events
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND test_base_account_name = '{{ test_base_account_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Create or replace a Test Base Customer Event.

INSERT INTO azure_extras.testbase.customer_events (
properties,
resource_group_name,
test_base_account_name,
customer_event_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ test_base_account_name }}',
'{{ customer_event_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: customer_events
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the customer_events resource.
  - name: test_base_account_name
    value: "{{ test_base_account_name }}"
    description: Required parameter for the customer_events resource.
  - name: customer_event_name
    value: "{{ customer_event_name }}"
    description: Required parameter for the customer_events resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the customer_events resource.
  - name: properties
    value:
      eventName: "{{ eventName }}"
      receivers:
        - receiverType: "{{ receiverType }}"
          receiverValue:
            userObjectReceiverValue:
              userObjectIds:
                - "{{ userObjectIds }}"
            subscriptionReceiverValue:
              subscriptionId: "{{ subscriptionId }}"
              subscriptionName: "{{ subscriptionName }}"
              role: "{{ role }}"
            distributionGroupListReceiverValue:
              distributionGroups:
                - "{{ distributionGroups }}"

DELETE examples

delete

Deletes a Test Base Customer Event.

DELETE FROM azure_extras.testbase.customer_events
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND test_base_account_name = '{{ test_base_account_name }}' --required
AND customer_event_name = '{{ customer_event_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;