networkmanagereffectivesecurityadminrules

README

github.com/hashicorp/go-azure-sdk/resource-manager/network/2023-04-01/networkmanagereffectivesecurityadminrules Documentation

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

Client Initialization

client := networkmanagereffectivesecurityadminrules.NewNetworkManagerEffectiveSecurityAdminRulesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: NetworkManagerEffectiveSecurityAdminRulesClient.ListNetworkManagerEffectiveSecurityAdminRules

ctx := context.TODO()
id := networkmanagereffectivesecurityadminrules.NewVirtualNetworkID("12345678-1234-9876-4563-123456789012", "example-resource-group", "virtualNetworkValue")

payload := networkmanagereffectivesecurityadminrules.QueryRequestOptions{
	// ...
}


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

Documentation

Index

• func PossibleValuesForAddressPrefixType() []string
• func PossibleValuesForEffectiveAdminRuleKind() []string
• func PossibleValuesForProvisioningState() []string
• func PossibleValuesForSecurityConfigurationRuleAccess() []string
• func PossibleValuesForSecurityConfigurationRuleDirection() []string
• func PossibleValuesForSecurityConfigurationRuleProtocol() []string
• type AddressPrefixItem
• type AddressPrefixType
  • func (s *AddressPrefixType) UnmarshalJSON(bytes []byte) error
• type AdminPropertiesFormat
• type ConfigurationGroup
• type DefaultAdminPropertiesFormat
• type EffectiveAdminRuleKind
  • func (s *EffectiveAdminRuleKind) UnmarshalJSON(bytes []byte) error
• type EffectiveBaseSecurityAdminRule
• type EffectiveDefaultSecurityAdminRule
  • func (s EffectiveDefaultSecurityAdminRule) MarshalJSON() ([]byte, error)
• type EffectiveSecurityAdminRule
  • func (s EffectiveSecurityAdminRule) MarshalJSON() ([]byte, error)
• type ListNetworkManagerEffectiveSecurityAdminRulesOperationResponse
• type NetworkGroupProperties
• type NetworkManagerEffectiveSecurityAdminRulesClient
  • func NewNetworkManagerEffectiveSecurityAdminRulesClientWithBaseURI(api environments.Api) (*NetworkManagerEffectiveSecurityAdminRulesClient, error)
  • func (c NetworkManagerEffectiveSecurityAdminRulesClient) ListNetworkManagerEffectiveSecurityAdminRules(ctx context.Context, id commonids.VirtualNetworkId, input QueryRequestOptions) (result ListNetworkManagerEffectiveSecurityAdminRulesOperationResponse, ...)
• type NetworkManagerEffectiveSecurityAdminRulesListResult
  • func (s *NetworkManagerEffectiveSecurityAdminRulesListResult) UnmarshalJSON(bytes []byte) error
• type NetworkManagerSecurityGroupItem
• type ProvisioningState
  • func (s *ProvisioningState) UnmarshalJSON(bytes []byte) error
• type QueryRequestOptions
• type SecurityConfigurationRuleAccess
  • func (s *SecurityConfigurationRuleAccess) UnmarshalJSON(bytes []byte) error
• type SecurityConfigurationRuleDirection
  • func (s *SecurityConfigurationRuleDirection) UnmarshalJSON(bytes []byte) error
• type SecurityConfigurationRuleProtocol
  • func (s *SecurityConfigurationRuleProtocol) UnmarshalJSON(bytes []byte) error

Functions

func PossibleValuesForAddressPrefixType

func PossibleValuesForAddressPrefixType() []string

func PossibleValuesForEffectiveAdminRuleKind

func PossibleValuesForEffectiveAdminRuleKind() []string

func PossibleValuesForProvisioningState

func PossibleValuesForProvisioningState() []string

func PossibleValuesForSecurityConfigurationRuleAccess

func PossibleValuesForSecurityConfigurationRuleAccess() []string

func PossibleValuesForSecurityConfigurationRuleDirection

func PossibleValuesForSecurityConfigurationRuleDirection() []string

func PossibleValuesForSecurityConfigurationRuleProtocol

func PossibleValuesForSecurityConfigurationRuleProtocol() []string

Types

type AddressPrefixItem

