networkrulesets

README

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

The networkrulesets SDK allows for interaction with the Azure Resource Manager Service eventhub (API Version 2021-11-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/2021-11-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", "namespaceValue")

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", "namespaceValue")

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", "namespaceValue")

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

Documentation

Index

• func PossibleValuesForDefaultAction() []string
• func PossibleValuesForNetworkRuleIPAction() []string
• func PossibleValuesForPublicNetworkAccessFlag() []string
• func ValidateNamespaceID(input interface{}, key string) (warnings []string, errors []error)
• type DefaultAction
  • func (s *DefaultAction) UnmarshalJSON(bytes []byte) error
• type NWRuleSetIPRules
• type NWRuleSetVirtualNetworkRules
• type NamespaceId
  • func NewNamespaceID(subscriptionId string, resourceGroupName string, namespaceName string) NamespaceId
  • func ParseNamespaceID(input string) (*NamespaceId, error)
  • func ParseNamespaceIDInsensitively(input string) (*NamespaceId, error)
  • func (id NamespaceId) ID() string
  • func (id NamespaceId) Segments() []resourceids.Segment
  • func (id NamespaceId) String() string
• type NamespacesCreateOrUpdateNetworkRuleSetOperationResponse
• type NamespacesGetNetworkRuleSetOperationResponse
• type NamespacesListNetworkRuleSetOperationResponse
• type NetworkRuleIPAction
  • func (s *NetworkRuleIPAction) UnmarshalJSON(bytes []byte) error
• type NetworkRuleSet
• type NetworkRuleSetListResult
• type NetworkRuleSetProperties
• type NetworkRuleSetsClient
  • func NewNetworkRuleSetsClientWithBaseURI(sdkApi sdkEnv.Api) (*NetworkRuleSetsClient, error)
  • func (c NetworkRuleSetsClient) NamespacesCreateOrUpdateNetworkRuleSet(ctx context.Context, id NamespaceId, input NetworkRuleSet) (result NamespacesCreateOrUpdateNetworkRuleSetOperationResponse, err error)
  • func (c NetworkRuleSetsClient) NamespacesGetNetworkRuleSet(ctx context.Context, id NamespaceId) (result NamespacesGetNetworkRuleSetOperationResponse, err error)
  • func (c NetworkRuleSetsClient) NamespacesListNetworkRuleSet(ctx context.Context, id NamespaceId) (result NamespacesListNetworkRuleSetOperationResponse, err error)
• type PublicNetworkAccessFlag
  • func (s *PublicNetworkAccessFlag) UnmarshalJSON(bytes []byte) error
• type Subnet

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) 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 NamespacesListNetworkRuleSetOperationResponse

type NamespacesListNetworkRuleSetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *NetworkRuleSetListResult
}

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 NetworkRuleSetListResult

type NetworkRuleSetListResult struct {
	NextLink *string           `json:"nextLink,omitempty"`
	Value    *[]NetworkRuleSet `json:"value,omitempty"`
}

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

type PublicNetworkAccessFlag

type PublicNetworkAccessFlag string

const (
	PublicNetworkAccessFlagDisabled PublicNetworkAccessFlag = "Disabled"
	PublicNetworkAccessFlagEnabled  PublicNetworkAccessFlag = "Enabled"
)

func (*PublicNetworkAccessFlag) UnmarshalJSON

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

type Subnet

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