networkrulesets

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: 12 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/eventhub/2024-01-01/networkrulesets Documentation

The networkrulesets SDK allows for interaction with Azure Resource Manager eventhub (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/eventhub/2024-01-01/networkrulesets"

Client Initialization

client := networkrulesets.NewNetworkRuleSetsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: NetworkRuleSetsClient.NamespacesCreateOrUpdateNetworkRuleSet

ctx := context.TODO()
id := networkrulesets.NewNamespaceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "namespaceName")

payload := networkrulesets.NetworkRuleSet{
	// ...
}


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

Example Usage: NetworkRuleSetsClient.NamespacesGetNetworkRuleSet

ctx := context.TODO()
id := networkrulesets.NewNamespaceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "namespaceName")

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

Example Usage: NetworkRuleSetsClient.NamespacesListNetworkRuleSet

ctx := context.TODO()
id := networkrulesets.NewNamespaceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "namespaceName")

// alternatively `client.NamespacesListNetworkRuleSet(ctx, id)` can be used to do batched pagination
items, err := client.NamespacesListNetworkRuleSetComplete(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 PossibleValuesForDefaultAction 

func PossibleValuesForDefaultAction() []string

func PossibleValuesForNetworkRuleIPAction 

func PossibleValuesForNetworkRuleIPAction() []string

func PossibleValuesForPublicNetworkAccessFlag 

func PossibleValuesForPublicNetworkAccessFlag() []string

func ValidateNamespaceID 

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

ValidateNamespaceID checks that 'input' can be parsed as a Namespace ID

Types

type DefaultAction 

type DefaultAction string
const (
	DefaultActionAllow DefaultAction = "Allow"
	DefaultActionDeny  DefaultAction = "Deny"
)

func (*DefaultAction) UnmarshalJSON 

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

type NWRuleSetIPRules 

type NWRuleSetIPRules struct {
	Action *NetworkRuleIPAction `json:"action,omitempty"`
	IPMask *string              `json:"ipMask,omitempty"`
}

type NWRuleSetVirtualNetworkRules 

type NWRuleSetVirtualNetworkRules struct {
	IgnoreMissingVnetServiceEndpoint *bool   `json:"ignoreMissingVnetServiceEndpoint,omitempty"`
	Subnet                           *Subnet `json:"subnet,omitempty"`
}

type NamespaceId 

type NamespaceId struct {
	SubscriptionId    string
	ResourceGroupName string
	NamespaceName     string
}

NamespaceId is a struct representing the Resource ID for a Namespace

func NewNamespaceID 

func NewNamespaceID(subscriptionId string, resourceGroupName string, namespaceName string) NamespaceId

NewNamespaceID returns a new NamespaceId struct

func ParseNamespaceID 

func ParseNamespaceID(input string) (*NamespaceId, error)

ParseNamespaceID parses 'input' into a NamespaceId

func ParseNamespaceIDInsensitively 

func ParseNamespaceIDInsensitively(input string) (*NamespaceId, error)

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

func (*NamespaceId) FromParseResult 

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

func (NamespaceId) ID 

func (id NamespaceId) ID() string

ID returns the formatted Namespace ID

func (NamespaceId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Namespace ID

func (NamespaceId) String 

func (id NamespaceId) String() string

String returns a human-readable description of this Namespace ID

type NamespacesCreateOrUpdateNetworkRuleSetOperationResponse 

type NamespacesCreateOrUpdateNetworkRuleSetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *NetworkRuleSet
}

type NamespacesGetNetworkRuleSetOperationResponse 

type NamespacesGetNetworkRuleSetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *NetworkRuleSet
}

type NamespacesListNetworkRuleSetCompleteResult added in v0.20240226.1173038 

type NamespacesListNetworkRuleSetCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []NetworkRuleSet
}

type NamespacesListNetworkRuleSetCustomPager added in v0.20240628.1153531 

type NamespacesListNetworkRuleSetCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *NamespacesListNetworkRuleSetCustomPager) NextPageLink() *odata.Link

type NamespacesListNetworkRuleSetOperationResponse 

type NamespacesListNetworkRuleSetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]NetworkRuleSet
}

type NetworkRuleIPAction 

type NetworkRuleIPAction string
const (
	NetworkRuleIPActionAllow NetworkRuleIPAction = "Allow"
)

