rules_engines

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

Overview

Name	rules_engines
Type	Resource
Id	azure.front_door.rules_engines

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
resourceState	string	Resource status of the Front Door or Front Door SubResource. Known values are: "Creating", "Enabling", "Enabled", "Disabling", "Disabled", "Deleting", "Migrating", and "Migrated". (Creating, Enabling, Enabled, Disabling, Disabled, Deleting, Migrating, Migrated)
rules	array	A list of rules that define a particular Rules Engine Configuration.
type	string	Resource type.

list_by_front_door

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
resourceState	string	Resource status of the Front Door or Front Door SubResource. Known values are: "Creating", "Enabling", "Enabled", "Disabling", "Disabled", "Deleting", "Migrating", and "Migrated". (Creating, Enabling, Enabled, Disabling, Disabled, Deleting, Migrating, Migrated)
rules	array	A list of rules that define a particular Rules Engine Configuration.
type	string	Resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, front_door_name, rules_engine_name, subscription_id		Gets a Rules Engine Configuration with the specified name within the specified Front Door.
list_by_front_door	select	resource_group_name, front_door_name, subscription_id		Lists all of the Rules Engine Configurations within a Front Door.
create_or_update	insert	resource_group_name, front_door_name, rules_engine_name, subscription_id		Creates a new Rules Engine Configuration with the specified name within the specified Front Door.
create_or_update	replace	resource_group_name, front_door_name, rules_engine_name, subscription_id		Creates a new Rules Engine Configuration with the specified name within the specified Front Door.
delete	delete	resource_group_name, front_door_name, rules_engine_name, subscription_id		Deletes an existing Rules Engine Configuration with the specified parameters.

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
front_door_name	string	Name of the Front Door which is globally unique. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
rules_engine_name	string	Name of the Rules Engine which is unique within the Front Door. Required.
subscription_id	string

SELECT examples

get

Gets a Rules Engine Configuration with the specified name within the specified Front Door.

SELECT
id,
name,
resourceState,
rules,
type
FROM azure.front_door.rules_engines
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND front_door_name = '{{ front_door_name }}' -- required
AND rules_engine_name = '{{ rules_engine_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_front_door

Lists all of the Rules Engine Configurations within a Front Door.

SELECT
id,
name,
resourceState,
rules,
type
FROM azure.front_door.rules_engines
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND front_door_name = '{{ front_door_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates a new Rules Engine Configuration with the specified name within the specified Front Door.

INSERT INTO azure.front_door.rules_engines (
properties,
resource_group_name,
front_door_name,
rules_engine_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ front_door_name }}',
'{{ rules_engine_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: rules_engines
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the rules_engines resource.
  - name: front_door_name
    value: "{{ front_door_name }}"
    description: Required parameter for the rules_engines resource.
  - name: rules_engine_name
    value: "{{ rules_engine_name }}"
    description: Required parameter for the rules_engines resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the rules_engines resource.
  - name: properties
    description: |
      Properties of the Rules Engine Configuration.
    value:
      rules:
        - name: "{{ name }}"
          priority: {{ priority }}
          action:
            requestHeaderActions:
              - headerActionType: "{{ headerActionType }}"
                headerName: "{{ headerName }}"
                value: "{{ value }}"
            responseHeaderActions:
              - headerActionType: "{{ headerActionType }}"
                headerName: "{{ headerName }}"
                value: "{{ value }}"
            routeConfigurationOverride:
              @odata:
                type: "{{ type }}"
          matchConditions: "{{ matchConditions }}"
          matchProcessingBehavior: "{{ matchProcessingBehavior }}"
      resourceState: "{{ resourceState }}"

REPLACE examples

create_or_update

Creates a new Rules Engine Configuration with the specified name within the specified Front Door.

REPLACE azure.front_door.rules_engines
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND front_door_name = '{{ front_door_name }}' --required
AND rules_engine_name = '{{ rules_engine_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
type;

DELETE examples

delete

Deletes an existing Rules Engine Configuration with the specified parameters.

DELETE FROM azure.front_door.rules_engines
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND front_door_name = '{{ front_door_name }}' --required
AND rules_engine_name = '{{ rules_engine_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;