networkmanageractiveconfigurations

package
v0.20241209.1115630 Latest Latest
Warning

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

 Go to latest Published: Dec 9, 2024 License: MPL-2.0 Imports: 13 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/network/2024-01-01/networkmanageractiveconfigurations Documentation

The networkmanageractiveconfigurations SDK allows for interaction with Azure Resource Manager network (API Version 2024-01-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/2024-01-01/networkmanageractiveconfigurations"

Client Initialization

client := networkmanageractiveconfigurations.NewNetworkManagerActiveConfigurationsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: NetworkManagerActiveConfigurationsClient.ListActiveSecurityAdminRules

ctx := context.TODO()
id := networkmanageractiveconfigurations.NewNetworkManagerID("12345678-1234-9876-4563-123456789012", "example-resource-group", "networkManagerName")

payload := networkmanageractiveconfigurations.ActiveConfigurationParameter{
	// ...
}


read, err := client.ListActiveSecurityAdminRules(ctx, id, payload)
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 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

func ValidateNetworkManagerID 

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

ValidateNetworkManagerID checks that 'input' can be parsed as a Network Manager ID

Types

type ActiveBaseSecurityAdminRule 

type ActiveBaseSecurityAdminRule interface {
	ActiveBaseSecurityAdminRule() BaseActiveBaseSecurityAdminRuleImpl
}

func UnmarshalActiveBaseSecurityAdminRuleImplementation added in v0.20240920.1135249 

func UnmarshalActiveBaseSecurityAdminRuleImplementation(input []byte) (ActiveBaseSecurityAdminRule, error)

type ActiveConfigurationParameter 

type ActiveConfigurationParameter struct {
	Regions   *[]string `json:"regions,omitempty"`
	SkipToken *string   `json:"skipToken,omitempty"`
}

type ActiveDefaultSecurityAdminRule 

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

	CommitTime                    *string                            `json:"commitTime,omitempty"`
	ConfigurationDescription      *string                            `json:"configurationDescription,omitempty"`
	Id                            *string                            `json:"id,omitempty"`
	Kind                          EffectiveAdminRuleKind             `json:"kind"`
	Region                        *string                            `json:"region,omitempty"`
	RuleCollectionAppliesToGroups *[]NetworkManagerSecurityGroupItem `json:"ruleCollectionAppliesToGroups,omitempty"`
	RuleCollectionDescription     *string                            `json:"ruleCollectionDescription,omitempty"`
	RuleGroups                    *[]ConfigurationGroup              `json:"ruleGroups,omitempty"`
}

func (ActiveDefaultSecurityAdminRule) ActiveBaseSecurityAdminRule added in v0.20240920.1135249 

func (s ActiveDefaultSecurityAdminRule) ActiveBaseSecurityAdminRule() BaseActiveBaseSecurityAdminRuleImpl

func (*ActiveDefaultSecurityAdminRule) GetCommitTimeAsTime 

func (o *ActiveDefaultSecurityAdminRule) GetCommitTimeAsTime() (*time.Time, error)

func (ActiveDefaultSecurityAdminRule) MarshalJSON 

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

func (*ActiveDefaultSecurityAdminRule) SetCommitTimeAsTime 

func (o *ActiveDefaultSecurityAdminRule) SetCommitTimeAsTime(input time.Time)

type ActiveSecurityAdminRule 

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

	CommitTime                    *string                            `json:"commitTime,omitempty"`
	ConfigurationDescription      *string                            `json:"configurationDescription,omitempty"`
	Id                            *string                            `json:"id,omitempty"`
	Kind                          EffectiveAdminRuleKind             `json:"kind"`
	Region                        *string                            `json:"region,omitempty"`
	RuleCollectionAppliesToGroups *[]NetworkManagerSecurityGroupItem `json:"ruleCollectionAppliesToGroups,omitempty"`
	RuleCollectionDescription     *string                            `json:"ruleCollectionDescription,omitempty"`
	RuleGroups                    *[]ConfigurationGroup              `json:"ruleGroups,omitempty"`
}

func (ActiveSecurityAdminRule) ActiveBaseSecurityAdminRule added in v0.20240920.1135249 

func (s ActiveSecurityAdminRule) ActiveBaseSecurityAdminRule() BaseActiveBaseSecurityAdminRuleImpl

func (*ActiveSecurityAdminRule) GetCommitTimeAsTime 

