networksecurityperimeter

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: 13 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/batch/2024-07-01/networksecurityperimeter Documentation

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

Client Initialization

client := networksecurityperimeter.NewNetworkSecurityPerimeterClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: NetworkSecurityPerimeterClient.GetConfiguration

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

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

Example Usage: NetworkSecurityPerimeterClient.ListConfigurations

ctx := context.TODO()
id := networksecurityperimeter.NewBatchAccountID("12345678-1234-9876-4563-123456789012", "example-resource-group", "batchAccountName")

// alternatively `client.ListConfigurations(ctx, id)` can be used to do batched pagination
items, err := client.ListConfigurationsComplete(ctx, id)
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: NetworkSecurityPerimeterClient.ReconcileConfiguration

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

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForAccessRuleDirection 

func PossibleValuesForAccessRuleDirection() []string

func PossibleValuesForIssueType 

func PossibleValuesForIssueType() []string

func PossibleValuesForNetworkSecurityPerimeterConfigurationProvisioningState 

func PossibleValuesForNetworkSecurityPerimeterConfigurationProvisioningState() []string

func PossibleValuesForResourceAssociationAccessMode 

func PossibleValuesForResourceAssociationAccessMode() []string

func PossibleValuesForSeverity 

func PossibleValuesForSeverity() []string

func ValidateBatchAccountID 

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

ValidateBatchAccountID checks that 'input' can be parsed as a Batch 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 AccessRule 

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

type AccessRuleDirection 

type AccessRuleDirection string
const (
	AccessRuleDirectionInbound  AccessRuleDirection = "Inbound"
	AccessRuleDirectionOutbound AccessRuleDirection = "Outbound"
)

func (*AccessRuleDirection) UnmarshalJSON 

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

type AccessRuleProperties 

type AccessRuleProperties struct {
	AddressPrefixes           *[]string                                   `json:"addressPrefixes,omitempty"`
	Direction                 *AccessRuleDirection                        `json:"direction,omitempty"`
	EmailAddresses            *[]string                                   `json:"emailAddresses,omitempty"`
	FullyQualifiedDomainNames *[]string                                   `json:"fullyQualifiedDomainNames,omitempty"`
	NetworkSecurityPerimeters *[]NetworkSecurityPerimeter                 `json:"networkSecurityPerimeters,omitempty"`
	PhoneNumbers              *[]string                                   `json:"phoneNumbers,omitempty"`
	Subscriptions             *[]AccessRulePropertiesSubscriptionsInlined `json:"subscriptions,omitempty"`
}

type AccessRulePropertiesSubscriptionsInlined 

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

type BatchAccountId 

type BatchAccountId struct {
	SubscriptionId    string
	ResourceGroupName string
	BatchAccountName  string
}

BatchAccountId is a struct representing the Resource ID for a Batch Account

func NewBatchAccountID 

func NewBatchAccountID(subscriptionId string, resourceGroupName string, batchAccountName string) BatchAccountId

NewBatchAccountID returns a new BatchAccountId struct

func ParseBatchAccountID 

func ParseBatchAccountID(input string) (*BatchAccountId, error)

ParseBatchAccountID parses 'input' into a BatchAccountId

func ParseBatchAccountIDInsensitively 

func ParseBatchAccountIDInsensitively(input string) (*BatchAccountId, error)

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

func (*BatchAccountId) FromParseResult 

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

func (BatchAccountId) ID 

func (id BatchAccountId) ID() string

ID returns the formatted Batch Account ID

func (BatchAccountId) Segments 

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

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

func (BatchAccountId) String 

func (id BatchAccountId) String() string

String returns a human-readable description of this Batch Account ID

type GetConfigurationOperationResponse 

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

type IssueType 

type IssueType string
const (
	IssueTypeConfigurationPropagationFailure IssueType = "ConfigurationPropagationFailure"
	IssueTypeMissingIdentityConfiguration    IssueType = "MissingIdentityConfiguration"
	IssueTypeMissingPerimeterConfiguration   IssueType = "MissingPerimeterConfiguration"
	IssueTypeUnknown                         IssueType = "Unknown"
)

func (*IssueType) UnmarshalJSON 

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

type ListConfigurationsCompleteResult 

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

type ListConfigurationsCustomPager 

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

type ListConfigurationsOperationResponse 

type ListConfigurationsOperationResponse 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 NetworkSecurityPerimeterClient 

type NetworkSecurityPerimeterClient struct {
	Client *resourcemanager.Client
}

func NewNetworkSecurityPerimeterClientWithBaseURI 

func NewNetworkSecurityPerimeterClientWithBaseURI(sdkApi sdkEnv.Api) (*NetworkSecurityPerimeterClient, error)

func (NetworkSecurityPerimeterClient) GetConfiguration 

func (c NetworkSecurityPerimeterClient) GetConfiguration(ctx context.Context, id NetworkSecurityPerimeterConfigurationId) (result GetConfigurationOperationResponse, err error)

