webapplicationfirewallmanagedrulesets

README

github.com/hashicorp/go-azure-sdk/resource-manager/frontdoor/2024-02-01/webapplicationfirewallmanagedrulesets Documentation

The webapplicationfirewallmanagedrulesets SDK allows for interaction with the Azure Resource Manager Service frontdoor (API Version 2024-02-01).

This readme covers example usages, but further information on using this SDK can be found in the project root.

Import Path

import "github.com/hashicorp/go-azure-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/frontdoor/2024-02-01/webapplicationfirewallmanagedrulesets"

Client Initialization

client := webapplicationfirewallmanagedrulesets.NewWebApplicationFirewallManagedRuleSetsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: WebApplicationFirewallManagedRuleSetsClient.ManagedRuleSetsList

ctx := context.TODO()
id := commonids.NewSubscriptionID("12345678-1234-9876-4563-123456789012")

// alternatively `client.ManagedRuleSetsList(ctx, id)` can be used to do batched pagination
items, err := client.ManagedRuleSetsListComplete(ctx, id)
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Documentation

Index

• func PossibleValuesForActionType() []string
• func PossibleValuesForManagedRuleEnabledState() []string
• type ActionType
• type ManagedRuleDefinition
• type ManagedRuleEnabledState
• type ManagedRuleGroupDefinition
• type ManagedRuleSetDefinition
• type ManagedRuleSetDefinitionOperationPredicate
  • func (p ManagedRuleSetDefinitionOperationPredicate) Matches(input ManagedRuleSetDefinition) bool
• type ManagedRuleSetDefinitionProperties
• type ManagedRuleSetsListCompleteResult
• type ManagedRuleSetsListOperationResponse
  • func (r ManagedRuleSetsListOperationResponse) HasMore() bool
  • func (r ManagedRuleSetsListOperationResponse) LoadMore(ctx context.Context) (resp ManagedRuleSetsListOperationResponse, err error)
• type WebApplicationFirewallManagedRuleSetsClient
  • func NewWebApplicationFirewallManagedRuleSetsClientWithBaseURI(endpoint string) WebApplicationFirewallManagedRuleSetsClient
  • func (c WebApplicationFirewallManagedRuleSetsClient) ManagedRuleSetsList(ctx context.Context, id commonids.SubscriptionId) (resp ManagedRuleSetsListOperationResponse, err error)
  • func (c WebApplicationFirewallManagedRuleSetsClient) ManagedRuleSetsListComplete(ctx context.Context, id commonids.SubscriptionId) (ManagedRuleSetsListCompleteResult, error)
  • func (c WebApplicationFirewallManagedRuleSetsClient) ManagedRuleSetsListCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, ...) (resp ManagedRuleSetsListCompleteResult, err error)

Functions

func PossibleValuesForActionType

func PossibleValuesForActionType() []string

func PossibleValuesForManagedRuleEnabledState

func PossibleValuesForManagedRuleEnabledState() []string

Types

type ActionType

type ActionType string

const (
	ActionTypeAllow          ActionType = "Allow"
	ActionTypeAnomalyScoring ActionType = "AnomalyScoring"
	ActionTypeBlock          ActionType = "Block"
	ActionTypeJSChallenge    ActionType = "JSChallenge"
	ActionTypeLog            ActionType = "Log"
	ActionTypeRedirect       ActionType = "Redirect"
)

type ManagedRuleDefinition

type ManagedRuleDefinition struct {
	DefaultAction *ActionType              `json:"defaultAction,omitempty"`
	DefaultState  *ManagedRuleEnabledState `json:"defaultState,omitempty"`
	Description   *string                  `json:"description,omitempty"`
	RuleId        *string                  `json:"ruleId,omitempty"`
}

type ManagedRuleEnabledState

type ManagedRuleEnabledState string

const (
	ManagedRuleEnabledStateDisabled ManagedRuleEnabledState = "Disabled"
	ManagedRuleEnabledStateEnabled  ManagedRuleEnabledState = "Enabled"
)

