prerules

package
v0.20240117.1163544 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 17, 2024 License: MPL-2.0 Imports: 14 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/paloaltonetworks/2023-09-01/prerules Documentation

The prerules SDK allows for interaction with the Azure Resource Manager Service paloaltonetworks (API Version 2023-09-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-sdk/resource-manager/paloaltonetworks/2023-09-01/prerules"

Client Initialization

client := prerules.NewPreRulesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: PreRulesClient.CreateOrUpdate

ctx := context.TODO()
id := prerules.NewPreRuleID("globalRulestackValue", "preRuleValue")

payload := prerules.PreRulesResource{
	// ...
}


if err := client.CreateOrUpdateThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Example Usage: PreRulesClient.Delete

ctx := context.TODO()
id := prerules.NewPreRuleID("globalRulestackValue", "preRuleValue")

if err := client.DeleteThenPoll(ctx, id); err != nil {
	// handle the error
}

Example Usage: PreRulesClient.Get

ctx := context.TODO()
id := prerules.NewPreRuleID("globalRulestackValue", "preRuleValue")

read, err := client.Get(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: PreRulesClient.GetCounters

ctx := context.TODO()
id := prerules.NewPreRuleID("globalRulestackValue", "preRuleValue")

read, err := client.GetCounters(ctx, id, prerules.DefaultGetCountersOperationOptions())
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: PreRulesClient.List

ctx := context.TODO()
id := prerules.NewGlobalRulestackID("globalRulestackValue")

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

Example Usage: PreRulesClient.RefreshCounters

ctx := context.TODO()
id := prerules.NewPreRuleID("globalRulestackValue", "preRuleValue")

read, err := client.RefreshCounters(ctx, id, prerules.DefaultRefreshCountersOperationOptions())
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: PreRulesClient.ResetCounters

ctx := context.TODO()
id := prerules.NewPreRuleID("globalRulestackValue", "preRuleValue")

read, err := client.ResetCounters(ctx, id, prerules.DefaultResetCountersOperationOptions())
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForActionEnum 

func PossibleValuesForActionEnum() []string

func PossibleValuesForBooleanEnum 

func PossibleValuesForBooleanEnum() []string

func PossibleValuesForDecryptionRuleTypeEnum 

func PossibleValuesForDecryptionRuleTypeEnum() []string

func PossibleValuesForProvisioningState 

func PossibleValuesForProvisioningState() []string

func PossibleValuesForStateEnum 

func PossibleValuesForStateEnum() []string

func ValidateGlobalRulestackID 

func ValidateGlobalRulestackID(input interface{}, key string) (warnings []string, errors []error)

ValidateGlobalRulestackID checks that 'input' can be parsed as a Global Rulestack ID

func ValidatePreRuleID 

func ValidatePreRuleID(input interface{}, key string) (warnings []string, errors []error)

ValidatePreRuleID checks that 'input' can be parsed as a Pre Rule ID

Types

type ActionEnum 

type ActionEnum string
const (
	ActionEnumAllow           ActionEnum = "Allow"
	ActionEnumDenyResetBoth   ActionEnum = "DenyResetBoth"
	ActionEnumDenyResetServer ActionEnum = "DenyResetServer"
	ActionEnumDenySilent      ActionEnum = "DenySilent"
)

func (*ActionEnum) UnmarshalJSON 

func (s *ActionEnum) UnmarshalJSON(bytes []byte) error

type AppSeenData 

type AppSeenData struct {
	AppSeenList []AppSeenInfo `json:"appSeenList"`
	Count       int64         `json:"count"`
}

type AppSeenInfo 

type AppSeenInfo struct {
	Category      string `json:"category"`
	Risk          string `json:"risk"`
	StandardPorts string `json:"standardPorts"`
	SubCategory   string `json:"subCategory"`
	Tag           string `json:"tag"`
	Technology    string `json:"technology"`
	Title         string `json:"title"`
}

type BooleanEnum 

type BooleanEnum string
const (
	BooleanEnumFALSE BooleanEnum = "FALSE"
	BooleanEnumTRUE  BooleanEnum = "TRUE"
)

func (*BooleanEnum) UnmarshalJSON 

func (s *BooleanEnum) UnmarshalJSON(bytes []byte) error

type Category 

type Category struct {
	Feeds     []string `json:"feeds"`
	UrlCustom []string `json:"urlCustom"`
}

type CreateOrUpdateOperationResponse 

type CreateOrUpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type DecryptionRuleTypeEnum 

type DecryptionRuleTypeEnum string
const (
	DecryptionRuleTypeEnumNone                  DecryptionRuleTypeEnum = "None"
	DecryptionRuleTypeEnumSSLInboundInspection  DecryptionRuleTypeEnum = "SSLInboundInspection"
	DecryptionRuleTypeEnumSSLOutboundInspection DecryptionRuleTypeEnum = "SSLOutboundInspection"
)

func (*DecryptionRuleTypeEnum) UnmarshalJSON 

func (s *DecryptionRuleTypeEnum) UnmarshalJSON(bytes []byte) error

type DeleteOperationResponse 

type DeleteOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type DestinationAddr 

type DestinationAddr struct {
	Cidrs       *[]string `json:"cidrs,omitempty"`
	Countries   *[]string `json:"countries,omitempty"`
	Feeds       *[]string `json:"feeds,omitempty"`
	FqdnLists   *[]string `json:"fqdnLists,omitempty"`
	PrefixLists *[]string `json:"prefixLists,omitempty"`
}

type GetCountersOperationOptions 

type GetCountersOperationOptions struct {
	FirewallName *string
}

func DefaultGetCountersOperationOptions 

func DefaultGetCountersOperationOptions() GetCountersOperationOptions

func (GetCountersOperationOptions) ToHeaders 

func (o GetCountersOperationOptions) ToHeaders() *client.Headers

func (GetCountersOperationOptions) ToOData 

func (o GetCountersOperationOptions) ToOData() *odata.Query

func (GetCountersOperationOptions) ToQuery 

func (o GetCountersOperationOptions) ToQuery() *client.QueryParams

type GetCountersOperationResponse 

type GetCountersOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *RuleCounter
}

type GetOperationResponse 

type GetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *PreRulesResource
}

