triggers

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

Overview

Name	triggers
Type	Resource
Id	azure.developer_loadtesting.triggers

Fields

The following fields are returned by SELECT queries:

get_trigger

Name	Datatype	Description
createdBy	string	The user that created.
createdDateTime	string (date-time)	The creation datetime(RFC 3339 literal format).
description	string	The description of the trigger.
displayName	string	The name of the trigger. Required.
kind	string	The type of the trigger. Required. "ScheduleTestsTrigger"
lastModifiedBy	string	The user that last modified.
lastModifiedDateTime	string (date-time)	The last Modified datetime(RFC 3339 literal format).
state	string	The current state of the trigger. Known values are: "Active", "Paused", "Completed", and "Disabled". (Active, Paused, Completed, Disabled)
stateDetails	object	Details of current state of the trigger.
triggerId	string	The unique identifier of the trigger. Required.

list_triggers

Name	Datatype	Description
createdBy	string	The user that created.
createdDateTime	string (date-time)	The creation datetime(RFC 3339 literal format).
description	string	The description of the trigger.
displayName	string	The name of the trigger. Required.
kind	string	The type of the trigger. Required. "ScheduleTestsTrigger"
lastModifiedBy	string	The user that last modified.
lastModifiedDateTime	string (date-time)	The last Modified datetime(RFC 3339 literal format).
state	string	The current state of the trigger. Known values are: "Active", "Paused", "Completed", and "Disabled". (Active, Paused, Completed, Disabled)
stateDetails	object	Details of current state of the trigger.
triggerId	string	The unique identifier of the trigger. Required.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_trigger	select	trigger_id, endpoint		Resource read operation template.
list_triggers	select	endpoint	testIds, states, lastModifiedStartTime, lastModifiedEndTime, maxpagesize	Resource list operation template.
create_or_update_trigger	insert	trigger_id, endpoint, displayName, kind		Create or update operation template.
create_or_update_trigger	replace	trigger_id, endpoint, displayName, kind		Create or update operation template.
delete_trigger	delete	trigger_id, endpoint		Resource delete operation template.

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
endpoint	string	The service endpoint host (no scheme), e.g. myaccount.table.cosmos.azure.com:443 - value of the client endpoint parameter. (default: )
trigger_id	string	The unique identifier of the trigger. Required.
lastModifiedEndTime	string (date-time)	End DateTime(RFC 3339 literal format) of the last updated time range to filter triggers. Default value is None.
lastModifiedStartTime	string (date-time)	Start DateTime(RFC 3339 literal format) of the last updated time range to filter triggers. Default value is None.
maxpagesize	integer
states	string	Filter triggers based on a comma separated list of states. Known values are: "Active", "Paused", "Completed", and "Disabled". Default value is None.
testIds	string	Search based on triggers associated with the provided test ids. Default value is None.

SELECT examples

get_trigger

Resource read operation template.

SELECT
createdBy,
createdDateTime,
description,
displayName,
kind,
lastModifiedBy,
lastModifiedDateTime,
state,
stateDetails,
triggerId
FROM azure.developer_loadtesting.triggers
WHERE trigger_id = '{{ trigger_id }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;

list_triggers

Resource list operation template.

SELECT
createdBy,
createdDateTime,
description,
displayName,
kind,
lastModifiedBy,
lastModifiedDateTime,
state,
stateDetails,
triggerId
FROM azure.developer_loadtesting.triggers
WHERE endpoint = '{{ endpoint }}' -- required
AND testIds = '{{ testIds }}'
AND states = '{{ states }}'
AND lastModifiedStartTime = '{{ lastModifiedStartTime }}'
AND lastModifiedEndTime = '{{ lastModifiedEndTime }}'
AND maxpagesize = '{{ maxpagesize }}'
;

INSERT examples

create_or_update_trigger

Create or update operation template.

INSERT INTO azure.developer_loadtesting.triggers (
displayName,
description,
kind,
state,
trigger_id,
endpoint
)
SELECT 
'{{ displayName }}' /* required */,
'{{ description }}',
'{{ kind }}' /* required */,
'{{ state }}',
'{{ trigger_id }}',
'{{ endpoint }}'
RETURNING
createdBy,
createdDateTime,
description,
displayName,
kind,
lastModifiedBy,
lastModifiedDateTime,
state,
stateDetails,
triggerId
;

Manifest

# Description fields are for documentation purposes
- name: triggers
props:
  - name: trigger_id
    value: "{{ trigger_id }}"
    description: Required parameter for the triggers resource.
  - name: endpoint
    value: "{{ endpoint }}"
    description: Required parameter for the triggers resource.
  - name: displayName
    value: "{{ displayName }}"
    description: |
      The name of the trigger. Required.
  - name: description
    value: "{{ description }}"
    description: |
      The description of the trigger.
  - name: kind
    value: "{{ kind }}"
    description: |
      The type of the trigger. Required. "ScheduleTestsTrigger"
  - name: state
    value: "{{ state }}"
    description: |
      The current state of the trigger. Known values are: "Active", "Paused", "Completed", and "Disabled".
    valid_values: ['Active', 'Paused', 'Completed', 'Disabled']

REPLACE examples

create_or_update_trigger

Create or update operation template.

REPLACE azure.developer_loadtesting.triggers
SET 
displayName = '{{ displayName }}',
description = '{{ description }}',
kind = '{{ kind }}',
state = '{{ state }}'
WHERE 
trigger_id = '{{ trigger_id }}' --required
AND endpoint = '{{ endpoint }}' --required
AND displayName = '{{ displayName }}' --required
AND kind = '{{ kind }}' --required
RETURNING
createdBy,
createdDateTime,
description,
displayName,
kind,
lastModifiedBy,
lastModifiedDateTime,
state,
stateDetails,
triggerId;

DELETE examples

delete_trigger

Resource delete operation template.

DELETE FROM azure.developer_loadtesting.triggers
WHERE trigger_id = '{{ trigger_id }}' --required
AND endpoint = '{{ endpoint }}' --required
;