RuleProperties Class

The JSON object that contains the properties of the Rules to create.

Constructor

RuleProperties()

Variables

Name Description
rule_set_name
str

The name of the rule set containing the rule.
order
int

The order in which the rules are applied for the endpoint. Possible values {0,1,2,3,.........}. A rule with a lesser order will be applied before a rule with a greater order. Rule with order 0 is a special rule. It does not require any condition and actions listed in it will always be applied.
conditions
list[<xref:"DeliveryRuleCondition">]

A list of conditions that must be matched for the actions to be executed.
actions
list[<xref:"DeliveryRuleAction">]

A list of actions that are executed when all the conditions of a rule are satisfied.
match_processing_behavior
Union[str, <xref:"MatchProcessingBehavior">]

If this rule is a match should the rules engine continue running the remaining rules or stop. If not present, defaults to Continue. Known values are: "Continue" and "Stop".
provisioning_state
Union[str, <xref:"AfdProvisioningState">]

Provisioning status. Known values are: "Succeeded", "Failed", "Updating", "Deleting", and "Creating".
deployment_status
Union[str, <xref:"DeploymentStatus">]

Known values are: "NotStarted", "InProgress", "Succeeded", and "Failed".

Attributes

actions

A list of actions that are executed when all the conditions of a rule are satisfied.

actions: list['DeliveryRuleAction']

conditions

A list of conditions that must be matched for the actions to be executed.

conditions: list['DeliveryRuleCondition']

deploymentStatus

"NotStarted", "InProgress", "Succeeded", and "Failed".

deploymentStatus: str | DeploymentStatus

matchProcessingBehavior

If this rule is a match should the rules engine continue running the remaining rules or stop. If not present, defaults to Continue. Known values are: "Continue" and "Stop".

matchProcessingBehavior: str | MatchProcessingBehavior

order

The order in which the rules are applied for the endpoint. Possible values {0,1,2,3,.........}. A rule with a lesser order will be applied before a rule with a greater order. Rule with order 0 is a special rule. It does not require any condition and actions listed in it will always be applied.

order: int

provisioningState

"Succeeded", "Failed", "Updating", "Deleting", and "Creating".

provisioningState: str | AfdProvisioningState

ruleSetName

The name of the rule set containing the rule.

ruleSetName: str