type GlobalRulestackId 

type GlobalRulestackId struct {
	GlobalRulestackName string
}

GlobalRulestackId is a struct representing the Resource ID for a Global Rulestack

func NewGlobalRulestackID 

func NewGlobalRulestackID(globalRulestackName string) GlobalRulestackId

NewGlobalRulestackID returns a new GlobalRulestackId struct

func ParseGlobalRulestackID 

func ParseGlobalRulestackID(input string) (*GlobalRulestackId, error)

ParseGlobalRulestackID parses 'input' into a GlobalRulestackId

func ParseGlobalRulestackIDInsensitively 

func ParseGlobalRulestackIDInsensitively(input string) (*GlobalRulestackId, error)

ParseGlobalRulestackIDInsensitively parses 'input' case-insensitively into a GlobalRulestackId note: this method should only be used for API response data and not user input

func (*GlobalRulestackId) FromParseResult added in v0.20231127.1171502 

func (id *GlobalRulestackId) FromParseResult(input resourceids.ParseResult) error

func (GlobalRulestackId) ID 

func (id GlobalRulestackId) ID() string

ID returns the formatted Global Rulestack ID

func (GlobalRulestackId) Segments 

func (id GlobalRulestackId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Global Rulestack ID

func (GlobalRulestackId) String 

func (id GlobalRulestackId) String() string

String returns a human-readable description of this Global Rulestack ID

type ListCompleteResult 

type ListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []PreRulesResource
}

type ListOperationResponse 

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]PreRulesResource
}

type PreRuleId 

type PreRuleId struct {
	GlobalRulestackName string
	PreRuleName         string
}

PreRuleId is a struct representing the Resource ID for a Pre Rule

func NewPreRuleID 

func NewPreRuleID(globalRulestackName string, preRuleName string) PreRuleId

NewPreRuleID returns a new PreRuleId struct

func ParsePreRuleID 

func ParsePreRuleID(input string) (*PreRuleId, error)

ParsePreRuleID parses 'input' into a PreRuleId

func ParsePreRuleIDInsensitively 

func ParsePreRuleIDInsensitively(input string) (*PreRuleId, error)

ParsePreRuleIDInsensitively parses 'input' case-insensitively into a PreRuleId note: this method should only be used for API response data and not user input

func (*PreRuleId) FromParseResult added in v0.20231127.1171502 

func (id *PreRuleId) FromParseResult(input resourceids.ParseResult) error

func (PreRuleId) ID 

func (id PreRuleId) ID() string

ID returns the formatted Pre Rule ID

func (PreRuleId) Segments 

