network.azure.com/v1api20240101
network.azure.com/v1api20240101
Package v1api20240101 contains API Schema definitions for the network v1api20240101 API group
APIVersion
(string
alias)
Value | Description |
---|---|
"2024-01-01" |
ActionType
(string
alias)
(Appears on:ManagedRuleOverride)
Defines the action to take on rule match.
Value | Description |
---|---|
"Allow" |
|
"AnomalyScoring" |
|
"Block" |
|
"JSChallenge" |
|
"Log" |
ActionType_STATUS
(string
alias)
(Appears on:ManagedRuleOverride_STATUS)
Defines the action to take on rule match.
Value | Description |
---|---|
"Allow" |
|
"AnomalyScoring" |
|
"Block" |
|
"JSChallenge" |
|
"Log" |
ApplicationGateway_STATUS_ApplicationGatewayWebApplicationFirewallPolicy_SubResourceEmbedded
(Appears on:WebApplicationFirewallPolicy_STATUS)
Application gateway resource.
Field | Description |
---|---|
id string |
Id: Resource ID. |
ApplicationSecurityGroup
Generator information: - Generated from: /network/resource-manager/Microsoft.Network/stable/2024-01-01/applicationSecurityGroup.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationSecurityGroups/{applicationSecurityGroupName}p>
Field | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||
spec ApplicationSecurityGroup_Spec |
|
||||||||||
status ApplicationSecurityGroup_STATUS |
ApplicationSecurityGroupOperatorSpec
(Appears on:ApplicationSecurityGroup_Spec)
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Field | Description |
---|---|
configMapExpressions []genruntime/core.DestinationExpression |
ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions). |
secretExpressions []genruntime/core.DestinationExpression |
SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions). |
ApplicationSecurityGroup_STATUS
(Appears on:ApplicationSecurityGroup)
An application security group in a resource group.
Field | Description |
---|---|
conditions []genruntime/conditions.Condition |
Conditions: The observed state of the resource |
etag string |
Etag: A unique read-only string that changes whenever the resource is updated. |
id string |
Id: Resource ID. |
location string |
Location: Resource location. |
name string |
Name: Resource name. |
provisioningState ProvisioningState_STATUS |
ProvisioningState: The provisioning state of the application security group resource. |
resourceGuid string |
ResourceGuid: The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. |
tags map[string]string |
Tags: Resource tags. |
type string |
Type: Resource type. |
ApplicationSecurityGroup_Spec
(Appears on:ApplicationSecurityGroup)
Field | Description |
---|---|
azureName string |
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. |
location string |
Location: Resource location. |
operatorSpec ApplicationSecurityGroupOperatorSpec |
OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure |
owner genruntime.KnownResourceReference |
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 |
tags map[string]string |
Tags: Resource tags. |
ExclusionManagedRule
(Appears on:ExclusionManagedRuleGroup)
Defines a managed rule to use for exclusion.
Field | Description |
---|---|
ruleId string |
RuleId: Identifier for the managed rule. |
ExclusionManagedRuleGroup
(Appears on:ExclusionManagedRuleSet)
Defines a managed rule group to use for exclusion.
Field | Description |
---|---|
ruleGroupName string |
RuleGroupName: The managed rule group for exclusion. |
rules []ExclusionManagedRule |
Rules: List of rules that will be excluded. If none specified, all rules in the group will be excluded. |
ExclusionManagedRuleGroup_STATUS
(Appears on:ExclusionManagedRuleSet_STATUS)
Defines a managed rule group to use for exclusion.
Field | Description |
---|---|
ruleGroupName string |
RuleGroupName: The managed rule group for exclusion. |
rules []ExclusionManagedRule_STATUS |
Rules: List of rules that will be excluded. If none specified, all rules in the group will be excluded. |
ExclusionManagedRuleSet
(Appears on:OwaspCrsExclusionEntry)
Defines a managed rule set for Exclusions.
Field | Description |
---|---|
ruleGroups []ExclusionManagedRuleGroup |
RuleGroups: Defines the rule groups to apply to the rule set. |
ruleSetType string |
RuleSetType: Defines the rule set type to use. |
ruleSetVersion string |
RuleSetVersion: Defines the version of the rule set to use. |
ExclusionManagedRuleSet_STATUS
(Appears on:OwaspCrsExclusionEntry_STATUS)
Defines a managed rule set for Exclusions.
Field | Description |
---|---|
ruleGroups []ExclusionManagedRuleGroup_STATUS |
RuleGroups: Defines the rule groups to apply to the rule set. |
ruleSetType string |
RuleSetType: Defines the rule set type to use. |
ruleSetVersion string |
RuleSetVersion: Defines the version of the rule set to use. |
ExclusionManagedRule_STATUS
(Appears on:ExclusionManagedRuleGroup_STATUS)
Defines a managed rule to use for exclusion.
Field | Description |
---|---|
ruleId string |
RuleId: Identifier for the managed rule. |
GroupByUserSession
(Appears on:WebApplicationFirewallCustomRule)
Define user session identifier group by clauses.
Field | Description |
---|---|
groupByVariables []GroupByVariable |
GroupByVariables: List of group by clause variables. |
GroupByUserSession_STATUS
(Appears on:WebApplicationFirewallCustomRule_STATUS)
Define user session identifier group by clauses.
Field | Description |
---|---|
groupByVariables []GroupByVariable_STATUS |
GroupByVariables: List of group by clause variables. |
GroupByVariable
(Appears on:GroupByUserSession)
Define user session group by clause variables.
Field | Description |
---|---|
variableName GroupByVariable_VariableName |
VariableName: User Session clause variable. |
GroupByVariable_STATUS
(Appears on:GroupByUserSession_STATUS)
Define user session group by clause variables.
Field | Description |
---|---|
variableName GroupByVariable_VariableName_STATUS |
VariableName: User Session clause variable. |
GroupByVariable_VariableName
(string
alias)
(Appears on:GroupByVariable)
Value | Description |
---|---|
"ClientAddr" |
|
"GeoLocation" |
|
"None" |
GroupByVariable_VariableName_STATUS
(string
alias)
(Appears on:GroupByVariable_STATUS)
Value | Description |
---|---|
"ClientAddr" |
|
"GeoLocation" |
|
"None" |
ManagedRuleGroupOverride
(Appears on:ManagedRuleSet)
Defines a managed rule group override setting.
Field | Description |
---|---|
ruleGroupName string |
RuleGroupName: The managed rule group to override. |
rules []ManagedRuleOverride |
Rules: List of rules that will be disabled. If none specified, all rules in the group will be disabled. |
ManagedRuleGroupOverride_STATUS
(Appears on:ManagedRuleSet_STATUS)
Defines a managed rule group override setting.
Field | Description |
---|---|
ruleGroupName string |
RuleGroupName: The managed rule group to override. |
rules []ManagedRuleOverride_STATUS |
Rules: List of rules that will be disabled. If none specified, all rules in the group will be disabled. |
ManagedRuleOverride
(Appears on:ManagedRuleGroupOverride)
Defines a managed rule group override setting.
Field | Description |
---|---|
action ActionType |
Action: Describes the override action to be applied when rule matches. |
ruleId string |
RuleId: Identifier for the managed rule. |
state ManagedRuleOverride_State |
State: The state of the managed rule. Defaults to Disabled if not specified. |
ManagedRuleOverride_STATUS
(Appears on:ManagedRuleGroupOverride_STATUS)
Defines a managed rule group override setting.
Field | Description |
---|---|
action ActionType_STATUS |
Action: Describes the override action to be applied when rule matches. |
ruleId string |
RuleId: Identifier for the managed rule. |
state ManagedRuleOverride_State_STATUS |
State: The state of the managed rule. Defaults to Disabled if not specified. |
ManagedRuleOverride_State
(string
alias)
(Appears on:ManagedRuleOverride)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
ManagedRuleOverride_State_STATUS
(string
alias)
(Appears on:ManagedRuleOverride_STATUS)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
ManagedRuleSet
(Appears on:ManagedRulesDefinition)
Defines a managed rule set.
Field | Description |
---|---|
ruleGroupOverrides []ManagedRuleGroupOverride |
RuleGroupOverrides: Defines the rule group overrides to apply to the rule set. |
ruleSetType string |
RuleSetType: Defines the rule set type to use. |
ruleSetVersion string |
RuleSetVersion: Defines the version of the rule set to use. |
ManagedRuleSet_STATUS
(Appears on:ManagedRulesDefinition_STATUS)
Defines a managed rule set.
Field | Description |
---|---|
ruleGroupOverrides []ManagedRuleGroupOverride_STATUS |
RuleGroupOverrides: Defines the rule group overrides to apply to the rule set. |
ruleSetType string |
RuleSetType: Defines the rule set type to use. |
ruleSetVersion string |
RuleSetVersion: Defines the version of the rule set to use. |
ManagedRulesDefinition
(Appears on:WebApplicationFirewallPolicy_Spec)
Allow to exclude some variable satisfy the condition for the WAF check.
Field | Description |
---|---|
exclusions []OwaspCrsExclusionEntry |
Exclusions: The Exclusions that are applied on the policy. |
managedRuleSets []ManagedRuleSet |
ManagedRuleSets: The managed rule sets that are associated with the policy. |
ManagedRulesDefinition_STATUS
(Appears on:WebApplicationFirewallPolicy_STATUS)
Allow to exclude some variable satisfy the condition for the WAF check.
Field | Description |
---|---|
exclusions []OwaspCrsExclusionEntry_STATUS |
Exclusions: The Exclusions that are applied on the policy. |
managedRuleSets []ManagedRuleSet_STATUS |
ManagedRuleSets: The managed rule sets that are associated with the policy. |
MatchCondition
(Appears on:WebApplicationFirewallCustomRule)
Define match conditions.
Field | Description |
---|---|
matchValues []string |
MatchValues: Match value. |
matchVariables []MatchVariable |
MatchVariables: List of match variables. |
negationConditon bool |
NegationConditon: Whether this is negate condition or not. |
operator MatchCondition_Operator |
Operator: The operator to be matched. |
transforms []Transform |
Transforms: List of transforms. |
MatchCondition_Operator
(string
alias)
(Appears on:MatchCondition)
Value | Description |
---|---|
"Any" |
|
"BeginsWith" |
|
"Contains" |
|
"EndsWith" |
|
"Equal" |
|
"GeoMatch" |
|
"GreaterThan" |
|
"GreaterThanOrEqual" |
|
"IPMatch" |
|
"LessThan" |
|
"LessThanOrEqual" |
|
"Regex" |
MatchCondition_Operator_STATUS
(string
alias)
(Appears on:MatchCondition_STATUS)
Value | Description |
---|---|
"Any" |
|
"BeginsWith" |
|
"Contains" |
|
"EndsWith" |
|
"Equal" |
|
"GeoMatch" |
|
"GreaterThan" |
|
"GreaterThanOrEqual" |
|
"IPMatch" |
|
"LessThan" |
|
"LessThanOrEqual" |
|
"Regex" |
MatchCondition_STATUS
(Appears on:WebApplicationFirewallCustomRule_STATUS)
Define match conditions.
Field | Description |
---|---|
matchValues []string |
MatchValues: Match value. |
matchVariables []MatchVariable_STATUS |
MatchVariables: List of match variables. |
negationConditon bool |
NegationConditon: Whether this is negate condition or not. |
operator MatchCondition_Operator_STATUS |
Operator: The operator to be matched. |
transforms []Transform_STATUS |
Transforms: List of transforms. |
MatchVariable
(Appears on:MatchCondition)
Define match variables.
Field | Description |
---|---|
selector string |
Selector: The selector of match variable. |
variableName MatchVariable_VariableName |
VariableName: Match Variable. |
MatchVariable_STATUS
(Appears on:MatchCondition_STATUS)
Define match variables.
Field | Description |
---|---|
selector string |
Selector: The selector of match variable. |
variableName MatchVariable_VariableName_STATUS |
VariableName: Match Variable. |
MatchVariable_VariableName
(string
alias)
(Appears on:MatchVariable)
Value | Description |
---|---|
"PostArgs" |
|
"QueryString" |
|
"RemoteAddr" |
|
"RequestBody" |
|
"RequestCookies" |
|
"RequestHeaders" |
|
"RequestMethod" |
|
"RequestUri" |
MatchVariable_VariableName_STATUS
(string
alias)
(Appears on:MatchVariable_STATUS)
Value | Description |
---|---|
"PostArgs" |
|
"QueryString" |
|
"RemoteAddr" |
|
"RequestBody" |
|
"RequestCookies" |
|
"RequestHeaders" |
|
"RequestMethod" |
|
"RequestUri" |
OwaspCrsExclusionEntry
(Appears on:ManagedRulesDefinition)
Allow to exclude some variable satisfy the condition for the WAF check.
Field | Description |
---|---|
exclusionManagedRuleSets []ExclusionManagedRuleSet |
ExclusionManagedRuleSets: The managed rule sets that are associated with the exclusion. |
matchVariable OwaspCrsExclusionEntry_MatchVariable |
MatchVariable: The variable to be excluded. |
selector string |
Selector: When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to. |
selectorMatchOperator OwaspCrsExclusionEntry_SelectorMatchOperator |
SelectorMatchOperator: When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to. |
OwaspCrsExclusionEntry_MatchVariable
(string
alias)
(Appears on:OwaspCrsExclusionEntry)
Value | Description |
---|---|
"RequestArgKeys" |
|
"RequestArgNames" |
|
"RequestArgValues" |
|
"RequestCookieKeys" |
|
"RequestCookieNames" |
|
"RequestCookieValues" |
|
"RequestHeaderKeys" |
|
"RequestHeaderNames" |
|
"RequestHeaderValues" |
OwaspCrsExclusionEntry_MatchVariable_STATUS
(string
alias)
(Appears on:OwaspCrsExclusionEntry_STATUS)
Value | Description |
---|---|
"RequestArgKeys" |
|
"RequestArgNames" |
|
"RequestArgValues" |
|
"RequestCookieKeys" |
|
"RequestCookieNames" |
|
"RequestCookieValues" |
|
"RequestHeaderKeys" |
|
"RequestHeaderNames" |
|
"RequestHeaderValues" |
OwaspCrsExclusionEntry_STATUS
(Appears on:ManagedRulesDefinition_STATUS)
Allow to exclude some variable satisfy the condition for the WAF check.
Field | Description |
---|---|
exclusionManagedRuleSets []ExclusionManagedRuleSet_STATUS |
ExclusionManagedRuleSets: The managed rule sets that are associated with the exclusion. |
matchVariable OwaspCrsExclusionEntry_MatchVariable_STATUS |
MatchVariable: The variable to be excluded. |
selector string |
Selector: When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to. |
selectorMatchOperator OwaspCrsExclusionEntry_SelectorMatchOperator_STATUS |
SelectorMatchOperator: When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to. |
OwaspCrsExclusionEntry_SelectorMatchOperator
(string
alias)
(Appears on:OwaspCrsExclusionEntry)
Value | Description |
---|---|
"Contains" |
|
"EndsWith" |
|
"Equals" |
|
"EqualsAny" |
|
"StartsWith" |
OwaspCrsExclusionEntry_SelectorMatchOperator_STATUS
(string
alias)
(Appears on:OwaspCrsExclusionEntry_STATUS)
Value | Description |
---|---|
"Contains" |
|
"EndsWith" |
|
"Equals" |
|
"EqualsAny" |
|
"StartsWith" |
PolicySettings
(Appears on:WebApplicationFirewallPolicy_Spec)
Defines contents of a web application firewall global configuration.
Field | Description |
---|---|
customBlockResponseBody string |
CustomBlockResponseBody: If the action type is block, customer can override the response body. The body must be specified in base64 encoding. |
customBlockResponseStatusCode int |
CustomBlockResponseStatusCode: If the action type is block, customer can override the response status code. |
fileUploadEnforcement bool |
FileUploadEnforcement: Whether allow WAF to enforce file upload limits. |
fileUploadLimitInMb int |
FileUploadLimitInMb: Maximum file upload size in Mb for WAF. |
jsChallengeCookieExpirationInMins int |
JsChallengeCookieExpirationInMins: Web Application Firewall JavaScript Challenge Cookie Expiration time in minutes. |
logScrubbing PolicySettings_LogScrubbing |
LogScrubbing: To scrub sensitive log fields |
maxRequestBodySizeInKb int |
MaxRequestBodySizeInKb: Maximum request body size in Kb for WAF. |
mode PolicySettings_Mode |
Mode: The mode of the policy. |
requestBodyCheck bool |
RequestBodyCheck: Whether to allow WAF to check request Body. |
requestBodyEnforcement bool |
RequestBodyEnforcement: Whether allow WAF to enforce request body limits. |
requestBodyInspectLimitInKB int |
RequestBodyInspectLimitInKB: Max inspection limit in KB for request body inspection for WAF. |
state PolicySettings_State |
State: The state of the policy. |
PolicySettings_LogScrubbing
(Appears on:PolicySettings)
Field | Description |
---|---|
scrubbingRules []WebApplicationFirewallScrubbingRules |
ScrubbingRules: The rules that are applied to the logs for scrubbing. |
state PolicySettings_LogScrubbing_State |
State: State of the log scrubbing config. Default value is Enabled. |
PolicySettings_LogScrubbing_STATUS
(Appears on:PolicySettings_STATUS)
Field | Description |
---|---|
scrubbingRules []WebApplicationFirewallScrubbingRules_STATUS |
ScrubbingRules: The rules that are applied to the logs for scrubbing. |
state PolicySettings_LogScrubbing_State_STATUS |
State: State of the log scrubbing config. Default value is Enabled. |
PolicySettings_LogScrubbing_State
(string
alias)
(Appears on:PolicySettings_LogScrubbing)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
PolicySettings_LogScrubbing_State_STATUS
(string
alias)
(Appears on:PolicySettings_LogScrubbing_STATUS)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
PolicySettings_Mode
(string
alias)
(Appears on:PolicySettings)
Value | Description |
---|---|
"Detection" |
|
"Prevention" |
PolicySettings_Mode_STATUS
(string
alias)
(Appears on:PolicySettings_STATUS)
Value | Description |
---|---|
"Detection" |
|
"Prevention" |
PolicySettings_STATUS
(Appears on:WebApplicationFirewallPolicy_STATUS)
Defines contents of a web application firewall global configuration.
Field | Description |
---|---|
customBlockResponseBody string |
CustomBlockResponseBody: If the action type is block, customer can override the response body. The body must be specified in base64 encoding. |
customBlockResponseStatusCode int |
CustomBlockResponseStatusCode: If the action type is block, customer can override the response status code. |
fileUploadEnforcement bool |
FileUploadEnforcement: Whether allow WAF to enforce file upload limits. |
fileUploadLimitInMb int |
FileUploadLimitInMb: Maximum file upload size in Mb for WAF. |
jsChallengeCookieExpirationInMins int |
JsChallengeCookieExpirationInMins: Web Application Firewall JavaScript Challenge Cookie Expiration time in minutes. |
logScrubbing PolicySettings_LogScrubbing_STATUS |
LogScrubbing: To scrub sensitive log fields |
maxRequestBodySizeInKb int |
MaxRequestBodySizeInKb: Maximum request body size in Kb for WAF. |
mode PolicySettings_Mode_STATUS |
Mode: The mode of the policy. |
requestBodyCheck bool |
RequestBodyCheck: Whether to allow WAF to check request Body. |
requestBodyEnforcement bool |
RequestBodyEnforcement: Whether allow WAF to enforce request body limits. |
requestBodyInspectLimitInKB int |
RequestBodyInspectLimitInKB: Max inspection limit in KB for request body inspection for WAF. |
state PolicySettings_State_STATUS |
State: The state of the policy. |
PolicySettings_State
(string
alias)
(Appears on:PolicySettings)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
PolicySettings_State_STATUS
(string
alias)
(Appears on:PolicySettings_STATUS)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
ProvisioningState_STATUS
(string
alias)
(Appears on:ApplicationSecurityGroup_STATUS, WebApplicationFirewallPolicy_STATUS)
The current provisioning state.
Value | Description |
---|---|
"Deleting" |
|
"Failed" |
|
"Succeeded" |
|
"Updating" |
SubResource_STATUS
(Appears on:WebApplicationFirewallPolicy_STATUS)
Reference to another subresource.
Field | Description |
---|---|
id string |
Id: Resource ID. |
Transform
(string
alias)
(Appears on:MatchCondition)
Transforms applied before matching.
Value | Description |
---|---|
"HtmlEntityDecode" |
|
"Lowercase" |
|
"RemoveNulls" |
|
"Trim" |
|
"Uppercase" |
|
"UrlDecode" |
|
"UrlEncode" |
Transform_STATUS
(string
alias)
(Appears on:MatchCondition_STATUS)
Transforms applied before matching.
Value | Description |
---|---|
"HtmlEntityDecode" |
|
"Lowercase" |
|
"RemoveNulls" |
|
"Trim" |
|
"Uppercase" |
|
"UrlDecode" |
|
"UrlEncode" |
WebApplicationFirewallCustomRule
(Appears on:WebApplicationFirewallPolicy_Spec)
Defines contents of a web application rule.
Field | Description |
---|---|
action WebApplicationFirewallCustomRule_Action |
Action: Type of Actions. |
groupByUserSession []GroupByUserSession |
GroupByUserSession: List of user session identifier group by clauses. |
matchConditions []MatchCondition |
MatchConditions: List of match conditions. |
name string |
Name: The name of the resource that is unique within a policy. This name can be used to access the resource. |
priority int |
Priority: Priority of the rule. Rules with a lower value will be evaluated before rules with a higher value. |
rateLimitDuration WebApplicationFirewallCustomRule_RateLimitDuration |
RateLimitDuration: Duration over which Rate Limit policy will be applied. Applies only when ruleType is RateLimitRule. |
rateLimitThreshold int |
RateLimitThreshold: Rate Limit threshold to apply in case ruleType is RateLimitRule. Must be greater than or equal to 1 |
ruleType WebApplicationFirewallCustomRule_RuleType |
RuleType: The rule type. |
state WebApplicationFirewallCustomRule_State |
State: Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified. |
WebApplicationFirewallCustomRule_Action
(string
alias)
(Appears on:WebApplicationFirewallCustomRule)
Value | Description |
---|---|
"Allow" |
|
"Block" |
|
"JSChallenge" |
|
"Log" |
WebApplicationFirewallCustomRule_Action_STATUS
(string
alias)
(Appears on:WebApplicationFirewallCustomRule_STATUS)
Value | Description |
---|---|
"Allow" |
|
"Block" |
|
"JSChallenge" |
|
"Log" |
WebApplicationFirewallCustomRule_RateLimitDuration
(string
alias)
(Appears on:WebApplicationFirewallCustomRule)
Value | Description |
---|---|
"FiveMins" |
|
"OneMin" |
WebApplicationFirewallCustomRule_RateLimitDuration_STATUS
(string
alias)
(Appears on:WebApplicationFirewallCustomRule_STATUS)
Value | Description |
---|---|
"FiveMins" |
|
"OneMin" |
WebApplicationFirewallCustomRule_RuleType
(string
alias)
(Appears on:WebApplicationFirewallCustomRule)
Value | Description |
---|---|
"Invalid" |
|
"MatchRule" |
|
"RateLimitRule" |
WebApplicationFirewallCustomRule_RuleType_STATUS
(string
alias)
(Appears on:WebApplicationFirewallCustomRule_STATUS)
Value | Description |
---|---|
"Invalid" |
|
"MatchRule" |
|
"RateLimitRule" |
WebApplicationFirewallCustomRule_STATUS
(Appears on:WebApplicationFirewallPolicy_STATUS)
Defines contents of a web application rule.
Field | Description |
---|---|
action WebApplicationFirewallCustomRule_Action_STATUS |
Action: Type of Actions. |
etag string |
Etag: A unique read-only string that changes whenever the resource is updated. |
groupByUserSession []GroupByUserSession_STATUS |
GroupByUserSession: List of user session identifier group by clauses. |
matchConditions []MatchCondition_STATUS |
MatchConditions: List of match conditions. |
name string |
Name: The name of the resource that is unique within a policy. This name can be used to access the resource. |
priority int |
Priority: Priority of the rule. Rules with a lower value will be evaluated before rules with a higher value. |
rateLimitDuration WebApplicationFirewallCustomRule_RateLimitDuration_STATUS |
RateLimitDuration: Duration over which Rate Limit policy will be applied. Applies only when ruleType is RateLimitRule. |
rateLimitThreshold int |
RateLimitThreshold: Rate Limit threshold to apply in case ruleType is RateLimitRule. Must be greater than or equal to 1 |
ruleType WebApplicationFirewallCustomRule_RuleType_STATUS |
RuleType: The rule type. |
state WebApplicationFirewallCustomRule_State_STATUS |
State: Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified. |
WebApplicationFirewallCustomRule_State
(string
alias)
(Appears on:WebApplicationFirewallCustomRule)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
WebApplicationFirewallCustomRule_State_STATUS
(string
alias)
(Appears on:WebApplicationFirewallCustomRule_STATUS)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
WebApplicationFirewallPolicy
Generator information: - Generated from: /network/resource-manager/Microsoft.Network/stable/2024-01-01/webapplicationfirewall.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies/{policyName}p>
Field | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||||||
spec WebApplicationFirewallPolicy_Spec |
|
||||||||||||||||
status WebApplicationFirewallPolicy_STATUS |
WebApplicationFirewallPolicyOperatorSpec
(Appears on:WebApplicationFirewallPolicy_Spec)
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Field | Description |
---|---|
configMapExpressions []genruntime/core.DestinationExpression |
ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions). |
secretExpressions []genruntime/core.DestinationExpression |
SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions). |
WebApplicationFirewallPolicyPropertiesFormat_ResourceState_STATUS
(string
alias)
(Appears on:WebApplicationFirewallPolicy_STATUS)
Value | Description |
---|---|
"Creating" |
|
"Deleting" |
|
"Disabled" |
|
"Disabling" |
|
"Enabled" |
|
"Enabling" |
WebApplicationFirewallPolicy_STATUS
(Appears on:WebApplicationFirewallPolicy)
Field | Description |
---|---|
applicationGateways []ApplicationGateway_STATUS_ApplicationGatewayWebApplicationFirewallPolicy_SubResourceEmbedded |
ApplicationGateways: A collection of references to application gateways. |
conditions []genruntime/conditions.Condition |
Conditions: The observed state of the resource |
customRules []WebApplicationFirewallCustomRule_STATUS |
CustomRules: The custom rules inside the policy. |
etag string |
Etag: A unique read-only string that changes whenever the resource is updated. |
httpListeners []SubResource_STATUS |
HttpListeners: A collection of references to application gateway http listeners. |
id string |
Id: Resource ID. |
location string |
Location: Resource location. |
managedRules ManagedRulesDefinition_STATUS |
ManagedRules: Describes the managedRules structure. |
name string |
Name: Resource name. |
pathBasedRules []SubResource_STATUS |
PathBasedRules: A collection of references to application gateway path rules. |
policySettings PolicySettings_STATUS |
PolicySettings: The PolicySettings for policy. |
provisioningState ProvisioningState_STATUS |
ProvisioningState: The provisioning state of the web application firewall policy resource. |
resourceState WebApplicationFirewallPolicyPropertiesFormat_ResourceState_STATUS |
ResourceState: Resource status of the policy. |
tags map[string]string |
Tags: Resource tags. |
type string |
Type: Resource type. |
WebApplicationFirewallPolicy_Spec
(Appears on:WebApplicationFirewallPolicy)
Field | Description |
---|---|
azureName string |
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. |
customRules []WebApplicationFirewallCustomRule |
CustomRules: The custom rules inside the policy. |
location string |
Location: Resource location. |
managedRules ManagedRulesDefinition |
ManagedRules: Describes the managedRules structure. |
operatorSpec WebApplicationFirewallPolicyOperatorSpec |
OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure |
owner genruntime.KnownResourceReference |
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 |
policySettings PolicySettings |
PolicySettings: The PolicySettings for policy. |
tags map[string]string |
Tags: Resource tags. |
WebApplicationFirewallScrubbingRules
(Appears on:PolicySettings_LogScrubbing)
Allow certain variables to be scrubbed on WAF logs
Field | Description |
---|---|
matchVariable WebApplicationFirewallScrubbingRules_MatchVariable |
MatchVariable: The variable to be scrubbed from the logs. |
selector string |
Selector: When matchVariable is a collection, operator used to specify which elements in the collection this rule applies to. |
selectorMatchOperator WebApplicationFirewallScrubbingRules_SelectorMatchOperator |
SelectorMatchOperator: When matchVariable is a collection, operate on the selector to specify which elements in the collection this rule applies to. |
state WebApplicationFirewallScrubbingRules_State |
State: Defines the state of log scrubbing rule. Default value is Enabled. |
WebApplicationFirewallScrubbingRules_MatchVariable
(string
alias)
(Appears on:WebApplicationFirewallScrubbingRules)
Value | Description |
---|---|
"RequestArgNames" |
|
"RequestCookieNames" |
|
"RequestHeaderNames" |
|
"RequestIPAddress" |
|
"RequestJSONArgNames" |
|
"RequestPostArgNames" |
WebApplicationFirewallScrubbingRules_MatchVariable_STATUS
(string
alias)
(Appears on:WebApplicationFirewallScrubbingRules_STATUS)
Value | Description |
---|---|
"RequestArgNames" |
|
"RequestCookieNames" |
|
"RequestHeaderNames" |
|
"RequestIPAddress" |
|
"RequestJSONArgNames" |
|
"RequestPostArgNames" |
WebApplicationFirewallScrubbingRules_STATUS
(Appears on:PolicySettings_LogScrubbing_STATUS)
Allow certain variables to be scrubbed on WAF logs
Field | Description |
---|---|
matchVariable WebApplicationFirewallScrubbingRules_MatchVariable_STATUS |
MatchVariable: The variable to be scrubbed from the logs. |
selector string |
Selector: When matchVariable is a collection, operator used to specify which elements in the collection this rule applies to. |
selectorMatchOperator WebApplicationFirewallScrubbingRules_SelectorMatchOperator_STATUS |
SelectorMatchOperator: When matchVariable is a collection, operate on the selector to specify which elements in the collection this rule applies to. |
state WebApplicationFirewallScrubbingRules_State_STATUS |
State: Defines the state of log scrubbing rule. Default value is Enabled. |
WebApplicationFirewallScrubbingRules_SelectorMatchOperator
(string
alias)
(Appears on:WebApplicationFirewallScrubbingRules)
Value | Description |
---|---|
"Equals" |
|
"EqualsAny" |
WebApplicationFirewallScrubbingRules_SelectorMatchOperator_STATUS
(string
alias)
(Appears on:WebApplicationFirewallScrubbingRules_STATUS)
Value | Description |
---|---|
"Equals" |
|
"EqualsAny" |
WebApplicationFirewallScrubbingRules_State
(string
alias)
(Appears on:WebApplicationFirewallScrubbingRules)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
WebApplicationFirewallScrubbingRules_State_STATUS
(string
alias)
(Appears on:WebApplicationFirewallScrubbingRules_STATUS)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |