region_loadbalancing_l7_policy_l7_rules

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

Overview

Name	region_loadbalancing_l7_policy_l7_rules
Type	Resource
Id	ovh.cloud_network.region_loadbalancing_l7_policy_l7_rules

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	string (uuid)	The ID of the L7 rule
compare_type	string	The comparison type for the L7 rule (contains, endsWith, equalTo, regex, startsWith) (wire: compareType)
invert	boolean	When true the logic of the rule is inverted. For example, with invert set to true, equal to would become not equal to
key	string	The key to use for the comparison. For example, the name of the cookie to evaluate
operating_status	string	Operating status of the resource (degraded, draining, error, noMonitor, offline, online) (wire: operatingStatus)
provisioning_status	string	provisioning status of the resource (active, creating, deleted, deleting, error, updating) (wire: provisioningStatus)
rule_type	string	The L7 rule type (cookie, fileType, header, hostName, path, sslConnHasCert, sslDNField, sslVerifyResult) (wire: ruleType)
value	string	The value to use for the comparison. For example, the file type to compare

list

L7 rule

Name	Datatype	Description
id	string (uuid)	The ID of the L7 rule
compare_type	string	The comparison type for the L7 rule (contains, endsWith, equalTo, regex, startsWith) (wire: compareType)
invert	boolean	When true the logic of the rule is inverted. For example, with invert set to true, equal to would become not equal to
key	string	The key to use for the comparison. For example, the name of the cookie to evaluate
operating_status	string	Operating status of the resource (degraded, draining, error, noMonitor, offline, online) (wire: operatingStatus)
provisioning_status	string	provisioning status of the resource (active, creating, deleted, deleting, error, updating) (wire: provisioningStatus)
rule_type	string	The L7 rule type (cookie, fileType, header, hostName, path, sslConnHasCert, sslDNField, sslVerifyResult) (wire: ruleType)
value	string	The value to use for the comparison. For example, the file type to compare

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	l_7_policy_id, l_7_rule_id, region_name, service_name
list	select	l_7_policy_id, region_name, service_name
create	insert	l_7_policy_id, region_name, service_name, compare_type, rule_type, value
update	update	l_7_policy_id, l_7_rule_id, region_name, service_name, compare_type, rule_type, value
delete	delete	l_7_policy_id, l_7_rule_id, region_name, service_name

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
api_host	string	The OVHcloud API host. Selected by OVH_ENDPOINT (ovh-eu, ovh-ca or ovh-us; default ovh-eu). (default: api.eu.ovhcloud.com, x-stackQL-envVarSelector: {"envVar":"OVH_ENDPOINT","default":"ovh-eu","values":{"ovh-eu":"api.eu.ovhcloud.com","ovh-ca":"api.ca.ovhcloud.com","ovh-us":"api.us.ovhcloud.com"}})
l_7_policy_id	string (uuid)	L7 policy ID (wire: l7PolicyId)
l_7_rule_id	string (uuid)	L7 rule ID (wire: l7RuleId)
region_name	string	Region name (wire: regionName)
service_name	string	The Public Cloud project ID. Resolved from OVH_CLOUD_PROJECT_SERVICE when set.

SELECT examples

get

successful operation

SELECT
id,
compare_type,
invert,
key,
operating_status,
provisioning_status,
rule_type,
value
FROM ovh.cloud_network.region_loadbalancing_l7_policy_l7_rules
WHERE l_7_policy_id = '{{ l_7_policy_id }}' -- required
AND l_7_rule_id = '{{ l_7_rule_id }}' -- required
AND region_name = '{{ region_name }}' -- required
AND service_name = '{{ service_name }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
;

list

L7 rule

SELECT
id,
compare_type,
invert,
key,
operating_status,
provisioning_status,
rule_type,
value
FROM ovh.cloud_network.region_loadbalancing_l7_policy_l7_rules
WHERE l_7_policy_id = '{{ l_7_policy_id }}' -- required
AND region_name = '{{ region_name }}' -- required
AND service_name = '{{ service_name }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
;

INSERT examples

create

No description available.

INSERT INTO ovh.cloud_network.region_loadbalancing_l7_policy_l7_rules (
compare_type,
invert,
key,
rule_type,
value,
l_7_policy_id,
region_name,
service_name
)
SELECT 
'{{ compare_type }}' /* required */,
{{ invert }},
'{{ key }}',
'{{ rule_type }}' /* required */,
'{{ value }}' /* required */,
'{{ l_7_policy_id }}',
'{{ region_name }}',
'{{ service_name }}'
RETURNING
id,
compare_type,
invert,
key,
operating_status,
provisioning_status,
rule_type,
value
;

Manifest

# Description fields are for documentation purposes
- name: region_loadbalancing_l7_policy_l7_rules
props:
  - name: l_7_policy_id
    value: "{{ l_7_policy_id }}"
    description: Required parameter for the region_loadbalancing_l7_policy_l7_rules resource.
  - name: region_name
    value: "{{ region_name }}"
    description: Required parameter for the region_loadbalancing_l7_policy_l7_rules resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the region_loadbalancing_l7_policy_l7_rules resource.
  - name: compare_type
    value: "{{ compare_type }}"
    description: |
      The comparison type for the L7 rule
    valid_values: ['contains', 'endsWith', 'equalTo', 'regex', 'startsWith']
  - name: invert
    value: {{ invert }}
    description: |
      When true the logic of the rule is inverted. For example, with invert set to true, equal to would become not equal to
  - name: key
    value: "{{ key }}"
    description: |
      The key to use for the comparison. For example, the name of the cookie to evaluate
  - name: rule_type
    value: "{{ rule_type }}"
    description: |
      The L7 rule type
    valid_values: ['cookie', 'fileType', 'header', 'hostName', 'path', 'sslConnHasCert', 'sslDNField', 'sslVerifyResult']
  - name: value
    value: "{{ value }}"
    description: |
      The value to use for the comparison. For example, the file type to compare

UPDATE examples

update

No description available.

UPDATE ovh.cloud_network.region_loadbalancing_l7_policy_l7_rules
SET 
compare_type = '{{ compare_type }}',
invert = {{ invert }},
key = '{{ key }}',
rule_type = '{{ rule_type }}',
value = '{{ value }}'
WHERE 
l_7_policy_id = '{{ l_7_policy_id }}' --required
AND l_7_rule_id = '{{ l_7_rule_id }}' --required
AND region_name = '{{ region_name }}' --required
AND service_name = '{{ service_name }}' --required unless OVH_CLOUD_PROJECT_SERVICE is set
AND compare_type = '{{ compare_type }}' --required
AND rule_type = '{{ rule_type }}' --required
AND value = '{{ value }}' --required
RETURNING
id,
compare_type,
invert,
key,
operating_status,
provisioning_status,
rule_type,
value;

DELETE examples

delete

No description available.

DELETE FROM ovh.cloud_network.region_loadbalancing_l7_policy_l7_rules
WHERE l_7_policy_id = '{{ l_7_policy_id }}' --required
AND l_7_rule_id = '{{ l_7_rule_id }}' --required
AND region_name = '{{ region_name }}' --required
AND service_name = '{{ service_name }}' --required unless OVH_CLOUD_PROJECT_SERVICE is set
;