func (id PreRuleId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Pre Rule ID

func (PreRuleId) String 

func (id PreRuleId) String() string

String returns a human-readable description of this Pre Rule ID

type PreRulesClient 

type PreRulesClient struct {
	Client *resourcemanager.Client
}

func NewPreRulesClientWithBaseURI 

func NewPreRulesClientWithBaseURI(sdkApi sdkEnv.Api) (*PreRulesClient, error)

func (PreRulesClient) CreateOrUpdate 

func (c PreRulesClient) CreateOrUpdate(ctx context.Context, id PreRuleId, input PreRulesResource) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (PreRulesClient) CreateOrUpdateThenPoll 

func (c PreRulesClient) CreateOrUpdateThenPoll(ctx context.Context, id PreRuleId, input PreRulesResource) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (PreRulesClient) Delete 

func (c PreRulesClient) Delete(ctx context.Context, id PreRuleId) (result DeleteOperationResponse, err error)

Delete ...

func (PreRulesClient) DeleteThenPoll 

func (c PreRulesClient) DeleteThenPoll(ctx context.Context, id PreRuleId) error

DeleteThenPoll performs Delete then polls until it's completed

func (PreRulesClient) Get 

func (c PreRulesClient) Get(ctx context.Context, id PreRuleId) (result GetOperationResponse, err error)

Get ...

func (PreRulesClient) GetCounters 

func (c PreRulesClient) GetCounters(ctx context.Context, id PreRuleId, options GetCountersOperationOptions) (result GetCountersOperationResponse, err error)

GetCounters ...

func (PreRulesClient) List 

func (c PreRulesClient) List(ctx context.Context, id GlobalRulestackId) (result ListOperationResponse, err error)

List ...

func (PreRulesClient) ListComplete 

func (c PreRulesClient) ListComplete(ctx context.Context, id GlobalRulestackId) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (PreRulesClient) ListCompleteMatchingPredicate 

func (c PreRulesClient) ListCompleteMatchingPredicate(ctx context.Context, id GlobalRulestackId, predicate PreRulesResourceOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (PreRulesClient) RefreshCounters 

func (c PreRulesClient) RefreshCounters(ctx context.Context, id PreRuleId, options RefreshCountersOperationOptions) (result RefreshCountersOperationResponse, err error)

RefreshCounters ...

func (PreRulesClient) ResetCounters 

func (c PreRulesClient) ResetCounters(ctx context.Context, id PreRuleId, options ResetCountersOperationOptions) (result ResetCountersOperationResponse, err error)

ResetCounters ...

type PreRulesResource 

type PreRulesResource struct {
	Id         *string                `json:"id,omitempty"`
	Name       *string                `json:"name,omitempty"`
	Properties RuleEntry              `json:"properties"`
	SystemData *systemdata.SystemData `json:"systemData,omitempty"`
	Type       *string                `json:"type,omitempty"`
}

type PreRulesResourceOperationPredicate 

type PreRulesResourceOperationPredicate struct {
	Id   *string
	Name *string
	Type *string
}

func (PreRulesResourceOperationPredicate) Matches 

func (p PreRulesResourceOperationPredicate) Matches(input PreRulesResource) bool

type ProvisioningState 

type ProvisioningState string
const (
	ProvisioningStateAccepted     ProvisioningState = "Accepted"
	ProvisioningStateCanceled     ProvisioningState = "Canceled"
	ProvisioningStateCreating     ProvisioningState = "Creating"
	ProvisioningStateDeleted      ProvisioningState = "Deleted"
	ProvisioningStateDeleting     ProvisioningState = "Deleting"
	ProvisioningStateFailed       ProvisioningState = "Failed"
	ProvisioningStateNotSpecified ProvisioningState = "NotSpecified"
	ProvisioningStateSucceeded    ProvisioningState = "Succeeded"
	ProvisioningStateUpdating     ProvisioningState = "Updating"
)

func (*ProvisioningState) UnmarshalJSON 

func (s *ProvisioningState) UnmarshalJSON(bytes []byte) error

type RefreshCountersOperationOptions 

type RefreshCountersOperationOptions struct {
	FirewallName *string
}

func DefaultRefreshCountersOperationOptions 

func DefaultRefreshCountersOperationOptions() RefreshCountersOperationOptions

func (RefreshCountersOperationOptions) ToHeaders 

func (o RefreshCountersOperationOptions) ToHeaders() *client.Headers

func (RefreshCountersOperationOptions) ToOData 

func (o RefreshCountersOperationOptions) ToOData() *odata.Query

func (RefreshCountersOperationOptions) ToQuery 

func (o RefreshCountersOperationOptions) ToQuery() *client.QueryParams

type RefreshCountersOperationResponse 

type RefreshCountersOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
}

type ResetCountersOperationOptions 

type ResetCountersOperationOptions struct {
	FirewallName *string
}

func DefaultResetCountersOperationOptions 

func DefaultResetCountersOperationOptions() ResetCountersOperationOptions

func (ResetCountersOperationOptions) ToHeaders 

func (o ResetCountersOperationOptions) ToHeaders() *client.Headers

func (ResetCountersOperationOptions) ToOData 

func (o ResetCountersOperationOptions) ToOData() *odata.Query

func (ResetCountersOperationOptions) ToQuery 

func (o ResetCountersOperationOptions) ToQuery() *client.QueryParams

type ResetCountersOperationResponse 

type ResetCountersOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *RuleCounterReset
}