type AddressPrefixItem struct {
	AddressPrefix     *string            `json:"addressPrefix,omitempty"`
	AddressPrefixType *AddressPrefixType `json:"addressPrefixType,omitempty"`
}

type AddressPrefixType

type AddressPrefixType string

const (
	AddressPrefixTypeIPPrefix   AddressPrefixType = "IPPrefix"
	AddressPrefixTypeServiceTag AddressPrefixType = "ServiceTag"
)

func (*AddressPrefixType) UnmarshalJSON

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

type AdminPropertiesFormat

type AdminPropertiesFormat struct {
	Access                SecurityConfigurationRuleAccess    `json:"access"`
	Description           *string                            `json:"description,omitempty"`
	DestinationPortRanges *[]string                          `json:"destinationPortRanges,omitempty"`
	Destinations          *[]AddressPrefixItem               `json:"destinations,omitempty"`
	Direction             SecurityConfigurationRuleDirection `json:"direction"`
	Priority              int64                              `json:"priority"`
	Protocol              SecurityConfigurationRuleProtocol  `json:"protocol"`
	ProvisioningState     *ProvisioningState                 `json:"provisioningState,omitempty"`
	ResourceGuid          *string                            `json:"resourceGuid,omitempty"`
	SourcePortRanges      *[]string                          `json:"sourcePortRanges,omitempty"`
	Sources               *[]AddressPrefixItem               `json:"sources,omitempty"`
}

type ConfigurationGroup

type ConfigurationGroup struct {
	Id         *string                 `json:"id,omitempty"`
	Properties *NetworkGroupProperties `json:"properties,omitempty"`
}

type DefaultAdminPropertiesFormat

type DefaultAdminPropertiesFormat struct {
	Access                *SecurityConfigurationRuleAccess    `json:"access,omitempty"`
	Description           *string                             `json:"description,omitempty"`
	DestinationPortRanges *[]string                           `json:"destinationPortRanges,omitempty"`
	Destinations          *[]AddressPrefixItem                `json:"destinations,omitempty"`
	Direction             *SecurityConfigurationRuleDirection `json:"direction,omitempty"`
	Flag                  *string                             `json:"flag,omitempty"`
	Priority              *int64                              `json:"priority,omitempty"`
	Protocol              *SecurityConfigurationRuleProtocol  `json:"protocol,omitempty"`
	ProvisioningState     *ProvisioningState                  `json:"provisioningState,omitempty"`
	ResourceGuid          *string                             `json:"resourceGuid,omitempty"`
	SourcePortRanges      *[]string                           `json:"sourcePortRanges,omitempty"`
	Sources               *[]AddressPrefixItem                `json:"sources,omitempty"`
}

type EffectiveAdminRuleKind

type EffectiveAdminRuleKind string

const (
	EffectiveAdminRuleKindCustom  EffectiveAdminRuleKind = "Custom"
	EffectiveAdminRuleKindDefault EffectiveAdminRuleKind = "Default"
)

func (*EffectiveAdminRuleKind) UnmarshalJSON

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

type EffectiveBaseSecurityAdminRule

type EffectiveBaseSecurityAdminRule interface {
}

type EffectiveDefaultSecurityAdminRule

type EffectiveDefaultSecurityAdminRule struct {
	Properties *DefaultAdminPropertiesFormat `json:"properties,omitempty"`

	// Fields inherited from EffectiveBaseSecurityAdminRule
	ConfigurationDescription      *string                            `json:"configurationDescription,omitempty"`
	Id                            *string                            `json:"id,omitempty"`
	RuleCollectionAppliesToGroups *[]NetworkManagerSecurityGroupItem `json:"ruleCollectionAppliesToGroups,omitempty"`
	RuleCollectionDescription     *string                            `json:"ruleCollectionDescription,omitempty"`
	RuleGroups                    *[]ConfigurationGroup              `json:"ruleGroups,omitempty"`
}

func (EffectiveDefaultSecurityAdminRule) MarshalJSON

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

type EffectiveSecurityAdminRule