func (*NetworkRuleIPAction) UnmarshalJSON 

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

type NetworkRuleSet 

type NetworkRuleSet struct {
	Id         *string                   `json:"id,omitempty"`
	Location   *string                   `json:"location,omitempty"`
	Name       *string                   `json:"name,omitempty"`
	Properties *NetworkRuleSetProperties `json:"properties,omitempty"`
	SystemData *systemdata.SystemData    `json:"systemData,omitempty"`
	Type       *string                   `json:"type,omitempty"`
}

type NetworkRuleSetOperationPredicate added in v0.20240226.1173038 

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

func (NetworkRuleSetOperationPredicate) Matches added in v0.20240226.1173038 

func (p NetworkRuleSetOperationPredicate) Matches(input NetworkRuleSet) bool

type NetworkRuleSetProperties 

type NetworkRuleSetProperties struct {
	DefaultAction               *DefaultAction                  `json:"defaultAction,omitempty"`
	IPRules                     *[]NWRuleSetIPRules             `json:"ipRules,omitempty"`
	PublicNetworkAccess         *PublicNetworkAccessFlag        `json:"publicNetworkAccess,omitempty"`
	TrustedServiceAccessEnabled *bool                           `json:"trustedServiceAccessEnabled,omitempty"`
	VirtualNetworkRules         *[]NWRuleSetVirtualNetworkRules `json:"virtualNetworkRules,omitempty"`
}

type NetworkRuleSetsClient 

type NetworkRuleSetsClient struct {
	Client *resourcemanager.Client
}

func NewNetworkRuleSetsClientWithBaseURI 

func NewNetworkRuleSetsClientWithBaseURI(sdkApi sdkEnv.Api) (*NetworkRuleSetsClient, error)

func (NetworkRuleSetsClient) NamespacesCreateOrUpdateNetworkRuleSet 

func (c NetworkRuleSetsClient) NamespacesCreateOrUpdateNetworkRuleSet(ctx context.Context, id NamespaceId, input NetworkRuleSet) (result NamespacesCreateOrUpdateNetworkRuleSetOperationResponse, err error)

NamespacesCreateOrUpdateNetworkRuleSet ...

func (NetworkRuleSetsClient) NamespacesGetNetworkRuleSet 

func (c NetworkRuleSetsClient) NamespacesGetNetworkRuleSet(ctx context.Context, id NamespaceId) (result NamespacesGetNetworkRuleSetOperationResponse, err error)

NamespacesGetNetworkRuleSet ...

func (NetworkRuleSetsClient) NamespacesListNetworkRuleSet 

func (c NetworkRuleSetsClient) NamespacesListNetworkRuleSet(ctx context.Context, id NamespaceId) (result NamespacesListNetworkRuleSetOperationResponse, err error)

NamespacesListNetworkRuleSet ...

func (NetworkRuleSetsClient) NamespacesListNetworkRuleSetComplete added in v0.20240226.1173038 

func (c NetworkRuleSetsClient) NamespacesListNetworkRuleSetComplete(ctx context.Context, id NamespaceId) (NamespacesListNetworkRuleSetCompleteResult, error)

NamespacesListNetworkRuleSetComplete retrieves all the results into a single object

func (NetworkRuleSetsClient) NamespacesListNetworkRuleSetCompleteMatchingPredicate added in v0.20240226.1173038 

func (c NetworkRuleSetsClient) NamespacesListNetworkRuleSetCompleteMatchingPredicate(ctx context.Context, id NamespaceId, predicate NetworkRuleSetOperationPredicate) (result NamespacesListNetworkRuleSetCompleteResult, err error)

NamespacesListNetworkRuleSetCompleteMatchingPredicate retrieves all the results and then applies the predicate

type PublicNetworkAccessFlag 

type PublicNetworkAccessFlag string
const (
	PublicNetworkAccessFlagDisabled           PublicNetworkAccessFlag = "Disabled"
	PublicNetworkAccessFlagEnabled            PublicNetworkAccessFlag = "Enabled"
	PublicNetworkAccessFlagSecuredByPerimeter PublicNetworkAccessFlag = "SecuredByPerimeter"
)

func (*PublicNetworkAccessFlag) UnmarshalJSON 

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

type Subnet 

type Subnet struct {
	Id *string `json:"id,omitempty"`
}

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.