Rate policy actions

Set-AppSecPolicyRatePolicy

Synopsis

Modify a rate policy action.

Syntax

configname-policyname (Default)

Set-AppSecPolicyRatePolicy [-ConfigName] <String> [-VersionNumber] <String> [-PolicyName] <String>
 -RatePolicyID <Int32> -IPv4Action <String> -IPv6Action <String> [-EdgeRCFile <String>] [-Section <String>]
 [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

configname-policyid

Set-AppSecPolicyRatePolicy [-ConfigName] <String> [-VersionNumber] <String> -PolicyID <String>
 -RatePolicyID <Int32> -IPv4Action <String> -IPv6Action <String> [-EdgeRCFile <String>] [-Section <String>]
 [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

configid-policyid

Set-AppSecPolicyRatePolicy -ConfigID <Int32> [-VersionNumber] <String> -PolicyID <String> -RatePolicyID <Int32>
 -IPv4Action <String> -IPv6Action <String> [-EdgeRCFile <String>] [-Section <String>]
 [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

configid-policyname

Set-AppSecPolicyRatePolicy -ConfigID <Int32> [-VersionNumber] <String> [-PolicyName] <String>
 -RatePolicyID <Int32> -IPv4Action <String> -IPv6Action <String> [-EdgeRCFile <String>] [-Section <String>]
 [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Updates the actions in a rate policy. When making a request, you can specify a configuration with the -ConfigName or -ConfigID parameter. The -VersionNumber parameter is an integer or the word latest. To specify a policy, use the -PolicyName or -PolicyID parameter.

Parameters

-AccountSwitchKey

Account switch key, for use when you have access to multiple accounts and need to specify which one to use. Account switch keys can be found using Get-AccountSwitchKey.

Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ConfigID

An ID for each configuration.

Type: Int32
Parameter Sets: configid-policyid, configid-policyname
Aliases: None
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ConfigName

The name of the security configuration.

Type: String
Parameter Sets: configname-policyname, configname-policyid
Aliases: None
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-EdgeRCFile

EdgeRC file to authenticate your command. Defaults to ~/.edgerc.

Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-IPv4Action

The IPv4 action to assign to this rate policy.

For BOTMAN policies, choose monitor, delay, slow, deny, tarpit, none, or a custom action.
For WAF policies, choose alert, deny, or none.
Or use deny_custom_{custom_deny_id} to apply a custom action to your WAF rate policy.

If the action is none, the rate policy is inactive in the policy.

Type: String
Parameter Sets: (All)
Aliases:
Accepted values: alert, deny, none

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-IPv6Action

The IPv6 action to assign to this rate policy.

For BOTMAN policies, specify the same action you chose for ipv4Action.
For WAF policies, choose alert, deny, or none.
Or use deny_custom_{custom_deny_id} to apply a custom action to your WAF rate policy. Run Set-AppSecCustomDenyAction to manage your custom deny actions.

If the action is none, the rate policy is inactive in the policy.

Type: String
Parameter Sets: (All)
Aliases:
Accepted values: alert, deny, none

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PolicyID

An ID for a security policy.

Type: String
Parameter Sets: configname-policyid, configid-policyid
Aliases: None
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PolicyName

The name of the security policy.

Type: String
Parameter Sets: configname-policyname, configid-policyname
Aliases: None
Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-RatePolicyID

An ID for each rate policy.

Type: Int32
Parameter Sets: (All)
Aliases: None
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Section

EdgeRC section to retrieve authentication credentials from. Defaults to default.

Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-VersionNumber

An ID for each version of a configuration. Can be an integer or the word latest.

Type: String
Parameter Sets: (All)
Aliases: None
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

None

Outputs

System.Object