firewallpolicyrulecollectiongroups

package
v0.20240612.1122027 Latest Latest
Warning

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

Go to latest
Published: Jun 12, 2024 License: MPL-2.0 Imports: 12 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/network/2022-07-01/firewallpolicyrulecollectiongroups Documentation

The firewallpolicyrulecollectiongroups SDK allows for interaction with the Azure Resource Manager Service network (API Version 2022-07-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/network/2022-07-01/firewallpolicyrulecollectiongroups"

Client Initialization

client := firewallpolicyrulecollectiongroups.NewFirewallPolicyRuleCollectionGroupsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: FirewallPolicyRuleCollectionGroupsClient.CreateOrUpdate

ctx := context.TODO()
id := firewallpolicyrulecollectiongroups.NewRuleCollectionGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group", "firewallPolicyValue", "ruleCollectionGroupValue")

payload := firewallpolicyrulecollectiongroups.FirewallPolicyRuleCollectionGroup{
	// ...
}


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

Example Usage: FirewallPolicyRuleCollectionGroupsClient.Delete

ctx := context.TODO()
id := firewallpolicyrulecollectiongroups.NewRuleCollectionGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group", "firewallPolicyValue", "ruleCollectionGroupValue")

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

Example Usage: FirewallPolicyRuleCollectionGroupsClient.Get

ctx := context.TODO()
id := firewallpolicyrulecollectiongroups.NewRuleCollectionGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group", "firewallPolicyValue", "ruleCollectionGroupValue")

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: FirewallPolicyRuleCollectionGroupsClient.List

ctx := context.TODO()
id := firewallpolicyrulecollectiongroups.NewFirewallPolicyID("12345678-1234-9876-4563-123456789012", "example-resource-group", "firewallPolicyValue")

// 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
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForFirewallPolicyFilterRuleCollectionActionType

func PossibleValuesForFirewallPolicyFilterRuleCollectionActionType() []string

func PossibleValuesForFirewallPolicyNatRuleCollectionActionType

func PossibleValuesForFirewallPolicyNatRuleCollectionActionType() []string

func PossibleValuesForFirewallPolicyRuleApplicationProtocolType

func PossibleValuesForFirewallPolicyRuleApplicationProtocolType() []string

func PossibleValuesForFirewallPolicyRuleCollectionType

func PossibleValuesForFirewallPolicyRuleCollectionType() []string

func PossibleValuesForFirewallPolicyRuleNetworkProtocol

func PossibleValuesForFirewallPolicyRuleNetworkProtocol() []string

func PossibleValuesForFirewallPolicyRuleType

func PossibleValuesForFirewallPolicyRuleType() []string

func PossibleValuesForProvisioningState

func PossibleValuesForProvisioningState() []string

func ValidateFirewallPolicyID

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

ValidateFirewallPolicyID checks that 'input' can be parsed as a Firewall Policy ID

func ValidateRuleCollectionGroupID

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

ValidateRuleCollectionGroupID checks that 'input' can be parsed as a Rule Collection Group ID

Types

type ApplicationRule

type ApplicationRule struct {
	DestinationAddresses *[]string                                `json:"destinationAddresses,omitempty"`
	FqdnTags             *[]string                                `json:"fqdnTags,omitempty"`
	Protocols            *[]FirewallPolicyRuleApplicationProtocol `json:"protocols,omitempty"`
	SourceAddresses      *[]string                                `json:"sourceAddresses,omitempty"`
	SourceIPGroups       *[]string                                `json:"sourceIpGroups,omitempty"`
	TargetFqdns          *[]string                                `json:"targetFqdns,omitempty"`
	TargetUrls           *[]string                                `json:"targetUrls,omitempty"`
	TerminateTLS         *bool                                    `json:"terminateTLS,omitempty"`
	WebCategories        *[]string                                `json:"webCategories,omitempty"`

	// Fields inherited from FirewallPolicyRule
	Description *string `json:"description,omitempty"`
	Name        *string `json:"name,omitempty"`
}

func (ApplicationRule) MarshalJSON

func (s ApplicationRule) MarshalJSON() ([]byte, error)

type CreateOrUpdateOperationResponse

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

type DeleteOperationResponse

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

type FirewallPolicyFilterRuleCollection

type FirewallPolicyFilterRuleCollection struct {
	Action *FirewallPolicyFilterRuleCollectionAction `json:"action,omitempty"`
	Rules  *[]FirewallPolicyRule                     `json:"rules,omitempty"`

	// Fields inherited from FirewallPolicyRuleCollection
	Name     *string `json:"name,omitempty"`
	Priority *int64  `json:"priority,omitempty"`
}

func (FirewallPolicyFilterRuleCollection) MarshalJSON

func (s FirewallPolicyFilterRuleCollection) MarshalJSON() ([]byte, error)

func (*FirewallPolicyFilterRuleCollection) UnmarshalJSON

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

type FirewallPolicyFilterRuleCollectionAction

type FirewallPolicyFilterRuleCollectionAction struct {
	Type *FirewallPolicyFilterRuleCollectionActionType `json:"type,omitempty"`
}

type FirewallPolicyFilterRuleCollectionActionType

type FirewallPolicyFilterRuleCollectionActionType string
const (
	FirewallPolicyFilterRuleCollectionActionTypeAllow FirewallPolicyFilterRuleCollectionActionType = "Allow"
	FirewallPolicyFilterRuleCollectionActionTypeDeny  FirewallPolicyFilterRuleCollectionActionType = "Deny"
)

func (*FirewallPolicyFilterRuleCollectionActionType) UnmarshalJSON

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

type FirewallPolicyId

type FirewallPolicyId struct {
	SubscriptionId     string
	ResourceGroupName  string
	FirewallPolicyName string
}

FirewallPolicyId is a struct representing the Resource ID for a Firewall Policy

func NewFirewallPolicyID

func NewFirewallPolicyID(subscriptionId string, resourceGroupName string, firewallPolicyName string) FirewallPolicyId

NewFirewallPolicyID returns a new FirewallPolicyId struct

func ParseFirewallPolicyID

func ParseFirewallPolicyID(input string) (*FirewallPolicyId, error)

ParseFirewallPolicyID parses 'input' into a FirewallPolicyId

func ParseFirewallPolicyIDInsensitively

func ParseFirewallPolicyIDInsensitively(input string) (*FirewallPolicyId, error)

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

func (*FirewallPolicyId) FromParseResult

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

func (FirewallPolicyId) ID

func (id FirewallPolicyId) ID() string

ID returns the formatted Firewall Policy ID

func (FirewallPolicyId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Firewall Policy ID

func (FirewallPolicyId) String

func (id FirewallPolicyId) String() string

String returns a human-readable description of this Firewall Policy ID

type FirewallPolicyNatRuleCollection

type FirewallPolicyNatRuleCollection struct {
	Action *FirewallPolicyNatRuleCollectionAction `json:"action,omitempty"`
	Rules  *[]FirewallPolicyRule                  `json:"rules,omitempty"`

	// Fields inherited from FirewallPolicyRuleCollection
	Name     *string `json:"name,omitempty"`
	Priority *int64  `json:"priority,omitempty"`
}

func (FirewallPolicyNatRuleCollection) MarshalJSON

func (s FirewallPolicyNatRuleCollection) MarshalJSON() ([]byte, error)

func (*FirewallPolicyNatRuleCollection) UnmarshalJSON

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

type FirewallPolicyNatRuleCollectionAction

type FirewallPolicyNatRuleCollectionAction struct {
	Type *FirewallPolicyNatRuleCollectionActionType `json:"type,omitempty"`
}

type FirewallPolicyNatRuleCollectionActionType

type FirewallPolicyNatRuleCollectionActionType string
const (
	FirewallPolicyNatRuleCollectionActionTypeDNAT FirewallPolicyNatRuleCollectionActionType = "DNAT"
)

func (*FirewallPolicyNatRuleCollectionActionType) UnmarshalJSON

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

type FirewallPolicyRule

type FirewallPolicyRule interface {
}

type FirewallPolicyRuleApplicationProtocol

type FirewallPolicyRuleApplicationProtocol struct {
	Port         *int64                                     `json:"port,omitempty"`
	ProtocolType *FirewallPolicyRuleApplicationProtocolType `json:"protocolType,omitempty"`
}

type FirewallPolicyRuleApplicationProtocolType

type FirewallPolicyRuleApplicationProtocolType string
const (
	FirewallPolicyRuleApplicationProtocolTypeHTTP  FirewallPolicyRuleApplicationProtocolType = "Http"
	FirewallPolicyRuleApplicationProtocolTypeHTTPS FirewallPolicyRuleApplicationProtocolType = "Https"
)

func (*FirewallPolicyRuleApplicationProtocolType) UnmarshalJSON

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

type FirewallPolicyRuleCollection

type FirewallPolicyRuleCollection interface {
}

type FirewallPolicyRuleCollectionGroup

type FirewallPolicyRuleCollectionGroup struct {
	Etag       *string                                      `json:"etag,omitempty"`
	Id         *string                                      `json:"id,omitempty"`
	Name       *string                                      `json:"name,omitempty"`
	Properties *FirewallPolicyRuleCollectionGroupProperties `json:"properties,omitempty"`
	Type       *string                                      `json:"type,omitempty"`
}

type FirewallPolicyRuleCollectionGroupOperationPredicate

type FirewallPolicyRuleCollectionGroupOperationPredicate struct {
	Etag *string
	Id   *string
	Name *string
	Type *string
}

func (FirewallPolicyRuleCollectionGroupOperationPredicate) Matches

type FirewallPolicyRuleCollectionGroupProperties

type FirewallPolicyRuleCollectionGroupProperties struct {
	Priority          *int64                          `json:"priority,omitempty"`
	ProvisioningState *ProvisioningState              `json:"provisioningState,omitempty"`
	RuleCollections   *[]FirewallPolicyRuleCollection `json:"ruleCollections,omitempty"`
}

func (*FirewallPolicyRuleCollectionGroupProperties) UnmarshalJSON

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

type FirewallPolicyRuleCollectionGroupsClient

type FirewallPolicyRuleCollectionGroupsClient struct {
	Client *resourcemanager.Client
}

func NewFirewallPolicyRuleCollectionGroupsClientWithBaseURI

func NewFirewallPolicyRuleCollectionGroupsClientWithBaseURI(sdkApi sdkEnv.Api) (*FirewallPolicyRuleCollectionGroupsClient, error)

func (FirewallPolicyRuleCollectionGroupsClient) CreateOrUpdate

CreateOrUpdate ...

func (FirewallPolicyRuleCollectionGroupsClient) CreateOrUpdateThenPoll

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (FirewallPolicyRuleCollectionGroupsClient) Delete

Delete ...

func (FirewallPolicyRuleCollectionGroupsClient) DeleteThenPoll

DeleteThenPoll performs Delete then polls until it's completed

func (FirewallPolicyRuleCollectionGroupsClient) Get

Get ...

func (FirewallPolicyRuleCollectionGroupsClient) List

List ...

func (FirewallPolicyRuleCollectionGroupsClient) ListComplete

ListComplete retrieves all the results into a single object

func (FirewallPolicyRuleCollectionGroupsClient) ListCompleteMatchingPredicate

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type FirewallPolicyRuleCollectionType

type FirewallPolicyRuleCollectionType string
const (
	FirewallPolicyRuleCollectionTypeFirewallPolicyFilterRuleCollection FirewallPolicyRuleCollectionType = "FirewallPolicyFilterRuleCollection"
	FirewallPolicyRuleCollectionTypeFirewallPolicyNatRuleCollection    FirewallPolicyRuleCollectionType = "FirewallPolicyNatRuleCollection"
)

func (*FirewallPolicyRuleCollectionType) UnmarshalJSON

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

type FirewallPolicyRuleNetworkProtocol

type FirewallPolicyRuleNetworkProtocol string
const (
	FirewallPolicyRuleNetworkProtocolAny  FirewallPolicyRuleNetworkProtocol = "Any"
	FirewallPolicyRuleNetworkProtocolICMP FirewallPolicyRuleNetworkProtocol = "ICMP"
	FirewallPolicyRuleNetworkProtocolTCP  FirewallPolicyRuleNetworkProtocol = "TCP"
	FirewallPolicyRuleNetworkProtocolUDP  FirewallPolicyRuleNetworkProtocol = "UDP"
)

func (*FirewallPolicyRuleNetworkProtocol) UnmarshalJSON

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

type FirewallPolicyRuleType

type FirewallPolicyRuleType string
const (
	FirewallPolicyRuleTypeApplicationRule FirewallPolicyRuleType = "ApplicationRule"
	FirewallPolicyRuleTypeNatRule         FirewallPolicyRuleType = "NatRule"
	FirewallPolicyRuleTypeNetworkRule     FirewallPolicyRuleType = "NetworkRule"
)

func (*FirewallPolicyRuleType) UnmarshalJSON

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

type GetOperationResponse

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

type ListCompleteResult

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

type ListOperationResponse

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

type NatRule

type NatRule struct {
	DestinationAddresses *[]string                            `json:"destinationAddresses,omitempty"`
	DestinationPorts     *[]string                            `json:"destinationPorts,omitempty"`
	IPProtocols          *[]FirewallPolicyRuleNetworkProtocol `json:"ipProtocols,omitempty"`
	SourceAddresses      *[]string                            `json:"sourceAddresses,omitempty"`
	SourceIPGroups       *[]string                            `json:"sourceIpGroups,omitempty"`
	TranslatedAddress    *string                              `json:"translatedAddress,omitempty"`
	TranslatedFqdn       *string                              `json:"translatedFqdn,omitempty"`
	TranslatedPort       *string                              `json:"translatedPort,omitempty"`

	// Fields inherited from FirewallPolicyRule
	Description *string `json:"description,omitempty"`
	Name        *string `json:"name,omitempty"`
}

func (NatRule) MarshalJSON

func (s NatRule) MarshalJSON() ([]byte, error)

type NetworkRule

type NetworkRule struct {
	DestinationAddresses *[]string                            `json:"destinationAddresses,omitempty"`
	DestinationFqdns     *[]string                            `json:"destinationFqdns,omitempty"`
	DestinationIPGroups  *[]string                            `json:"destinationIpGroups,omitempty"`
	DestinationPorts     *[]string                            `json:"destinationPorts,omitempty"`
	IPProtocols          *[]FirewallPolicyRuleNetworkProtocol `json:"ipProtocols,omitempty"`
	SourceAddresses      *[]string                            `json:"sourceAddresses,omitempty"`
	SourceIPGroups       *[]string                            `json:"sourceIpGroups,omitempty"`

	// Fields inherited from FirewallPolicyRule
	Description *string `json:"description,omitempty"`
	Name        *string `json:"name,omitempty"`
}

func (NetworkRule) MarshalJSON

func (s NetworkRule) MarshalJSON() ([]byte, error)

type ProvisioningState

type ProvisioningState string
const (
	ProvisioningStateDeleting  ProvisioningState = "Deleting"
	ProvisioningStateFailed    ProvisioningState = "Failed"
	ProvisioningStateSucceeded ProvisioningState = "Succeeded"
	ProvisioningStateUpdating  ProvisioningState = "Updating"
)

func (*ProvisioningState) UnmarshalJSON

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

type RawFirewallPolicyRuleCollectionImpl

type RawFirewallPolicyRuleCollectionImpl struct {
	Type   string
	Values map[string]interface{}
}

RawFirewallPolicyRuleCollectionImpl is returned when the Discriminated Value doesn't match any of the defined types NOTE: this should only be used when a type isn't defined for this type of Object (as a workaround) and is used only for Deserialization (e.g. this cannot be used as a Request Payload).

type RawFirewallPolicyRuleImpl

type RawFirewallPolicyRuleImpl struct {
	Type   string
	Values map[string]interface{}
}

RawFirewallPolicyRuleImpl is returned when the Discriminated Value doesn't match any of the defined types NOTE: this should only be used when a type isn't defined for this type of Object (as a workaround) and is used only for Deserialization (e.g. this cannot be used as a Request Payload).

type RuleCollectionGroupId

type RuleCollectionGroupId struct {
	SubscriptionId          string
	ResourceGroupName       string
	FirewallPolicyName      string
	RuleCollectionGroupName string
}

RuleCollectionGroupId is a struct representing the Resource ID for a Rule Collection Group

func NewRuleCollectionGroupID

func NewRuleCollectionGroupID(subscriptionId string, resourceGroupName string, firewallPolicyName string, ruleCollectionGroupName string) RuleCollectionGroupId

NewRuleCollectionGroupID returns a new RuleCollectionGroupId struct

func ParseRuleCollectionGroupID

func ParseRuleCollectionGroupID(input string) (*RuleCollectionGroupId, error)

ParseRuleCollectionGroupID parses 'input' into a RuleCollectionGroupId

func ParseRuleCollectionGroupIDInsensitively

func ParseRuleCollectionGroupIDInsensitively(input string) (*RuleCollectionGroupId, error)

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

func (*RuleCollectionGroupId) FromParseResult

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

func (RuleCollectionGroupId) ID

func (id RuleCollectionGroupId) ID() string

ID returns the formatted Rule Collection Group ID

func (RuleCollectionGroupId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Rule Collection Group ID

func (RuleCollectionGroupId) String

func (id RuleCollectionGroupId) String() string

String returns a human-readable description of this Rule Collection Group ID

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL