akamai.getAppSecEvalRules
Scopes: Security policy; evaluation rule
Returns the action and the condition-exception information for a rule or set of rules being used in evaluation mode.
Related API Endpoint: /appsec/v1/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/eval-rules
Output Options
The following options can be used to determine the information returned, and how that returned information is formatted:
eval_rule_action
. Action taken anytime the evaluation rule is triggered. This information is returned only when a single rule is retrieved. Valid values are:- alert. Record the event.
- deny. Reject the request.
- deny_custom_{custom_deny_id}. The action defined by the custom deny is taken.
- none. Take no action.
condition_exception
. Conditions and exceptions associated with the rule. This information is returned only when a single rule is retrieved.json
. JSON-formatted list of the action and the condition-exception information for the rule. This information is returned only when a single rule is retrieved.output_text
. Tabular report showing the rule action as well as Boolean values indicating whether conditions and exceptions have been configured for the rule.
Example Usage
Basic usage
using System.Collections.Generic;
using Pulumi;
using Akamai = Pulumi.Akamai;
return await Deployment.RunAsync(() =>
{
var configuration = Akamai.GetAppSecConfiguration.Invoke(new()
{
Name = "Documentation",
});
var evalRule = Akamai.GetAppSecEvalRules.Invoke(new()
{
ConfigId = configuration.Apply(getAppSecConfigurationResult => getAppSecConfigurationResult.ConfigId),
SecurityPolicyId = "gms1_134637",
RuleId = 60029316,
});
return new Dictionary<string, object?>
{
["evalRuleAction"] = evalRule.Apply(getAppSecEvalRulesResult => getAppSecEvalRulesResult.EvalRuleAction),
["conditionException"] = evalRule.Apply(getAppSecEvalRulesResult => getAppSecEvalRulesResult.ConditionException),
["json"] = evalRule.Apply(getAppSecEvalRulesResult => getAppSecEvalRulesResult.Json),
["outputText"] = evalRule.Apply(getAppSecEvalRulesResult => getAppSecEvalRulesResult.OutputText),
};
});
package main
import (
"github.com/pulumi/pulumi-akamai/sdk/v4/go/akamai"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
configuration, err := akamai.LookupAppSecConfiguration(ctx, &akamai.LookupAppSecConfigurationArgs{
Name: pulumi.StringRef("Documentation"),
}, nil)
if err != nil {
return err
}
evalRule, err := akamai.GetAppSecEvalRules(ctx, &akamai.GetAppSecEvalRulesArgs{
ConfigId: configuration.ConfigId,
SecurityPolicyId: "gms1_134637",
RuleId: pulumi.IntRef(60029316),
}, nil)
if err != nil {
return err
}
ctx.Export("evalRuleAction", evalRule.EvalRuleAction)
ctx.Export("conditionException", evalRule.ConditionException)
ctx.Export("json", evalRule.Json)
ctx.Export("outputText", evalRule.OutputText)
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.akamai.AkamaiFunctions;
import com.pulumi.akamai.inputs.GetAppSecConfigurationArgs;
import com.pulumi.akamai.inputs.GetAppSecEvalRulesArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var configuration = AkamaiFunctions.getAppSecConfiguration(GetAppSecConfigurationArgs.builder()
.name("Documentation")
.build());
final var evalRule = AkamaiFunctions.getAppSecEvalRules(GetAppSecEvalRulesArgs.builder()
.configId(configuration.applyValue(getAppSecConfigurationResult -> getAppSecConfigurationResult.configId()))
.securityPolicyId("gms1_134637")
.ruleId("60029316")
.build());
ctx.export("evalRuleAction", evalRule.applyValue(getAppSecEvalRulesResult -> getAppSecEvalRulesResult.evalRuleAction()));
ctx.export("conditionException", evalRule.applyValue(getAppSecEvalRulesResult -> getAppSecEvalRulesResult.conditionException()));
ctx.export("json", evalRule.applyValue(getAppSecEvalRulesResult -> getAppSecEvalRulesResult.json()));
ctx.export("outputText", evalRule.applyValue(getAppSecEvalRulesResult -> getAppSecEvalRulesResult.outputText()));
}
}
import pulumi
import pulumi_akamai as akamai
configuration = akamai.get_app_sec_configuration(name="Documentation")
eval_rule = akamai.get_app_sec_eval_rules(config_id=configuration.config_id,
security_policy_id="gms1_134637",
rule_id=60029316)
pulumi.export("evalRuleAction", eval_rule.eval_rule_action)
pulumi.export("conditionException", eval_rule.condition_exception)
pulumi.export("json", eval_rule.json)
pulumi.export("outputText", eval_rule.output_text)
import * as pulumi from "@pulumi/pulumi";
import * as akamai from "@pulumi/akamai";
const configuration = akamai.getAppSecConfiguration({
name: "Documentation",
});
const evalRule = configuration.then(configuration => akamai.getAppSecEvalRules({
configId: configuration.configId,
securityPolicyId: "gms1_134637",
ruleId: 60029316,
}));
export const evalRuleAction = evalRule.then(evalRule => evalRule.evalRuleAction);
export const conditionException = evalRule.then(evalRule => evalRule.conditionException);
export const json = evalRule.then(evalRule => evalRule.json);
export const outputText = evalRule.then(evalRule => evalRule.outputText);
variables:
configuration:
fn::invoke:
Function: akamai:getAppSecConfiguration
Arguments:
name: Documentation
evalRule:
fn::invoke:
Function: akamai:getAppSecEvalRules
Arguments:
configId: ${configuration.configId}
securityPolicyId: gms1_134637
ruleId: '60029316'
outputs:
evalRuleAction: ${evalRule.evalRuleAction}
conditionException: ${evalRule.conditionException}
json: ${evalRule.json}
outputText: ${evalRule.outputText}
Using getAppSecEvalRules
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getAppSecEvalRules(args: GetAppSecEvalRulesArgs, opts?: InvokeOptions): Promise<GetAppSecEvalRulesResult>
function getAppSecEvalRulesOutput(args: GetAppSecEvalRulesOutputArgs, opts?: InvokeOptions): Output<GetAppSecEvalRulesResult>
def get_app_sec_eval_rules(config_id: Optional[int] = None,
rule_id: Optional[int] = None,
security_policy_id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetAppSecEvalRulesResult
def get_app_sec_eval_rules_output(config_id: Optional[pulumi.Input[int]] = None,
rule_id: Optional[pulumi.Input[int]] = None,
security_policy_id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetAppSecEvalRulesResult]
func GetAppSecEvalRules(ctx *Context, args *GetAppSecEvalRulesArgs, opts ...InvokeOption) (*GetAppSecEvalRulesResult, error)
func GetAppSecEvalRulesOutput(ctx *Context, args *GetAppSecEvalRulesOutputArgs, opts ...InvokeOption) GetAppSecEvalRulesResultOutput
> Note: This function is named GetAppSecEvalRules
in the Go SDK.
public static class GetAppSecEvalRules
{
public static Task<GetAppSecEvalRulesResult> InvokeAsync(GetAppSecEvalRulesArgs args, InvokeOptions? opts = null)
public static Output<GetAppSecEvalRulesResult> Invoke(GetAppSecEvalRulesInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetAppSecEvalRulesResult> getAppSecEvalRules(GetAppSecEvalRulesArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: akamai:index/getAppSecEvalRules:getAppSecEvalRules
arguments:
# arguments dictionary
The following arguments are supported:
- Config
Id int . Unique identifier of the security configuration running in evaluation mode.
- Security
Policy stringId . Unique identifier of the security policy associated with the evaluation rule.
- Rule
Id int . Unique identifier of the evaluation rule you want to return information for. If not included, information is returned for all your evaluation rules.
- Config
Id int . Unique identifier of the security configuration running in evaluation mode.
- Security
Policy stringId . Unique identifier of the security policy associated with the evaluation rule.
- Rule
Id int . Unique identifier of the evaluation rule you want to return information for. If not included, information is returned for all your evaluation rules.
- config
Id Integer . Unique identifier of the security configuration running in evaluation mode.
- security
Policy StringId . Unique identifier of the security policy associated with the evaluation rule.
- rule
Id Integer . Unique identifier of the evaluation rule you want to return information for. If not included, information is returned for all your evaluation rules.
- config
Id number . Unique identifier of the security configuration running in evaluation mode.
- security
Policy stringId . Unique identifier of the security policy associated with the evaluation rule.
- rule
Id number . Unique identifier of the evaluation rule you want to return information for. If not included, information is returned for all your evaluation rules.
- config_
id int . Unique identifier of the security configuration running in evaluation mode.
- security_
policy_ strid . Unique identifier of the security policy associated with the evaluation rule.
- rule_
id int . Unique identifier of the evaluation rule you want to return information for. If not included, information is returned for all your evaluation rules.
- config
Id Number . Unique identifier of the security configuration running in evaluation mode.
- security
Policy StringId . Unique identifier of the security policy associated with the evaluation rule.
- rule
Id Number . Unique identifier of the evaluation rule you want to return information for. If not included, information is returned for all your evaluation rules.
getAppSecEvalRules Result
The following output properties are available:
- Condition
Exception string - Config
Id int - Eval
Rule stringAction - Id string
The provider-assigned unique ID for this managed resource.
- Json string
- Output
Text string - Security
Policy stringId - Rule
Id int
- Condition
Exception string - Config
Id int - Eval
Rule stringAction - Id string
The provider-assigned unique ID for this managed resource.
- Json string
- Output
Text string - Security
Policy stringId - Rule
Id int
- condition
Exception String - config
Id Integer - eval
Rule StringAction - id String
The provider-assigned unique ID for this managed resource.
- json String
- output
Text String - security
Policy StringId - rule
Id Integer
- condition
Exception string - config
Id number - eval
Rule stringAction - id string
The provider-assigned unique ID for this managed resource.
- json string
- output
Text string - security
Policy stringId - rule
Id number
- condition_
exception str - config_
id int - eval_
rule_ straction - id str
The provider-assigned unique ID for this managed resource.
- json str
- output_
text str - security_
policy_ strid - rule_
id int
- condition
Exception String - config
Id Number - eval
Rule StringAction - id String
The provider-assigned unique ID for this managed resource.
- json String
- output
Text String - security
Policy StringId - rule
Id Number
Package Details
- Repository
- Akamai pulumi/pulumi-akamai
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
akamai
Terraform Provider.