allowedconnections

package
v0.20241104.1140654 Latest Latest
Warning

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

 Go to latest Published: Nov 4, 2024 License: MPL-2.0 Imports: 14 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/security/2020-01-01/allowedconnections Documentation

The allowedconnections SDK allows for interaction with Azure Resource Manager security (API Version 2020-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-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/security/2020-01-01/allowedconnections"

Client Initialization

client := allowedconnections.NewAllowedConnectionsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: AllowedConnectionsClient.Get

ctx := context.TODO()
id := allowedconnections.NewConnectionTypeID("12345678-1234-9876-4563-123456789012", "example-resource-group", "locationName", "External")

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

ctx := context.TODO()
id := commonids.NewSubscriptionID("12345678-1234-9876-4563-123456789012")

// 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: AllowedConnectionsClient.ListByHomeRegion

ctx := context.TODO()
id := allowedconnections.NewLocationID("12345678-1234-9876-4563-123456789012", "locationName")

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

func PossibleValuesForConnectionType() []string

func ValidateConnectionTypeID 

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

ValidateConnectionTypeID checks that 'input' can be parsed as a Connection Type ID

func ValidateLocationID 

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

ValidateLocationID checks that 'input' can be parsed as a Location ID

Types

type AllowedConnectionsClient 

type AllowedConnectionsClient struct {
	Client *resourcemanager.Client
}

func NewAllowedConnectionsClientWithBaseURI 

func NewAllowedConnectionsClientWithBaseURI(sdkApi sdkEnv.Api) (*AllowedConnectionsClient, error)

func (AllowedConnectionsClient) Get 

func (c AllowedConnectionsClient) Get(ctx context.Context, id ConnectionTypeId) (result GetOperationResponse, err error)

Get ...

func (AllowedConnectionsClient) List 

func (c AllowedConnectionsClient) List(ctx context.Context, id commonids.SubscriptionId) (result ListOperationResponse, err error)

List ...

func (AllowedConnectionsClient) ListByHomeRegion 

func (c AllowedConnectionsClient) ListByHomeRegion(ctx context.Context, id LocationId) (result ListByHomeRegionOperationResponse, err error)

ListByHomeRegion ...

func (AllowedConnectionsClient) ListByHomeRegionComplete 

func (c AllowedConnectionsClient) ListByHomeRegionComplete(ctx context.Context, id LocationId) (ListByHomeRegionCompleteResult, error)

ListByHomeRegionComplete retrieves all the results into a single object

func (AllowedConnectionsClient) ListByHomeRegionCompleteMatchingPredicate 

func (c AllowedConnectionsClient) ListByHomeRegionCompleteMatchingPredicate(ctx context.Context, id LocationId, predicate AllowedConnectionsResourceOperationPredicate) (result ListByHomeRegionCompleteResult, err error)

ListByHomeRegionCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (AllowedConnectionsClient) ListComplete 

func (c AllowedConnectionsClient) ListComplete(ctx context.Context, id commonids.SubscriptionId) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (AllowedConnectionsClient) ListCompleteMatchingPredicate 

func (c AllowedConnectionsClient) ListCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, predicate AllowedConnectionsResourceOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type AllowedConnectionsResource 

type AllowedConnectionsResource struct {
	Id         *string                               `json:"id,omitempty"`
	Location   *string                               `json:"location,omitempty"`
	Name       *string                               `json:"name,omitempty"`
	Properties *AllowedConnectionsResourceProperties `json:"properties,omitempty"`
	Type       *string                               `json:"type,omitempty"`
}

type AllowedConnectionsResourceOperationPredicate 

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

func (AllowedConnectionsResourceOperationPredicate) Matches 

func (p AllowedConnectionsResourceOperationPredicate) Matches(input AllowedConnectionsResource) bool

type AllowedConnectionsResourceProperties 

type AllowedConnectionsResourceProperties struct {
	CalculatedDateTime   *string                `json:"calculatedDateTime,omitempty"`
	ConnectableResources *[]ConnectableResource `json:"connectableResources,omitempty"`
}

func (*AllowedConnectionsResourceProperties) GetCalculatedDateTimeAsTime 

func (o *AllowedConnectionsResourceProperties) GetCalculatedDateTimeAsTime() (*time.Time, error)

func (*AllowedConnectionsResourceProperties) SetCalculatedDateTimeAsTime 

func (o *AllowedConnectionsResourceProperties) SetCalculatedDateTimeAsTime(input time.Time)

type ConnectableResource 

type ConnectableResource struct {
	Id                         *string              `json:"id,omitempty"`
	InboundConnectedResources  *[]ConnectedResource `json:"inboundConnectedResources,omitempty"`
	OutboundConnectedResources *[]ConnectedResource `json:"outboundConnectedResources,omitempty"`
}

type ConnectedResource 

type ConnectedResource struct {
	ConnectedResourceId *string `json:"connectedResourceId,omitempty"`
	TcpPorts            *string `json:"tcpPorts,omitempty"`
	UdpPorts            *string `json:"udpPorts,omitempty"`
}

type ConnectionType 

type ConnectionType string
const (
	ConnectionTypeExternal ConnectionType = "External"
	ConnectionTypeInternal ConnectionType = "Internal"
)

func (*ConnectionType) UnmarshalJSON added in v0.20240228.1142829 

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

type ConnectionTypeId 

type ConnectionTypeId struct {
	SubscriptionId    string
	ResourceGroupName string
	LocationName      string
	ConnectionType    ConnectionType
}

ConnectionTypeId is a struct representing the Resource ID for a Connection Type

func NewConnectionTypeID 

func NewConnectionTypeID(subscriptionId string, resourceGroupName string, locationName string, connectionType ConnectionType) ConnectionTypeId

NewConnectionTypeID returns a new ConnectionTypeId struct

func ParseConnectionTypeID 

func ParseConnectionTypeID(input string) (*ConnectionTypeId, error)

ParseConnectionTypeID parses 'input' into a ConnectionTypeId

func ParseConnectionTypeIDInsensitively 

func ParseConnectionTypeIDInsensitively(input string) (*ConnectionTypeId, error)

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

func (*ConnectionTypeId) FromParseResult 

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

func (ConnectionTypeId) ID 

func (id ConnectionTypeId) ID() string

ID returns the formatted Connection Type ID

func (ConnectionTypeId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Connection Type ID

func (ConnectionTypeId) String 

func (id ConnectionTypeId) String() string

String returns a human-readable description of this Connection Type ID

type GetOperationResponse 

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

type ListByHomeRegionCompleteResult 

type ListByHomeRegionCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []AllowedConnectionsResource
}

type ListByHomeRegionCustomPager added in v0.20240628.1153531 

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

type ListByHomeRegionOperationResponse 

type ListByHomeRegionOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]AllowedConnectionsResource
}

type ListCompleteResult 

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

type ListCustomPager added in v0.20240628.1153531 

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        *[]AllowedConnectionsResource
}

type LocationId 

type LocationId struct {
	SubscriptionId string
	LocationName   string
}

LocationId is a struct representing the Resource ID for a Location

func NewLocationID 

func NewLocationID(subscriptionId string, locationName string) LocationId

NewLocationID returns a new LocationId struct

func ParseLocationID 

func ParseLocationID(input string) (*LocationId, error)

ParseLocationID parses 'input' into a LocationId

func ParseLocationIDInsensitively 

func ParseLocationIDInsensitively(input string) (*LocationId, error)

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

func (*LocationId) FromParseResult 

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

func (LocationId) ID 

func (id LocationId) ID() string

ID returns the formatted Location ID

func (LocationId) Segments 

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

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

func (LocationId) String 

func (id LocationId) String() string

String returns a human-readable description of this Location 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.