networksecurityperimeterconfigurations

package
v0.20241126.1723 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/resource-manager/cognitive/2024-10-01/networksecurityperimeterconfigurations Documentation

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

Client Initialization

client := networksecurityperimeterconfigurations.NewNetworkSecurityPerimeterConfigurationsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: NetworkSecurityPerimeterConfigurationsClient.Get

ctx := context.TODO()
id := networksecurityperimeterconfigurations.NewNetworkSecurityPerimeterConfigurationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "accountName", "networkSecurityPerimeterConfigurationName")

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

ctx := context.TODO()
id := networksecurityperimeterconfigurations.NewAccountID("12345678-1234-9876-4563-123456789012", "example-resource-group", "accountName")

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

Example Usage: NetworkSecurityPerimeterConfigurationsClient.Reconcile

ctx := context.TODO()
id := networksecurityperimeterconfigurations.NewNetworkSecurityPerimeterConfigurationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "accountName", "networkSecurityPerimeterConfigurationName")

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForNspAccessRuleDirection 

func PossibleValuesForNspAccessRuleDirection() []string

func ValidateAccountID 

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

ValidateAccountID checks that 'input' can be parsed as a Account ID

func ValidateNetworkSecurityPerimeterConfigurationID 

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

ValidateNetworkSecurityPerimeterConfigurationID checks that 'input' can be parsed as a Network Security Perimeter Configuration ID

Types

type AccountId 

type AccountId struct {
	SubscriptionId    string
	ResourceGroupName string
	AccountName       string
}

AccountId is a struct representing the Resource ID for a Account

func NewAccountID 

func NewAccountID(subscriptionId string, resourceGroupName string, accountName string) AccountId

NewAccountID returns a new AccountId struct

func ParseAccountID 

func ParseAccountID(input string) (*AccountId, error)

ParseAccountID parses 'input' into a AccountId

func ParseAccountIDInsensitively 

func ParseAccountIDInsensitively(input string) (*AccountId, error)

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

func (*AccountId) FromParseResult 

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

func (AccountId) ID 

func (id AccountId) ID() string

ID returns the formatted Account ID

func (AccountId) Segments 

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

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

func (AccountId) String 

func (id AccountId) String() string

String returns a human-readable description of this Account ID

type GetOperationResponse 

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

type ListCompleteResult 

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

type ListCustomPager 

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

type ListOperationResponse 

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

type NetworkSecurityPerimeter 

type NetworkSecurityPerimeter struct {
	Id            *string `json:"id,omitempty"`
	Location      *string `json:"location,omitempty"`
	PerimeterGuid *string `json:"perimeterGuid,omitempty"`
}

type NetworkSecurityPerimeterAccessRule 

type NetworkSecurityPerimeterAccessRule struct {
	Name       *string                                       `json:"name,omitempty"`
	Properties *NetworkSecurityPerimeterAccessRuleProperties `json:"properties,omitempty"`
}

type NetworkSecurityPerimeterAccessRuleProperties 

type NetworkSecurityPerimeterAccessRuleProperties struct {
	AddressPrefixes           *[]string                                                           `json:"addressPrefixes,omitempty"`
	Direction                 *NspAccessRuleDirection                                             `json:"direction,omitempty"`
	FullyQualifiedDomainNames *[]string                                                           `json:"fullyQualifiedDomainNames,omitempty"`
	NetworkSecurityPerimeters *[]NetworkSecurityPerimeter                                         `json:"networkSecurityPerimeters,omitempty"`
	Subscriptions             *[]NetworkSecurityPerimeterAccessRulePropertiesSubscriptionsInlined `json:"subscriptions,omitempty"`
}

type NetworkSecurityPerimeterAccessRulePropertiesSubscriptionsInlined 

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

type NetworkSecurityPerimeterConfiguration 

type NetworkSecurityPerimeterConfiguration struct {
	Id         *string                                          `json:"id,omitempty"`
	Name       *string                                          `json:"name,omitempty"`
	Properties *NetworkSecurityPerimeterConfigurationProperties `json:"properties,omitempty"`
	Type       *string                                          `json:"type,omitempty"`
}

type NetworkSecurityPerimeterConfigurationAssociationInfo 

type NetworkSecurityPerimeterConfigurationAssociationInfo struct {
	AccessMode *string `json:"accessMode,omitempty"`
	Name       *string `json:"name,omitempty"`
}

type NetworkSecurityPerimeterConfigurationId 

type NetworkSecurityPerimeterConfigurationId struct {
	SubscriptionId                            string
	ResourceGroupName                         string
	AccountName                               string
	NetworkSecurityPerimeterConfigurationName string
}

NetworkSecurityPerimeterConfigurationId is a struct representing the Resource ID for a Network Security Perimeter Configuration

func NewNetworkSecurityPerimeterConfigurationID 

func NewNetworkSecurityPerimeterConfigurationID(subscriptionId string, resourceGroupName string, accountName string, networkSecurityPerimeterConfigurationName string) NetworkSecurityPerimeterConfigurationId

NewNetworkSecurityPerimeterConfigurationID returns a new NetworkSecurityPerimeterConfigurationId struct

func ParseNetworkSecurityPerimeterConfigurationID 

func ParseNetworkSecurityPerimeterConfigurationID(input string) (*NetworkSecurityPerimeterConfigurationId, error)

ParseNetworkSecurityPerimeterConfigurationID parses 'input' into a NetworkSecurityPerimeterConfigurationId

func ParseNetworkSecurityPerimeterConfigurationIDInsensitively 

