customer_events
Creates, updates, deletes, gets or lists a customer_events
resource.
Overview
Name | customer_events |
Type | Resource |
Id | azure_extras.test_base.customer_events |
Fields
The following fields are returned by SELECT
queries:
- get
- list_by_test_base_account
The Test Base Customer Event was successfully found.
Name | Datatype | Description |
---|---|---|
properties | object | Customer Notification Event properties. |
The operation is completed.
Name | Datatype | Description |
---|---|---|
properties | object | Customer Notification Event properties. |
Methods
The following methods are available for this resource:
Name | Accessible by | Required Params | Optional Params | Description |
---|---|---|---|---|
get | select | subscriptionId , resourceGroupName , testBaseAccountName , customerEventName | Gets a Test Base CustomerEvent. | |
list_by_test_base_account | select | subscriptionId , resourceGroupName , testBaseAccountName | Lists all notification events subscribed under a Test Base Account. | |
create | insert | subscriptionId , resourceGroupName , testBaseAccountName , customerEventName | Create or replace a Test Base Customer Event. | |
delete | delete | subscriptionId , resourceGroupName , testBaseAccountName , customerEventName | 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 |
---|---|---|
customerEventName | string | The resource name of the Test Base Customer event. |
resourceGroupName | string | The name of the resource group. The name is case insensitive. |
subscriptionId | string (uuid) | The ID of the target subscription. The value must be an UUID. |
testBaseAccountName | string | The resource name of the Test Base Account. |
SELECT
examples
- get
- list_by_test_base_account
Gets a Test Base CustomerEvent.
SELECT
properties
FROM azure_extras.test_base.customer_events
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND testBaseAccountName = '{{ testBaseAccountName }}' -- required
AND customerEventName = '{{ customerEventName }}' -- required
;
Lists all notification events subscribed under a Test Base Account.
SELECT
properties
FROM azure_extras.test_base.customer_events
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND testBaseAccountName = '{{ testBaseAccountName }}' -- required
;
INSERT
examples
- create
- Manifest
Create or replace a Test Base Customer Event.
INSERT INTO azure_extras.test_base.customer_events (
data__properties,
subscriptionId,
resourceGroupName,
testBaseAccountName,
customerEventName
)
SELECT
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ testBaseAccountName }}',
'{{ customerEventName }}'
RETURNING
properties
;
# Description fields are for documentation purposes
- name: customer_events
props:
- name: subscriptionId
value: string (uuid)
description: Required parameter for the customer_events resource.
- name: resourceGroupName
value: string
description: Required parameter for the customer_events resource.
- name: testBaseAccountName
value: string
description: Required parameter for the customer_events resource.
- name: customerEventName
value: string
description: Required parameter for the customer_events resource.
- name: properties
value: object
description: |
Customer Notification Event properties.
DELETE
examples
- delete
Deletes a Test Base Customer Event.
DELETE FROM azure_extras.test_base.customer_events
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND testBaseAccountName = '{{ testBaseAccountName }}' --required
AND customerEventName = '{{ customerEventName }}' --required
;