GetConfiguration ...

func (NetworkSecurityPerimeterClient) ListConfigurations 

func (c NetworkSecurityPerimeterClient) ListConfigurations(ctx context.Context, id BatchAccountId) (result ListConfigurationsOperationResponse, err error)

ListConfigurations ...

func (NetworkSecurityPerimeterClient) ListConfigurationsComplete 

func (c NetworkSecurityPerimeterClient) ListConfigurationsComplete(ctx context.Context, id BatchAccountId) (ListConfigurationsCompleteResult, error)

ListConfigurationsComplete retrieves all the results into a single object

func (NetworkSecurityPerimeterClient) ListConfigurationsCompleteMatchingPredicate 

func (c NetworkSecurityPerimeterClient) ListConfigurationsCompleteMatchingPredicate(ctx context.Context, id BatchAccountId, predicate NetworkSecurityPerimeterConfigurationOperationPredicate) (result ListConfigurationsCompleteResult, err error)

ListConfigurationsCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (NetworkSecurityPerimeterClient) ReconcileConfiguration 

func (c NetworkSecurityPerimeterClient) ReconcileConfiguration(ctx context.Context, id NetworkSecurityPerimeterConfigurationId) (result ReconcileConfigurationOperationResponse, err error)

ReconcileConfiguration ...

func (NetworkSecurityPerimeterClient) ReconcileConfigurationThenPoll 

func (c NetworkSecurityPerimeterClient) ReconcileConfigurationThenPoll(ctx context.Context, id NetworkSecurityPerimeterConfigurationId) error

ReconcileConfigurationThenPoll performs ReconcileConfiguration then polls until it's completed

type NetworkSecurityPerimeterConfiguration 

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

type NetworkSecurityPerimeterConfigurationId 

type NetworkSecurityPerimeterConfigurationId struct {
	SubscriptionId                            string
	ResourceGroupName                         string
	BatchAccountName                          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, batchAccountName 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                  *NetworkSecurityProfile                                 `json:"profile,omitempty"`
	ProvisioningIssues       *[]ProvisioningIssue                                    `json:"provisioningIssues,omitempty"`
	ProvisioningState        *NetworkSecurityPerimeterConfigurationProvisioningState `json:"provisioningState,omitempty"`
	ResourceAssociation      *ResourceAssociation                                    `json:"resourceAssociation,omitempty"`
}

type NetworkSecurityPerimeterConfigurationProvisioningState 

type NetworkSecurityPerimeterConfigurationProvisioningState string
const (
	NetworkSecurityPerimeterConfigurationProvisioningStateAccepted  NetworkSecurityPerimeterConfigurationProvisioningState = "Accepted"
	NetworkSecurityPerimeterConfigurationProvisioningStateCanceled  NetworkSecurityPerimeterConfigurationProvisioningState = "Canceled"
	NetworkSecurityPerimeterConfigurationProvisioningStateCreating  NetworkSecurityPerimeterConfigurationProvisioningState = "Creating"
	NetworkSecurityPerimeterConfigurationProvisioningStateDeleting  NetworkSecurityPerimeterConfigurationProvisioningState = "Deleting"
	NetworkSecurityPerimeterConfigurationProvisioningStateFailed    NetworkSecurityPerimeterConfigurationProvisioningState = "Failed"
	NetworkSecurityPerimeterConfigurationProvisioningStateSucceeded NetworkSecurityPerimeterConfigurationProvisioningState = "Succeeded"
	NetworkSecurityPerimeterConfigurationProvisioningStateUpdating  NetworkSecurityPerimeterConfigurationProvisioningState = "Updating"
)

func (*NetworkSecurityPerimeterConfigurationProvisioningState) UnmarshalJSON 

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

type NetworkSecurityProfile 

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

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            *IssueType    `json:"issueType,omitempty"`
	Severity             *Severity     `json:"severity,omitempty"`
	SuggestedAccessRules *[]AccessRule `json:"suggestedAccessRules,omitempty"`
	SuggestedResourceIds *[]string     `json:"suggestedResourceIds,omitempty"`
}

type ReconcileConfigurationOperationResponse 

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

type ResourceAssociation 

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

type ResourceAssociationAccessMode 

type ResourceAssociationAccessMode string
const (
	ResourceAssociationAccessModeAudit    ResourceAssociationAccessMode = "Audit"
	ResourceAssociationAccessModeEnforced ResourceAssociationAccessMode = "Enforced"
	ResourceAssociationAccessModeLearning ResourceAssociationAccessMode = "Learning"
)

func (*ResourceAssociationAccessMode) UnmarshalJSON 

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

type Severity 

type Severity string
const (
	SeverityError   Severity = "Error"
	SeverityWarning Severity = "Warning"
)

func (*Severity) UnmarshalJSON 

func (s *Severity) 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.