type ManagedRuleGroupDefinition

type ManagedRuleGroupDefinition struct {
	Description   *string                  `json:"description,omitempty"`
	RuleGroupName *string                  `json:"ruleGroupName,omitempty"`
	Rules         *[]ManagedRuleDefinition `json:"rules,omitempty"`
}

type ManagedRuleSetDefinition

type ManagedRuleSetDefinition struct {
	Id         *string                             `json:"id,omitempty"`
	Location   *string                             `json:"location,omitempty"`
	Name       *string                             `json:"name,omitempty"`
	Properties *ManagedRuleSetDefinitionProperties `json:"properties,omitempty"`
	Tags       *map[string]string                  `json:"tags,omitempty"`
	Type       *string                             `json:"type,omitempty"`
}

type ManagedRuleSetDefinitionOperationPredicate

type ManagedRuleSetDefinitionOperationPredicate struct {
	Id       *string
	Location *string
	Name     *string
	Type     *string
}

func (ManagedRuleSetDefinitionOperationPredicate) Matches

func (p ManagedRuleSetDefinitionOperationPredicate) Matches(input ManagedRuleSetDefinition) bool

type ManagedRuleSetDefinitionProperties

type ManagedRuleSetDefinitionProperties struct {
	ProvisioningState *string                       `json:"provisioningState,omitempty"`
	RuleGroups        *[]ManagedRuleGroupDefinition `json:"ruleGroups,omitempty"`
	RuleSetId         *string                       `json:"ruleSetId,omitempty"`
	RuleSetType       *string                       `json:"ruleSetType,omitempty"`
	RuleSetVersion    *string                       `json:"ruleSetVersion,omitempty"`
}

type ManagedRuleSetsListCompleteResult

type ManagedRuleSetsListCompleteResult struct {
	Items []ManagedRuleSetDefinition
}

type ManagedRuleSetsListOperationResponse

type ManagedRuleSetsListOperationResponse struct {
	HttpResponse *http.Response
	Model        *[]ManagedRuleSetDefinition
	// contains filtered or unexported fields
}

func (ManagedRuleSetsListOperationResponse) HasMore

func (r ManagedRuleSetsListOperationResponse) HasMore() bool

func (ManagedRuleSetsListOperationResponse) LoadMore

func (r ManagedRuleSetsListOperationResponse) LoadMore(ctx context.Context) (resp ManagedRuleSetsListOperationResponse, err error)

type WebApplicationFirewallManagedRuleSetsClient

type WebApplicationFirewallManagedRuleSetsClient struct {
	Client autorest.Client
	// contains filtered or unexported fields
}

func NewWebApplicationFirewallManagedRuleSetsClientWithBaseURI

func NewWebApplicationFirewallManagedRuleSetsClientWithBaseURI(endpoint string) WebApplicationFirewallManagedRuleSetsClient

func (WebApplicationFirewallManagedRuleSetsClient) ManagedRuleSetsList

func (c WebApplicationFirewallManagedRuleSetsClient) ManagedRuleSetsList(ctx context.Context, id commonids.SubscriptionId) (resp ManagedRuleSetsListOperationResponse, err error)

ManagedRuleSetsList ...

func (WebApplicationFirewallManagedRuleSetsClient) ManagedRuleSetsListComplete

func (c WebApplicationFirewallManagedRuleSetsClient) ManagedRuleSetsListComplete(ctx context.Context, id commonids.SubscriptionId) (ManagedRuleSetsListCompleteResult, error)

ManagedRuleSetsListComplete retrieves all of the results into a single object

func (WebApplicationFirewallManagedRuleSetsClient) ManagedRuleSetsListCompleteMatchingPredicate

func (c WebApplicationFirewallManagedRuleSetsClient) ManagedRuleSetsListCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, predicate ManagedRuleSetDefinitionOperationPredicate) (resp ManagedRuleSetsListCompleteResult, err error)

ManagedRuleSetsListCompleteMatchingPredicate retrieves all of the results and then applied the predicate