type EffectiveSecurityAdminRule struct {
	Properties *AdminPropertiesFormat `json:"properties,omitempty"`

	// Fields inherited from EffectiveBaseSecurityAdminRule
	ConfigurationDescription      *string                            `json:"configurationDescription,omitempty"`
	Id                            *string                            `json:"id,omitempty"`
	RuleCollectionAppliesToGroups *[]NetworkManagerSecurityGroupItem `json:"ruleCollectionAppliesToGroups,omitempty"`
	RuleCollectionDescription     *string                            `json:"ruleCollectionDescription,omitempty"`
	RuleGroups                    *[]ConfigurationGroup              `json:"ruleGroups,omitempty"`
}

func (EffectiveSecurityAdminRule) MarshalJSON

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

type ListNetworkManagerEffectiveSecurityAdminRulesOperationResponse

type ListNetworkManagerEffectiveSecurityAdminRulesOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *NetworkManagerEffectiveSecurityAdminRulesListResult
}

type NetworkGroupProperties

type NetworkGroupProperties struct {
	Description       *string            `json:"description,omitempty"`
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty"`
	ResourceGuid      *string            `json:"resourceGuid,omitempty"`
}

type NetworkManagerEffectiveSecurityAdminRulesClient

type NetworkManagerEffectiveSecurityAdminRulesClient struct {
	Client *resourcemanager.Client
}

func NewNetworkManagerEffectiveSecurityAdminRulesClientWithBaseURI

func NewNetworkManagerEffectiveSecurityAdminRulesClientWithBaseURI(api environments.Api) (*NetworkManagerEffectiveSecurityAdminRulesClient, error)

func (NetworkManagerEffectiveSecurityAdminRulesClient) ListNetworkManagerEffectiveSecurityAdminRules

func (c NetworkManagerEffectiveSecurityAdminRulesClient) ListNetworkManagerEffectiveSecurityAdminRules(ctx context.Context, id commonids.VirtualNetworkId, input QueryRequestOptions) (result ListNetworkManagerEffectiveSecurityAdminRulesOperationResponse, err error)

ListNetworkManagerEffectiveSecurityAdminRules ...

type NetworkManagerEffectiveSecurityAdminRulesListResult

type NetworkManagerEffectiveSecurityAdminRulesListResult struct {
	SkipToken *string                           `json:"skipToken,omitempty"`
	Value     *[]EffectiveBaseSecurityAdminRule `json:"value,omitempty"`
}

func (*NetworkManagerEffectiveSecurityAdminRulesListResult) UnmarshalJSON

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

type NetworkManagerSecurityGroupItem

type NetworkManagerSecurityGroupItem struct {
	NetworkGroupId string `json:"networkGroupId"`
}

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 QueryRequestOptions

type QueryRequestOptions struct {
	SkipToken *string `json:"skipToken,omitempty"`
}

type SecurityConfigurationRuleAccess

type SecurityConfigurationRuleAccess string

const (
	SecurityConfigurationRuleAccessAllow       SecurityConfigurationRuleAccess = "Allow"
	SecurityConfigurationRuleAccessAlwaysAllow SecurityConfigurationRuleAccess = "AlwaysAllow"
	SecurityConfigurationRuleAccessDeny        SecurityConfigurationRuleAccess = "Deny"
)

func (*SecurityConfigurationRuleAccess) UnmarshalJSON

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

type SecurityConfigurationRuleDirection

type SecurityConfigurationRuleDirection string

const (
	SecurityConfigurationRuleDirectionInbound  SecurityConfigurationRuleDirection = "Inbound"
	SecurityConfigurationRuleDirectionOutbound SecurityConfigurationRuleDirection = "Outbound"
)

func (*SecurityConfigurationRuleDirection) UnmarshalJSON

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

type SecurityConfigurationRuleProtocol

type SecurityConfigurationRuleProtocol string

const (
	SecurityConfigurationRuleProtocolAh   SecurityConfigurationRuleProtocol = "Ah"
	SecurityConfigurationRuleProtocolAny  SecurityConfigurationRuleProtocol = "Any"
	SecurityConfigurationRuleProtocolEsp  SecurityConfigurationRuleProtocol = "Esp"
	SecurityConfigurationRuleProtocolIcmp SecurityConfigurationRuleProtocol = "Icmp"
	SecurityConfigurationRuleProtocolTcp  SecurityConfigurationRuleProtocol = "Tcp"
	SecurityConfigurationRuleProtocolUdp  SecurityConfigurationRuleProtocol = "Udp"
)

func (*SecurityConfigurationRuleProtocol) UnmarshalJSON

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