networksecurityperimeterconfigurations

package
v0.20241126.2320 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: 11 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/search/2024-06-01-preview/networksecurityperimeterconfigurations Documentation

The networksecurityperimeterconfigurations SDK allows for interaction with Azure Resource Manager search (API Version 2024-06-01-preview).

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/search/2024-06-01-preview/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", "searchServiceName", "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.ListByService

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

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

func ValidateSearchServiceID 

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

ValidateSearchServiceID checks that 'input' can be parsed as a Search Service ID

Types

type GetOperationResponse 

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

type ListByServiceCompleteResult 

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

type ListByServiceCustomPager 

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

type ListByServiceOperationResponse 

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

type NSPConfigAccessRule 

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

type NSPConfigAccessRuleProperties 

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

type NSPConfigAssociation 

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

type NSPConfigNetworkSecurityPerimeterRule 

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

type NSPConfigPerimeter 

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

type NSPConfigProfile 

type NSPConfigProfile struct {
	AccessRules        *[]NSPConfigAccessRule `json:"accessRules,omitempty"`
	AccessRulesVersion *string                `json:"accessRulesVersion,omitempty"`
	Name               *string                `json:"name,omitempty"`
}

type NSPProvisioningIssue 

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

type NSPProvisioningIssueProperties 

type NSPProvisioningIssueProperties struct {
	Description          *string   `json:"description,omitempty"`
	IssueType            *string   `json:"issueType,omitempty"`
	Severity             *string   `json:"severity,omitempty"`
	SuggestedAccessRules *[]string `json:"suggestedAccessRules,omitempty"`
	SuggestedResourceIds *[]string `json:"suggestedResourceIds,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 NetworkSecurityPerimeterConfigurationId 

type NetworkSecurityPerimeterConfigurationId struct {
	SubscriptionId                            string
	ResourceGroupName                         string
	SearchServiceName                         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, searchServiceName 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 *NSPConfigPerimeter     `json:"networkSecurityPerimeter,omitempty"`
	Profile                  *NSPConfigProfile       `json:"profile,omitempty"`
	ProvisioningIssues       *[]NSPProvisioningIssue `json:"provisioningIssues,omitempty"`
	ProvisioningState        *string                 `json:"provisioningState,omitempty"`
	ResourceAssociation      *NSPConfigAssociation   `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) ListByService 

func (c NetworkSecurityPerimeterConfigurationsClient) ListByService(ctx context.Context, id SearchServiceId) (result ListByServiceOperationResponse, err error)

ListByService ...

func (NetworkSecurityPerimeterConfigurationsClient) ListByServiceComplete 

func (c NetworkSecurityPerimeterConfigurationsClient) ListByServiceComplete(ctx context.Context, id SearchServiceId) (ListByServiceCompleteResult, error)

ListByServiceComplete retrieves all the results into a single object

func (NetworkSecurityPerimeterConfigurationsClient) ListByServiceCompleteMatchingPredicate 

func (c NetworkSecurityPerimeterConfigurationsClient) ListByServiceCompleteMatchingPredicate(ctx context.Context, id SearchServiceId, predicate NetworkSecurityPerimeterConfigurationOperationPredicate) (result ListByServiceCompleteResult, err error)

ListByServiceCompleteMatchingPredicate 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 ReconcileOperationResponse 

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

type SearchServiceId 

type SearchServiceId struct {
	SubscriptionId    string
	ResourceGroupName string
	SearchServiceName string
}

SearchServiceId is a struct representing the Resource ID for a Search Service

func NewSearchServiceID 

func NewSearchServiceID(subscriptionId string, resourceGroupName string, searchServiceName string) SearchServiceId

NewSearchServiceID returns a new SearchServiceId struct

func ParseSearchServiceID 

func ParseSearchServiceID(input string) (*SearchServiceId, error)

ParseSearchServiceID parses 'input' into a SearchServiceId

func ParseSearchServiceIDInsensitively 

func ParseSearchServiceIDInsensitively(input string) (*SearchServiceId, error)

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

func (*SearchServiceId) FromParseResult 

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

func (SearchServiceId) ID 

func (id SearchServiceId) ID() string

ID returns the formatted Search Service ID

func (SearchServiceId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Search Service ID

func (SearchServiceId) String 

func (id SearchServiceId) String() string

String returns a human-readable description of this Search Service ID

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.