func ParseNetworkSecurityPerimeterConfigurationIDInsensitively(input string) (*NetworkSecurityPerimeterConfigurationId, error)

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

func (*NetworkSecurityPerimeterConfigurationId) FromParseResult 

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

func (NetworkSecurityPerimeterConfigurationId) ID 

func (id NetworkSecurityPerimeterConfigurationId) ID() string

ID returns the formatted Network Security Perimeter Configuration ID

func (NetworkSecurityPerimeterConfigurationId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Network Security Perimeter Configuration ID

func (NetworkSecurityPerimeterConfigurationId) String 

func (id NetworkSecurityPerimeterConfigurationId) String() string

String returns a human-readable description of this Network Security Perimeter Configuration ID

type NetworkSecurityPerimeterConfigurationOperationPredicate 

type NetworkSecurityPerimeterConfigurationOperationPredicate struct {
	Id   *string
	Name *string
	Type *string
}

func (NetworkSecurityPerimeterConfigurationOperationPredicate) Matches 

func (p NetworkSecurityPerimeterConfigurationOperationPredicate) Matches(input NetworkSecurityPerimeterConfiguration) bool

type NetworkSecurityPerimeterConfigurationProperties 

type NetworkSecurityPerimeterConfigurationProperties struct {
	NetworkSecurityPerimeter *NetworkSecurityPerimeter                             `json:"networkSecurityPerimeter,omitempty"`
	Profile                  *NetworkSecurityPerimeterProfileInfo                  `json:"profile,omitempty"`
	ProvisioningIssues       *[]ProvisioningIssue                                  `json:"provisioningIssues,omitempty"`
	ProvisioningState        *string                                               `json:"provisioningState,omitempty"`
	ResourceAssociation      *NetworkSecurityPerimeterConfigurationAssociationInfo `json:"resourceAssociation,omitempty"`
}

type NetworkSecurityPerimeterConfigurationsClient 

type NetworkSecurityPerimeterConfigurationsClient struct {
	Client *resourcemanager.Client
}

func NewNetworkSecurityPerimeterConfigurationsClientWithBaseURI 

func NewNetworkSecurityPerimeterConfigurationsClientWithBaseURI(sdkApi sdkEnv.Api) (*NetworkSecurityPerimeterConfigurationsClient, error)

func (NetworkSecurityPerimeterConfigurationsClient) Get 

func (c NetworkSecurityPerimeterConfigurationsClient) Get(ctx context.Context, id NetworkSecurityPerimeterConfigurationId) (result GetOperationResponse, err error)

Get ...

func (NetworkSecurityPerimeterConfigurationsClient) List 

func (c NetworkSecurityPerimeterConfigurationsClient) List(ctx context.Context, id AccountId) (result ListOperationResponse, err error)

List ...

func (NetworkSecurityPerimeterConfigurationsClient) ListComplete 

func (c NetworkSecurityPerimeterConfigurationsClient) ListComplete(ctx context.Context, id AccountId) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (NetworkSecurityPerimeterConfigurationsClient) ListCompleteMatchingPredicate 

func (c NetworkSecurityPerimeterConfigurationsClient) ListCompleteMatchingPredicate(ctx context.Context, id AccountId, predicate NetworkSecurityPerimeterConfigurationOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (NetworkSecurityPerimeterConfigurationsClient) Reconcile 

func (c NetworkSecurityPerimeterConfigurationsClient) Reconcile(ctx context.Context, id NetworkSecurityPerimeterConfigurationId) (result ReconcileOperationResponse, err error)

Reconcile ...

func (NetworkSecurityPerimeterConfigurationsClient) ReconcileThenPoll 

func (c NetworkSecurityPerimeterConfigurationsClient) ReconcileThenPoll(ctx context.Context, id NetworkSecurityPerimeterConfigurationId) error

ReconcileThenPoll performs Reconcile then polls until it's completed

type NetworkSecurityPerimeterProfileInfo 

type NetworkSecurityPerimeterProfileInfo struct {
	AccessRules               *[]NetworkSecurityPerimeterAccessRule `json:"accessRules,omitempty"`
	AccessRulesVersion        *int64                                `json:"accessRulesVersion,omitempty"`
	DiagnosticSettingsVersion *int64                                `json:"diagnosticSettingsVersion,omitempty"`
	EnabledLogCategories      *[]string                             `json:"enabledLogCategories,omitempty"`
	Name                      *string                               `json:"name,omitempty"`
}

type NspAccessRuleDirection 

type NspAccessRuleDirection string
const (
	NspAccessRuleDirectionInbound  NspAccessRuleDirection = "Inbound"
	NspAccessRuleDirectionOutbound NspAccessRuleDirection = "Outbound"
)

func (*NspAccessRuleDirection) UnmarshalJSON 

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

type ProvisioningIssue 

type ProvisioningIssue struct {
	Name       *string                      `json:"name,omitempty"`
	Properties *ProvisioningIssueProperties `json:"properties,omitempty"`
}

type ProvisioningIssueProperties 

type ProvisioningIssueProperties struct {
	Description          *string                               `json:"description,omitempty"`
	IssueType            *string                               `json:"issueType,omitempty"`
	Severity             *string                               `json:"severity,omitempty"`
	SuggestedAccessRules *[]NetworkSecurityPerimeterAccessRule `json:"suggestedAccessRules,omitempty"`
	SuggestedResourceIds *[]string                             `json:"suggestedResourceIds,omitempty"`
}

type ReconcileOperationResponse 

type ReconcileOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *NetworkSecurityPerimeterConfiguration
}

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.