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.
properties	object	Properties of the Rules Engine Configuration.
type	string	Resource type.

list_by_front_door

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
properties	object	Properties of the 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	subscriptionId, resourceGroupName, frontDoorName, rulesEngineName		Gets a Rules Engine Configuration with the specified name within the specified Front Door.
list_by_front_door	select	subscriptionId, resourceGroupName, frontDoorName		Lists all of the Rules Engine Configurations within a Front Door.
create_or_update	insert	subscriptionId, resourceGroupName, frontDoorName, rulesEngineName		Creates a new Rules Engine Configuration with the specified name within the specified Front Door.
delete	delete	subscriptionId, resourceGroupName, frontDoorName, rulesEngineName		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
frontDoorName	string	Name of the Front Door which is globally unique.
resourceGroupName	string	Name of the Resource group within the Azure subscription.
rulesEngineName	string	Name of the Rules Engine which is unique within the Front Door.
subscriptionId	string	The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

SELECT examples

get

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

SELECT
id,
name,
properties,
type
FROM azure.front_door.rules_engines
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND frontDoorName = '{{ frontDoorName }}' -- required
AND rulesEngineName = '{{ rulesEngineName }}' -- required
;

list_by_front_door

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

SELECT
id,
name,
properties,
type
FROM azure.front_door.rules_engines
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND frontDoorName = '{{ frontDoorName }}' -- 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 (
data__properties,
subscriptionId,
resourceGroupName,
frontDoorName,
rulesEngineName
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ frontDoorName }}',
'{{ rulesEngineName }}'
RETURNING
id,
name,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: rules_engines
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the rules_engines resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the rules_engines resource.
    - name: frontDoorName
      value: string
      description: Required parameter for the rules_engines resource.
    - name: rulesEngineName
      value: string
      description: Required parameter for the rules_engines resource.
    - name: properties
      value: object
      description: |
        Properties of the Rules Engine Configuration.

DELETE examples

delete

Deletes an existing Rules Engine Configuration with the specified parameters.

DELETE FROM azure.front_door.rules_engines
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND frontDoorName = '{{ frontDoorName }}' --required
AND rulesEngineName = '{{ rulesEngineName }}' --required
;