func (o *ActiveSecurityAdminRule) GetCommitTimeAsTime() (*time.Time, error)

func (ActiveSecurityAdminRule) MarshalJSON 

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

func (*ActiveSecurityAdminRule) SetCommitTimeAsTime 

func (o *ActiveSecurityAdminRule) SetCommitTimeAsTime(input time.Time)

type ActiveSecurityAdminRulesListResult 

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

func (*ActiveSecurityAdminRulesListResult) UnmarshalJSON 

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

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 BaseActiveBaseSecurityAdminRuleImpl added in v0.20240920.1135249 

type BaseActiveBaseSecurityAdminRuleImpl struct {
	CommitTime                    *string                            `json:"commitTime,omitempty"`
	ConfigurationDescription      *string                            `json:"configurationDescription,omitempty"`
	Id                            *string                            `json:"id,omitempty"`
	Kind                          EffectiveAdminRuleKind             `json:"kind"`
	Region                        *string                            `json:"region,omitempty"`
	RuleCollectionAppliesToGroups *[]NetworkManagerSecurityGroupItem `json:"ruleCollectionAppliesToGroups,omitempty"`
	RuleCollectionDescription     *string                            `json:"ruleCollectionDescription,omitempty"`
	RuleGroups                    *[]ConfigurationGroup              `json:"ruleGroups,omitempty"`
}

func (BaseActiveBaseSecurityAdminRuleImpl) ActiveBaseSecurityAdminRule added in v0.20240920.1135249 

func (s BaseActiveBaseSecurityAdminRuleImpl) ActiveBaseSecurityAdminRule() BaseActiveBaseSecurityAdminRuleImpl

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 ListActiveSecurityAdminRulesOperationResponse 

type ListActiveSecurityAdminRulesOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ActiveSecurityAdminRulesListResult
}

type NetworkGroupProperties 

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

type NetworkManagerActiveConfigurationsClient 

type NetworkManagerActiveConfigurationsClient struct {
	Client *resourcemanager.Client
}

func NewNetworkManagerActiveConfigurationsClientWithBaseURI 

func NewNetworkManagerActiveConfigurationsClientWithBaseURI(sdkApi sdkEnv.Api) (*NetworkManagerActiveConfigurationsClient, error)

func (NetworkManagerActiveConfigurationsClient) ListActiveSecurityAdminRules 

func (c NetworkManagerActiveConfigurationsClient) ListActiveSecurityAdminRules(ctx context.Context, id NetworkManagerId, input ActiveConfigurationParameter) (result ListActiveSecurityAdminRulesOperationResponse, err error)

ListActiveSecurityAdminRules ...

type NetworkManagerId 

type NetworkManagerId struct {
	SubscriptionId     string
	ResourceGroupName  string
	NetworkManagerName string
}

NetworkManagerId is a struct representing the Resource ID for a Network Manager

func NewNetworkManagerID 

func NewNetworkManagerID(subscriptionId string, resourceGroupName string, networkManagerName string) NetworkManagerId

NewNetworkManagerID returns a new NetworkManagerId struct

func ParseNetworkManagerID 

func ParseNetworkManagerID(input string) (*NetworkManagerId, error)

ParseNetworkManagerID parses 'input' into a NetworkManagerId

func ParseNetworkManagerIDInsensitively 

func ParseNetworkManagerIDInsensitively(input string) (*NetworkManagerId, error)

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

func (*NetworkManagerId) FromParseResult 

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

func (NetworkManagerId) ID 

func (id NetworkManagerId) ID() string

ID returns the formatted Network Manager ID

func (NetworkManagerId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Network Manager ID

func (NetworkManagerId) String 

func (id NetworkManagerId) String() string

String returns a human-readable description of this Network Manager ID

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 RawActiveBaseSecurityAdminRuleImpl 

type RawActiveBaseSecurityAdminRuleImpl struct {
	Type   string
	Values map[string]interface{}
	// contains filtered or unexported fields
}

RawActiveBaseSecurityAdminRuleImpl 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).

func (RawActiveBaseSecurityAdminRuleImpl) ActiveBaseSecurityAdminRule added in v0.20240920.1135249 

func (s RawActiveBaseSecurityAdminRuleImpl) ActiveBaseSecurityAdminRule() BaseActiveBaseSecurityAdminRuleImpl

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

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.