dex_tests

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

Overview

Name	dex_tests
Type	Resource
Id	cloudflare.zero_trust.dex_tests

Fields

The following fields are returned by SELECT queries:

get

Device DEX test details response

Name	Datatype	Description
name	string	The name of the DEX test. Must be unique. (example: HTTP dash health check)
test_id	string	The unique identifier for the test. (example: 372e67954025e0ba6aaa6d586b9e0b59)
data	object	The configuration object which contains the details for the WARP client to conduct the test.
description	string	Additional details about the test. (example: Checks the dash endpoint every 30 minutes)
enabled	boolean	Determines whether or not the test is active.
interval	string	How often the test will run. (example: 30m)
target_policies	array	DEX rules targeted by this test
targeted	boolean	(x-stainless-terraform-configurability: computed)

list

Device DEX test details response

Name	Datatype	Description
name	string	The name of the DEX test. Must be unique. (example: HTTP dash health check)
test_id	string	The unique identifier for the test. (example: 372e67954025e0ba6aaa6d586b9e0b59)
data	object	The configuration object which contains the details for the WARP client to conduct the test.
description	string	Additional details about the test. (example: Checks the dash endpoint every 30 minutes)
enabled	boolean	Determines whether or not the test is active.
interval	string	How often the test will run. (example: 30m)
target_policies	array	DEX rules targeted by this test
targeted	boolean	(x-stainless-terraform-configurability: computed)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	account_id, dex_test_id		Fetch a single DEX test.
list	select	account_id	page, per_page, testName, kind	Fetch all DEX tests
create	insert	account_id, name, interval, enabled, data		Create a DEX test.
update	replace	account_id, dex_test_id, name, interval, enabled, data		Update a DEX test.
delete	delete	account_id, dex_test_id		Delete a Device DEX test. Returns the remaining device dex tests for the account.

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
account_id	string	The Cloudflare account ID.
dex_test_id	string
kind	string	Filter by test type
page	number	Page number of paginated results
per_page	number	Number of items per page
testName	string	Filter by test name

SELECT examples

get

Fetch a single DEX test.

SELECT
name,
test_id,
data,
description,
enabled,
interval,
target_policies,
targeted
FROM cloudflare.zero_trust.dex_tests
WHERE account_id = '{{ account_id }}' -- required
AND dex_test_id = '{{ dex_test_id }}' -- required
;

list

Fetch all DEX tests

SELECT
name,
test_id,
data,
description,
enabled,
interval,
target_policies,
targeted
FROM cloudflare.zero_trust.dex_tests
WHERE account_id = '{{ account_id }}' -- required
AND page = '{{ page }}'
AND per_page = '{{ per_page }}'
AND testName = '{{ testName }}'
AND kind = '{{ kind }}'
;

INSERT examples

create

Create a DEX test.

INSERT INTO cloudflare.zero_trust.dex_tests (
data,
description,
enabled,
interval,
name,
target_policies,
targeted,
account_id
)
SELECT 
'{{ data }}' /* required */,
'{{ description }}',
{{ enabled }} /* required */,
'{{ interval }}' /* required */,
'{{ name }}' /* required */,
'{{ target_policies }}',
{{ targeted }},
'{{ account_id }}'
RETURNING
errors,
messages,
result,
success
;

Manifest

# Description fields are for documentation purposes
- name: dex_tests
props:
  - name: account_id
    value: "{{ account_id }}"
    description: Required parameter for the dex_tests resource.
  - name: data
    description: |
      The configuration object which contains the details for the WARP client to conduct the test.
    value:
      host: "{{ host }}"
      kind: "{{ kind }}"
      method: "{{ method }}"
  - name: description
    value: "{{ description }}"
    description: |
      Additional details about the test.
  - name: enabled
    value: {{ enabled }}
    description: |
      Determines whether or not the test is active.
  - name: interval
    value: "{{ interval }}"
    description: |
      How often the test will run.
  - name: name
    value: "{{ name }}"
    description: |
      The name of the DEX test. Must be unique.
  - name: target_policies
    description: |
      DEX rules targeted by this test
    value:
      - default: {{ default }}
        id: "{{ id }}"
        name: "{{ name }}"
  - name: targeted
    value: {{ targeted }}

REPLACE examples

update

Update a DEX test.

REPLACE cloudflare.zero_trust.dex_tests
SET 
data = '{{ data }}',
description = '{{ description }}',
enabled = {{ enabled }},
interval = '{{ interval }}',
name = '{{ name }}',
target_policies = '{{ target_policies }}',
targeted = {{ targeted }}
WHERE 
account_id = '{{ account_id }}' --required
AND dex_test_id = '{{ dex_test_id }}' --required
AND name = '{{ name }}' --required
AND interval = '{{ interval }}' --required
AND enabled = {{ enabled }} --required
AND data = '{{ data }}' --required
RETURNING
errors,
messages,
result,
success;

DELETE examples

delete

Delete a Device DEX test. Returns the remaining device dex tests for the account.

DELETE FROM cloudflare.zero_trust.dex_tests
WHERE account_id = '{{ account_id }}' --required
AND dex_test_id = '{{ dex_test_id }}' --required
;