type RuleCounter 

type RuleCounter struct {
	AppSeen              *AppSeenData `json:"appSeen,omitempty"`
	FirewallName         *string      `json:"firewallName,omitempty"`
	HitCount             *int64       `json:"hitCount,omitempty"`
	LastUpdatedTimestamp *string      `json:"lastUpdatedTimestamp,omitempty"`
	Priority             string       `json:"priority"`
	RequestTimestamp     *string      `json:"requestTimestamp,omitempty"`
	RuleListName         *string      `json:"ruleListName,omitempty"`
	RuleName             string       `json:"ruleName"`
	RuleStackName        *string      `json:"ruleStackName,omitempty"`
	Timestamp            *string      `json:"timestamp,omitempty"`
}

func (*RuleCounter) GetLastUpdatedTimestampAsTime 

func (o *RuleCounter) GetLastUpdatedTimestampAsTime() (*time.Time, error)

func (*RuleCounter) GetRequestTimestampAsTime 

func (o *RuleCounter) GetRequestTimestampAsTime() (*time.Time, error)

func (*RuleCounter) GetTimestampAsTime 

func (o *RuleCounter) GetTimestampAsTime() (*time.Time, error)

func (*RuleCounter) SetLastUpdatedTimestampAsTime 

func (o *RuleCounter) SetLastUpdatedTimestampAsTime(input time.Time)

func (*RuleCounter) SetRequestTimestampAsTime 

func (o *RuleCounter) SetRequestTimestampAsTime(input time.Time)

func (*RuleCounter) SetTimestampAsTime 

func (o *RuleCounter) SetTimestampAsTime(input time.Time)

type RuleCounterReset 

type RuleCounterReset struct {
	FirewallName  *string `json:"firewallName,omitempty"`
	Priority      *string `json:"priority,omitempty"`
	RuleListName  *string `json:"ruleListName,omitempty"`
	RuleName      *string `json:"ruleName,omitempty"`
	RuleStackName *string `json:"ruleStackName,omitempty"`
}

type RuleEntry 

type RuleEntry struct {
	ActionType                   *ActionEnum             `json:"actionType,omitempty"`
	Applications                 *[]string               `json:"applications,omitempty"`
	AuditComment                 *string                 `json:"auditComment,omitempty"`
	Category                     *Category               `json:"category,omitempty"`
	DecryptionRuleType           *DecryptionRuleTypeEnum `json:"decryptionRuleType,omitempty"`
	Description                  *string                 `json:"description,omitempty"`
	Destination                  *DestinationAddr        `json:"destination,omitempty"`
	EnableLogging                *StateEnum              `json:"enableLogging,omitempty"`
	Etag                         *string                 `json:"etag,omitempty"`
	InboundInspectionCertificate *string                 `json:"inboundInspectionCertificate,omitempty"`
	NegateDestination            *BooleanEnum            `json:"negateDestination,omitempty"`
	NegateSource                 *BooleanEnum            `json:"negateSource,omitempty"`
	Priority                     *int64                  `json:"priority,omitempty"`
	Protocol                     *string                 `json:"protocol,omitempty"`
	ProtocolPortList             *[]string               `json:"protocolPortList,omitempty"`
	ProvisioningState            *ProvisioningState      `json:"provisioningState,omitempty"`
	RuleName                     string                  `json:"ruleName"`
	RuleState                    *StateEnum              `json:"ruleState,omitempty"`
	Source                       *SourceAddr             `json:"source,omitempty"`
	Tags                         *[]TagInfo              `json:"tags,omitempty"`
}

type SourceAddr 

type SourceAddr struct {
	Cidrs       *[]string `json:"cidrs,omitempty"`
	Countries   *[]string `json:"countries,omitempty"`
	Feeds       *[]string `json:"feeds,omitempty"`
	PrefixLists *[]string `json:"prefixLists,omitempty"`
}

type StateEnum 

type StateEnum string
const (
	StateEnumDISABLED StateEnum = "DISABLED"
	StateEnumENABLED  StateEnum = "ENABLED"
)

func (*StateEnum) UnmarshalJSON 

func (s *StateEnum) UnmarshalJSON(bytes []byte) error

type TagInfo 

type TagInfo struct {
	Key   string `json:"key"`
	Value string `json:"value"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.