RuleSetProperties interface

The JSON object that contains the properties of the Rule Set to create.

Extends

Properties

batchMode

Indicates whether rule set is in batch mode. When batch mode is enabled, rules will be processed in a batch along with the rule set. When batch mode is disabled, rules would need to be processed independently. This property can only be set during rule set creation and cannot be updated later. For switching modes, a new rule set needs to be created with the desired mode and rules need to be migrated to the new rule set.

profileName

The name of the profile which holds the rule set.

rules

A list of rules that are part of this rule set provided the rule set is in batch mode. This property will be ignored if the rule set is not in batch mode.

Inherited Properties

deploymentStatus
provisioningState

Provisioning status

Property Details

batchMode

Indicates whether rule set is in batch mode. When batch mode is enabled, rules will be processed in a batch along with the rule set. When batch mode is disabled, rules would need to be processed independently. This property can only be set during rule set creation and cannot be updated later. For switching modes, a new rule set needs to be created with the desired mode and rules need to be migrated to the new rule set.

batchMode?: boolean

Property Value

boolean

profileName

The name of the profile which holds the rule set.

profileName?: string

Property Value

string

rules

A list of rules that are part of this rule set provided the rule set is in batch mode. This property will be ignored if the rule set is not in batch mode.

rules?: BatchRuleProperties[]

Property Value

Inherited Property Details

deploymentStatus

deploymentStatus?: string

Property Value

string

Inherited From AFDStateProperties.deploymentStatus

provisioningState

Provisioning status

provisioningState?: string

Property Value

string

Inherited From AFDStateProperties.provisioningState