dex_rules

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

Overview

Name	dex_rules
Type	Resource
Id	cloudflare.zero_trust.dex_rules

Fields

The following fields are returned by SELECT queries:

get

success response

Name	Datatype	Description
id	string	API Resource UUID tag. (example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415)
name	string
created_at	string	(example: 2023-07-16 15:00:00+00, x-stainless-terraform-configurability: computed)
description	string
match	string
targeted_tests	array	(x-stainless-terraform-configurability: computed)
updated_at	string	(example: 2023-07-16 15:00:00+00, x-stainless-terraform-configurability: computed)

list

success response

Name	Datatype	Description
id	string	API Resource UUID tag. (example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415)
name	string
created_at	string	(example: 2023-07-16 15:00:00+00, x-stainless-terraform-configurability: computed)
description	string
match	string
targeted_tests	array	(x-stainless-terraform-configurability: computed)
updated_at	string	(example: 2023-07-16 15:00:00+00, 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, rule_id		Get details for a DEX Rule
list	select	account_id	page, per_page, sort_order, sort_by, name	List DEX Rules
create	insert	account_id, name, match		Create a DEX Rule
update	update	account_id, rule_id		Update a DEX Rule
delete	delete	account_id, rule_id		Delete a DEX Rule

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.
rule_id	string	The rule ID.
name	string	Filter results by rule name
page	number	Page number of paginated results
per_page	number	Number of items per page
sort_by	string	Which property to sort results by
sort_order	string	Sort direction for sort_by property

SELECT examples

get

Get details for a DEX Rule

SELECT
id,
name,
created_at,
description,
match,
targeted_tests,
updated_at
FROM cloudflare.zero_trust.dex_rules
WHERE account_id = '{{ account_id }}' -- required
AND rule_id = '{{ rule_id }}' -- required
;

list

List DEX Rules

SELECT
id,
name,
created_at,
description,
match,
targeted_tests,
updated_at
FROM cloudflare.zero_trust.dex_rules
WHERE account_id = '{{ account_id }}' -- required
AND page = '{{ page }}'
AND per_page = '{{ per_page }}'
AND sort_order = '{{ sort_order }}'
AND sort_by = '{{ sort_by }}'
AND name = '{{ name }}'
;

INSERT examples

create

Create a DEX Rule

INSERT INTO cloudflare.zero_trust.dex_rules (
description,
match,
name,
account_id
)
SELECT 
'{{ description }}',
'{{ match }}' /* required */,
'{{ name }}' /* required */,
'{{ account_id }}'
RETURNING
errors,
messages,
result,
success
;

Manifest

# Description fields are for documentation purposes
- name: dex_rules
props:
  - name: account_id
    value: "{{ account_id }}"
    description: Required parameter for the dex_rules resource.
  - name: description
    value: "{{ description }}"
  - name: match
    value: "{{ match }}"
    description: |
      The wirefilter expression to match.
  - name: name
    value: "{{ name }}"
    description: |
      The name of the Rule.

UPDATE examples

update

Update a DEX Rule

UPDATE cloudflare.zero_trust.dex_rules
SET 
description = '{{ description }}',
match = '{{ match }}',
name = '{{ name }}'
WHERE 
account_id = '{{ account_id }}' --required
AND rule_id = '{{ rule_id }}' --required
RETURNING
errors,
messages,
result,
success;

DELETE examples

delete

Delete a DEX Rule

DELETE FROM cloudflare.zero_trust.dex_rules
WHERE account_id = '{{ account_id }}' --required
AND rule_id = '{{ rule_id }}' --required
;