network.frontdoor.azure.com/v1api20220501
APIVersion
Value | Description |
---|---|
“2022-05-01” |
WebApplicationFirewallPolicy
Generator information: - Generated from: /frontdoor/resource-manager/Microsoft.Network/stable/2022-05-01/webapplicationfirewall.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/FrontDoorWebApplicationFirewallPolicies/{policyName}
Used by: WebApplicationFirewallPolicyList.
Property | Description | Type |
---|---|---|
metav1.TypeMeta | ||
metav1.ObjectMeta | ||
spec | WebApplicationFirewallPolicy_Spec Optional |
|
status | WebApplicationFirewallPolicy_STATUS Optional |
WebApplicationFirewallPolicy_Spec
Property | Description | Type |
---|---|---|
azureName | The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. | string Optional |
customRules | Describes custom rules inside the policy. | CustomRuleList Optional |
etag | Gets a unique read-only string that changes whenever the resource is updated. | string Optional |
location | Resource location. | string Optional |
managedRules | Describes managed rules inside the policy. | ManagedRuleSetList Optional |
operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | WebApplicationFirewallPolicyOperatorSpec Optional |
owner | The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource | genruntime.KnownResourceReference Required |
policySettings | Describes settings for the policy. | PolicySettings Optional |
sku | The pricing tier of web application firewall policy. Defaults to Classic_AzureFrontDoor if not specified. | Sku Optional |
tags | Resource tags. | map[string]string Optional |
WebApplicationFirewallPolicy_STATUS
Property | Description | Type |
---|---|---|
conditions | The observed state of the resource | conditions.Condition[] Optional |
customRules | Describes custom rules inside the policy. | CustomRuleList_STATUS Optional |
etag | Gets a unique read-only string that changes whenever the resource is updated. | string Optional |
frontendEndpointLinks | Describes Frontend Endpoints associated with this Web Application Firewall policy. | FrontendEndpointLink_STATUS[] Optional |
id | Resource ID. | string Optional |
location | Resource location. | string Optional |
managedRules | Describes managed rules inside the policy. | ManagedRuleSetList_STATUS Optional |
name | Resource name. | string Optional |
policySettings | Describes settings for the policy. | PolicySettings_STATUS Optional |
provisioningState | Provisioning state of the policy. | string Optional |
resourceState | WebApplicationFirewallPolicyProperties_ResourceState_STATUS Optional |
|
routingRuleLinks | Describes Routing Rules associated with this Web Application Firewall policy. | RoutingRuleLink_STATUS[] Optional |
securityPolicyLinks | Describes Security Policy associated with this Web Application Firewall policy. | SecurityPolicyLink_STATUS[] Optional |
sku | The pricing tier of web application firewall policy. Defaults to Classic_AzureFrontDoor if not specified. | Sku_STATUS Optional |
tags | Resource tags. | map[string]string Optional |
type | Resource type. | string Optional |
WebApplicationFirewallPolicyList
Generator information: - Generated from: /frontdoor/resource-manager/Microsoft.Network/stable/2022-05-01/webapplicationfirewall.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/FrontDoorWebApplicationFirewallPolicies/{policyName}
Property | Description | Type |
---|---|---|
metav1.TypeMeta | ||
metav1.ListMeta | ||
items | WebApplicationFirewallPolicy[] Optional |
WebApplicationFirewallPolicy_Spec
Used by: WebApplicationFirewallPolicy.
Property | Description | Type |
---|---|---|
azureName | The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. | string Optional |
customRules | Describes custom rules inside the policy. | CustomRuleList Optional |
etag | Gets a unique read-only string that changes whenever the resource is updated. | string Optional |
location | Resource location. | string Optional |
managedRules | Describes managed rules inside the policy. | ManagedRuleSetList Optional |
operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | WebApplicationFirewallPolicyOperatorSpec Optional |
owner | The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource | genruntime.KnownResourceReference Required |
policySettings | Describes settings for the policy. | PolicySettings Optional |
sku | The pricing tier of web application firewall policy. Defaults to Classic_AzureFrontDoor if not specified. | Sku Optional |
tags | Resource tags. | map[string]string Optional |
WebApplicationFirewallPolicy_STATUS
Used by: WebApplicationFirewallPolicy.
Property | Description | Type |
---|---|---|
conditions | The observed state of the resource | conditions.Condition[] Optional |
customRules | Describes custom rules inside the policy. | CustomRuleList_STATUS Optional |
etag | Gets a unique read-only string that changes whenever the resource is updated. | string Optional |
frontendEndpointLinks | Describes Frontend Endpoints associated with this Web Application Firewall policy. | FrontendEndpointLink_STATUS[] Optional |
id | Resource ID. | string Optional |
location | Resource location. | string Optional |
managedRules | Describes managed rules inside the policy. | ManagedRuleSetList_STATUS Optional |
name | Resource name. | string Optional |
policySettings | Describes settings for the policy. | PolicySettings_STATUS Optional |
provisioningState | Provisioning state of the policy. | string Optional |
resourceState | WebApplicationFirewallPolicyProperties_ResourceState_STATUS Optional |
|
routingRuleLinks | Describes Routing Rules associated with this Web Application Firewall policy. | RoutingRuleLink_STATUS[] Optional |
securityPolicyLinks | Describes Security Policy associated with this Web Application Firewall policy. | SecurityPolicyLink_STATUS[] Optional |
sku | The pricing tier of web application firewall policy. Defaults to Classic_AzureFrontDoor if not specified. | Sku_STATUS Optional |
tags | Resource tags. | map[string]string Optional |
type | Resource type. | string Optional |
CustomRuleList
Defines contents of custom rules
Used by: WebApplicationFirewallPolicy_Spec.
Property | Description | Type |
---|---|---|
rules | List of rules | CustomRule[] Optional |
CustomRuleList_STATUS
Defines contents of custom rules
Used by: WebApplicationFirewallPolicy_STATUS.
Property | Description | Type |
---|---|---|
rules | List of rules | CustomRule_STATUS[] Optional |
FrontendEndpointLink_STATUS
Defines the Resource ID for a Frontend Endpoint.
Used by: WebApplicationFirewallPolicy_STATUS.
Property | Description | Type |
---|---|---|
id | Resource ID. | string Optional |
ManagedRuleSetList
Defines the list of managed rule sets for the policy.
Used by: WebApplicationFirewallPolicy_Spec.
Property | Description | Type |
---|---|---|
managedRuleSets | List of rule sets. | ManagedRuleSet[] Optional |
ManagedRuleSetList_STATUS
Defines the list of managed rule sets for the policy.
Used by: WebApplicationFirewallPolicy_STATUS.
Property | Description | Type |
---|---|---|
managedRuleSets | List of rule sets. | ManagedRuleSet_STATUS[] Optional |
PolicySettings
Defines top-level WebApplicationFirewallPolicy configuration settings.
Used by: WebApplicationFirewallPolicy_Spec.
Property | Description | Type |
---|---|---|
customBlockResponseBody | If the action type is block, customer can override the response body. The body must be specified in base64 encoding. | string Optional |
customBlockResponseStatusCode | If the action type is block, customer can override the response status code. | int Optional |
enabledState | Describes if the policy is in enabled or disabled state. Defaults to Enabled if not specified. | PolicySettings_EnabledState Optional |
mode | Describes if it is in detection mode or prevention mode at policy level. | PolicySettings_Mode Optional |
redirectUrl | If action type is redirect, this field represents redirect URL for the client. | string Optional |
requestBodyCheck | Describes if policy managed rules will inspect the request body content. | PolicySettings_RequestBodyCheck Optional |
PolicySettings_STATUS
Defines top-level WebApplicationFirewallPolicy configuration settings.
Used by: WebApplicationFirewallPolicy_STATUS.
Property | Description | Type |
---|---|---|
customBlockResponseBody | If the action type is block, customer can override the response body. The body must be specified in base64 encoding. | string Optional |
customBlockResponseStatusCode | If the action type is block, customer can override the response status code. | int Optional |
enabledState | Describes if the policy is in enabled or disabled state. Defaults to Enabled if not specified. | PolicySettings_EnabledState_STATUS Optional |
mode | Describes if it is in detection mode or prevention mode at policy level. | PolicySettings_Mode_STATUS Optional |
redirectUrl | If action type is redirect, this field represents redirect URL for the client. | string Optional |
requestBodyCheck | Describes if policy managed rules will inspect the request body content. | PolicySettings_RequestBodyCheck_STATUS Optional |
RoutingRuleLink_STATUS
Defines the Resource ID for a Routing Rule.
Used by: WebApplicationFirewallPolicy_STATUS.
Property | Description | Type |
---|---|---|
id | Resource ID. | string Optional |
SecurityPolicyLink_STATUS
Defines the Resource ID for a Security Policy.
Used by: WebApplicationFirewallPolicy_STATUS.
Property | Description | Type |
---|---|---|
id | Resource ID. | string Optional |
Sku
The pricing tier of the web application firewall policy.
Used by: WebApplicationFirewallPolicy_Spec.
Property | Description | Type |
---|---|---|
name | Name of the pricing tier. | Sku_Name Optional |
Sku_STATUS
The pricing tier of the web application firewall policy.
Used by: WebApplicationFirewallPolicy_STATUS.
Property | Description | Type |
---|---|---|
name | Name of the pricing tier. | Sku_Name_STATUS Optional |
WebApplicationFirewallPolicyOperatorSpec
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Used by: WebApplicationFirewallPolicy_Spec.
Property | Description | Type |
---|---|---|
configMapExpressions | configures where to place operator written dynamic ConfigMaps (created with CEL expressions). | core.DestinationExpression[] Optional |
secretExpressions | configures where to place operator written dynamic secrets (created with CEL expressions). | core.DestinationExpression[] Optional |
WebApplicationFirewallPolicyProperties_ResourceState_STATUS
Used by: WebApplicationFirewallPolicy_STATUS.
Value | Description |
---|---|
“Creating” | |
“Deleting” | |
“Disabled” | |
“Disabling” | |
“Enabled” | |
“Enabling” |
CustomRule
Defines contents of a web application rule
Used by: CustomRuleList.
Property | Description | Type |
---|---|---|
action | Describes what action to be applied when rule matches. | ActionType Required |
enabledState | Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified. | CustomRule_EnabledState Optional |
matchConditions | List of match conditions. | MatchCondition[] Required |
name | Describes the name of the rule. | string Optional |
priority | Describes priority of the rule. Rules with a lower value will be evaluated before rules with a higher value. | int Required |
rateLimitDurationInMinutes | Time window for resetting the rate limit count. Default is 1 minute. | int Optional |
rateLimitThreshold | Number of allowed requests per client within the time window. | int Optional |
ruleType | Describes type of rule. | CustomRule_RuleType Required |
CustomRule_STATUS
Defines contents of a web application rule
Used by: CustomRuleList_STATUS.
Property | Description | Type |
---|---|---|
action | Describes what action to be applied when rule matches. | ActionType_STATUS Optional |
enabledState | Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified. | CustomRule_EnabledState_STATUS Optional |
matchConditions | List of match conditions. | MatchCondition_STATUS[] Optional |
name | Describes the name of the rule. | string Optional |
priority | Describes priority of the rule. Rules with a lower value will be evaluated before rules with a higher value. | int Optional |
rateLimitDurationInMinutes | Time window for resetting the rate limit count. Default is 1 minute. | int Optional |
rateLimitThreshold | Number of allowed requests per client within the time window. | int Optional |
ruleType | Describes type of rule. | CustomRule_RuleType_STATUS Optional |
ManagedRuleSet
Defines a managed rule set.
Used by: ManagedRuleSetList.
Property | Description | Type |
---|---|---|
exclusions | Describes the exclusions that are applied to all rules in the set. | ManagedRuleExclusion[] Optional |
ruleGroupOverrides | Defines the rule group overrides to apply to the rule set. | ManagedRuleGroupOverride[] Optional |
ruleSetAction | Defines the rule set action. | ManagedRuleSetActionType Optional |
ruleSetType | Defines the rule set type to use. | string Required |
ruleSetVersion | Defines the version of the rule set to use. | string Required |
ManagedRuleSet_STATUS
Defines a managed rule set.
Used by: ManagedRuleSetList_STATUS.
Property | Description | Type |
---|---|---|
exclusions | Describes the exclusions that are applied to all rules in the set. | ManagedRuleExclusion_STATUS[] Optional |
ruleGroupOverrides | Defines the rule group overrides to apply to the rule set. | ManagedRuleGroupOverride_STATUS[] Optional |
ruleSetAction | Defines the rule set action. | ManagedRuleSetActionType_STATUS Optional |
ruleSetType | Defines the rule set type to use. | string Optional |
ruleSetVersion | Defines the version of the rule set to use. | string Optional |
PolicySettings_EnabledState
Used by: PolicySettings.
Value | Description |
---|---|
“Disabled” | |
“Enabled” |
PolicySettings_EnabledState_STATUS
Used by: PolicySettings_STATUS.
Value | Description |
---|---|
“Disabled” | |
“Enabled” |
PolicySettings_Mode
Used by: PolicySettings.
Value | Description |
---|---|
“Detection” | |
“Prevention” |
PolicySettings_Mode_STATUS
Used by: PolicySettings_STATUS.
Value | Description |
---|---|
“Detection” | |
“Prevention” |
PolicySettings_RequestBodyCheck
Used by: PolicySettings.
Value | Description |
---|---|
“Disabled” | |
“Enabled” |
PolicySettings_RequestBodyCheck_STATUS
Used by: PolicySettings_STATUS.
Value | Description |
---|---|
“Disabled” | |
“Enabled” |
Sku_Name
Used by: Sku.
Value | Description |
---|---|
“Classic_AzureFrontDoor” | |
“Premium_AzureFrontDoor” | |
“Standard_AzureFrontDoor” |
Sku_Name_STATUS
Used by: Sku_STATUS.
Value | Description |
---|---|
“Classic_AzureFrontDoor” | |
“Premium_AzureFrontDoor” | |
“Standard_AzureFrontDoor” |
ActionType
Defines the action to take on rule match.
Used by: CustomRule, and ManagedRuleOverride.
Value | Description |
---|---|
“Allow” | |
“AnomalyScoring” | |
“Block” | |
“Log” | |
“Redirect” |
ActionType_STATUS
Defines the action to take on rule match.
Used by: CustomRule_STATUS, and ManagedRuleOverride_STATUS.
Value | Description |
---|---|
“Allow” | |
“AnomalyScoring” | |
“Block” | |
“Log” | |
“Redirect” |
CustomRule_EnabledState
Used by: CustomRule.
Value | Description |
---|---|
“Disabled” | |
“Enabled” |
CustomRule_EnabledState_STATUS
Used by: CustomRule_STATUS.
Value | Description |
---|---|
“Disabled” | |
“Enabled” |
CustomRule_RuleType
Used by: CustomRule.
Value | Description |
---|---|
“MatchRule” | |
“RateLimitRule” |
CustomRule_RuleType_STATUS
Used by: CustomRule_STATUS.
Value | Description |
---|---|
“MatchRule” | |
“RateLimitRule” |
ManagedRuleExclusion
Exclude variables from managed rule evaluation.
Used by: ManagedRuleGroupOverride, ManagedRuleOverride, and ManagedRuleSet.
Property | Description | Type |
---|---|---|
matchVariable | The variable type to be excluded. | ManagedRuleExclusion_MatchVariable Required |
selector | Selector value for which elements in the collection this exclusion applies to. | string Required |
selectorMatchOperator | Comparison operator to apply to the selector when specifying which elements in the collection this exclusion applies to. | ManagedRuleExclusion_SelectorMatchOperator Required |
ManagedRuleExclusion_STATUS
Exclude variables from managed rule evaluation.
Used by: ManagedRuleGroupOverride_STATUS, ManagedRuleOverride_STATUS, and ManagedRuleSet_STATUS.
Property | Description | Type |
---|---|---|
matchVariable | The variable type to be excluded. | ManagedRuleExclusion_MatchVariable_STATUS Optional |
selector | Selector value for which elements in the collection this exclusion applies to. | string Optional |
selectorMatchOperator | Comparison operator to apply to the selector when specifying which elements in the collection this exclusion applies to. | ManagedRuleExclusion_SelectorMatchOperator_STATUS Optional |
ManagedRuleGroupOverride
Defines a managed rule group override setting.
Used by: ManagedRuleSet.
Property | Description | Type |
---|---|---|
exclusions | Describes the exclusions that are applied to all rules in the group. | ManagedRuleExclusion[] Optional |
ruleGroupName | Describes the managed rule group to override. | string Required |
rules | List of rules that will be disabled. If none specified, all rules in the group will be disabled. | ManagedRuleOverride[] Optional |
ManagedRuleGroupOverride_STATUS
Defines a managed rule group override setting.
Used by: ManagedRuleSet_STATUS.
Property | Description | Type |
---|---|---|
exclusions | Describes the exclusions that are applied to all rules in the group. | ManagedRuleExclusion_STATUS[] Optional |
ruleGroupName | Describes the managed rule group to override. | string Optional |
rules | List of rules that will be disabled. If none specified, all rules in the group will be disabled. | ManagedRuleOverride_STATUS[] Optional |
ManagedRuleSetActionType
Defines the action to take when a managed rule set score threshold is met.
Used by: ManagedRuleSet.
Value | Description |
---|---|
“Block” | |
“Log” | |
“Redirect” |
ManagedRuleSetActionType_STATUS
Defines the action to take when a managed rule set score threshold is met.
Used by: ManagedRuleSet_STATUS.
Value | Description |
---|---|
“Block” | |
“Log” | |
“Redirect” |
MatchCondition
Define a match condition.
Used by: CustomRule.
Property | Description | Type |
---|---|---|
matchValue | List of possible match values. | string[] Required |
matchVariable | Request variable to compare with. | MatchCondition_MatchVariable Required |
negateCondition | Describes if the result of this condition should be negated. | bool Optional |
operator | Comparison type to use for matching with the variable value. | MatchCondition_Operator Required |
selector | Match against a specific key from the QueryString, PostArgs, RequestHeader or Cookies variables. Default is null. | string Optional |
transforms | List of transforms. | TransformType[] Optional |
MatchCondition_STATUS
Define a match condition.
Used by: CustomRule_STATUS.
Property | Description | Type |
---|---|---|
matchValue | List of possible match values. | string[] Optional |
matchVariable | Request variable to compare with. | MatchCondition_MatchVariable_STATUS Optional |
negateCondition | Describes if the result of this condition should be negated. | bool Optional |
operator | Comparison type to use for matching with the variable value. | MatchCondition_Operator_STATUS Optional |
selector | Match against a specific key from the QueryString, PostArgs, RequestHeader or Cookies variables. Default is null. | string Optional |
transforms | List of transforms. | TransformType_STATUS[] Optional |
ManagedRuleExclusion_MatchVariable
Used by: ManagedRuleExclusion.
Value | Description |
---|---|
“QueryStringArgNames” | |
“RequestBodyJsonArgNames” | |
“RequestBodyPostArgNames” | |
“RequestCookieNames” | |
“RequestHeaderNames” |
ManagedRuleExclusion_MatchVariable_STATUS
Used by: ManagedRuleExclusion_STATUS.
Value | Description |
---|---|
“QueryStringArgNames” | |
“RequestBodyJsonArgNames” | |
“RequestBodyPostArgNames” | |
“RequestCookieNames” | |
“RequestHeaderNames” |
ManagedRuleExclusion_SelectorMatchOperator
Used by: ManagedRuleExclusion.
Value | Description |
---|---|
“Contains” | |
“EndsWith” | |
“Equals” | |
“EqualsAny” | |
“StartsWith” |
ManagedRuleExclusion_SelectorMatchOperator_STATUS
Used by: ManagedRuleExclusion_STATUS.
Value | Description |
---|---|
“Contains” | |
“EndsWith” | |
“Equals” | |
“EqualsAny” | |
“StartsWith” |
ManagedRuleOverride
Defines a managed rule group override setting.
Used by: ManagedRuleGroupOverride.
Property | Description | Type |
---|---|---|
action | Describes the override action to be applied when rule matches. | ActionType Optional |
enabledState | Describes if the managed rule is in enabled or disabled state. Defaults to Disabled if not specified. | ManagedRuleEnabledState Optional |
exclusions | Describes the exclusions that are applied to this specific rule. | ManagedRuleExclusion[] Optional |
ruleId | Identifier for the managed rule. | string Required |
ManagedRuleOverride_STATUS
Defines a managed rule group override setting.
Used by: ManagedRuleGroupOverride_STATUS.
Property | Description | Type |
---|---|---|
action | Describes the override action to be applied when rule matches. | ActionType_STATUS Optional |
enabledState | Describes if the managed rule is in enabled or disabled state. Defaults to Disabled if not specified. | ManagedRuleEnabledState_STATUS Optional |
exclusions | Describes the exclusions that are applied to this specific rule. | ManagedRuleExclusion_STATUS[] Optional |
ruleId | Identifier for the managed rule. | string Optional |
MatchCondition_MatchVariable
Used by: MatchCondition.
Value | Description |
---|---|
“Cookies” | |
“PostArgs” | |
“QueryString” | |
“RemoteAddr” | |
“RequestBody” | |
“RequestHeader” | |
“RequestMethod” | |
“RequestUri” | |
“SocketAddr” |
MatchCondition_MatchVariable_STATUS
Used by: MatchCondition_STATUS.
Value | Description |
---|---|
“Cookies” | |
“PostArgs” | |
“QueryString” | |
“RemoteAddr” | |
“RequestBody” | |
“RequestHeader” | |
“RequestMethod” | |
“RequestUri” | |
“SocketAddr” |
MatchCondition_Operator
Used by: MatchCondition.
Value | Description |
---|---|
“Any” | |
“BeginsWith” | |
“Contains” | |
“EndsWith” | |
“Equal” | |
“GeoMatch” | |
“GreaterThan” | |
“GreaterThanOrEqual” | |
“IPMatch” | |
“LessThan” | |
“LessThanOrEqual” | |
“RegEx” |
MatchCondition_Operator_STATUS
Used by: MatchCondition_STATUS.
Value | Description |
---|---|
“Any” | |
“BeginsWith” | |
“Contains” | |
“EndsWith” | |
“Equal” | |
“GeoMatch” | |
“GreaterThan” | |
“GreaterThanOrEqual” | |
“IPMatch” | |
“LessThan” | |
“LessThanOrEqual” | |
“RegEx” |
TransformType
Describes what transforms applied before matching.
Used by: MatchCondition.
Value | Description |
---|---|
“Lowercase” | |
“RemoveNulls” | |
“Trim” | |
“Uppercase” | |
“UrlDecode” | |
“UrlEncode” |
TransformType_STATUS
Describes what transforms applied before matching.
Used by: MatchCondition_STATUS.
Value | Description |
---|---|
“Lowercase” | |
“RemoveNulls” | |
“Trim” | |
“Uppercase” | |
“UrlDecode” | |
“UrlEncode” |
ManagedRuleEnabledState
Describes if the managed rule is in enabled or disabled state.
Used by: ManagedRuleOverride.
Value | Description |
---|---|
“Disabled” | |
“Enabled” |
ManagedRuleEnabledState_STATUS
Describes if the managed rule is in enabled or disabled state.
Used by: ManagedRuleOverride_STATUS.
Value | Description |
---|---|
“Disabled” | |
“Enabled” |