networkconnection

README

github.com/hashicorp/go-azure-sdk/resource-manager/devcenter/2023-04-01/networkconnection Documentation

The networkconnection SDK allows for interaction with the Azure Resource Manager Service devcenter (API Version 2023-04-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/devcenter/2023-04-01/networkconnection"

Client Initialization

client := networkconnection.NewNetworkConnectionClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: NetworkConnectionClient.ListOutboundNetworkDependenciesEndpoints

ctx := context.TODO()
id := networkconnection.NewNetworkConnectionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "networkConnectionValue")

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

Example Usage: NetworkConnectionClient.RunHealthChecks

ctx := context.TODO()
id := networkconnection.NewNetworkConnectionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "networkConnectionValue")

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

Documentation

Index

• func ValidateNetworkConnectionID(input interface{}, key string) (warnings []string, errors []error)
• type EndpointDependency
• type EndpointDetail
• type ListOutboundNetworkDependenciesEndpointsCompleteResult
• type ListOutboundNetworkDependenciesEndpointsOperationResponse
• type NetworkConnectionClient
  • func NewNetworkConnectionClientWithBaseURI(sdkApi sdkEnv.Api) (*NetworkConnectionClient, error)
  • func (c NetworkConnectionClient) ListOutboundNetworkDependenciesEndpoints(ctx context.Context, id NetworkConnectionId) (result ListOutboundNetworkDependenciesEndpointsOperationResponse, err error)
  • func (c NetworkConnectionClient) ListOutboundNetworkDependenciesEndpointsComplete(ctx context.Context, id NetworkConnectionId) (ListOutboundNetworkDependenciesEndpointsCompleteResult, error)
  • func (c NetworkConnectionClient) ListOutboundNetworkDependenciesEndpointsCompleteMatchingPredicate(ctx context.Context, id NetworkConnectionId, ...) (result ListOutboundNetworkDependenciesEndpointsCompleteResult, err error)
  • func (c NetworkConnectionClient) RunHealthChecks(ctx context.Context, id NetworkConnectionId) (result RunHealthChecksOperationResponse, err error)
  • func (c NetworkConnectionClient) RunHealthChecksThenPoll(ctx context.Context, id NetworkConnectionId) error
• type NetworkConnectionId
  • func NewNetworkConnectionID(subscriptionId string, resourceGroupName string, networkConnectionName string) NetworkConnectionId
  • func ParseNetworkConnectionID(input string) (*NetworkConnectionId, error)
  • func ParseNetworkConnectionIDInsensitively(input string) (*NetworkConnectionId, error)
  • func (id *NetworkConnectionId) FromParseResult(input resourceids.ParseResult) error
  • func (id NetworkConnectionId) ID() string
  • func (id NetworkConnectionId) Segments() []resourceids.Segment
  • func (id NetworkConnectionId) String() string
• type OutboundEnvironmentEndpoint
• type OutboundEnvironmentEndpointOperationPredicate
  • func (p OutboundEnvironmentEndpointOperationPredicate) Matches(input OutboundEnvironmentEndpoint) bool
• type RunHealthChecksOperationResponse

Functions

func ValidateNetworkConnectionID

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

ValidateNetworkConnectionID checks that 'input' can be parsed as a Network Connection ID

Types

type EndpointDependency

type EndpointDependency struct {
	Description     *string           `json:"description,omitempty"`
	DomainName      *string           `json:"domainName,omitempty"`
	EndpointDetails *[]EndpointDetail `json:"endpointDetails,omitempty"`
}

type EndpointDetail

type EndpointDetail struct {
	Port *int64 `json:"port,omitempty"`
}

type ListOutboundNetworkDependenciesEndpointsCompleteResult

type ListOutboundNetworkDependenciesEndpointsCompleteResult struct {
	Items []OutboundEnvironmentEndpoint
}

type ListOutboundNetworkDependenciesEndpointsOperationResponse

type ListOutboundNetworkDependenciesEndpointsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]OutboundEnvironmentEndpoint
}

type NetworkConnectionClient

type NetworkConnectionClient struct {
	Client *resourcemanager.Client
}

func NewNetworkConnectionClientWithBaseURI

func NewNetworkConnectionClientWithBaseURI(sdkApi sdkEnv.Api) (*NetworkConnectionClient, error)

func (NetworkConnectionClient) ListOutboundNetworkDependenciesEndpoints

func (c NetworkConnectionClient) ListOutboundNetworkDependenciesEndpoints(ctx context.Context, id NetworkConnectionId) (result ListOutboundNetworkDependenciesEndpointsOperationResponse, err error)

ListOutboundNetworkDependenciesEndpoints ...

func (NetworkConnectionClient) ListOutboundNetworkDependenciesEndpointsComplete

func (c NetworkConnectionClient) ListOutboundNetworkDependenciesEndpointsComplete(ctx context.Context, id NetworkConnectionId) (ListOutboundNetworkDependenciesEndpointsCompleteResult, error)

ListOutboundNetworkDependenciesEndpointsComplete retrieves all the results into a single object

func (NetworkConnectionClient) ListOutboundNetworkDependenciesEndpointsCompleteMatchingPredicate

func (c NetworkConnectionClient) ListOutboundNetworkDependenciesEndpointsCompleteMatchingPredicate(ctx context.Context, id NetworkConnectionId, predicate OutboundEnvironmentEndpointOperationPredicate) (result ListOutboundNetworkDependenciesEndpointsCompleteResult, err error)

ListOutboundNetworkDependenciesEndpointsCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (NetworkConnectionClient) RunHealthChecks

func (c NetworkConnectionClient) RunHealthChecks(ctx context.Context, id NetworkConnectionId) (result RunHealthChecksOperationResponse, err error)

RunHealthChecks ...

func (NetworkConnectionClient) RunHealthChecksThenPoll

func (c NetworkConnectionClient) RunHealthChecksThenPoll(ctx context.Context, id NetworkConnectionId) error

RunHealthChecksThenPoll performs RunHealthChecks then polls until it's completed

type NetworkConnectionId

type NetworkConnectionId struct {
	SubscriptionId        string
	ResourceGroupName     string
	NetworkConnectionName string
}

NetworkConnectionId is a struct representing the Resource ID for a Network Connection

func NewNetworkConnectionID

func NewNetworkConnectionID(subscriptionId string, resourceGroupName string, networkConnectionName string) NetworkConnectionId

NewNetworkConnectionID returns a new NetworkConnectionId struct

func ParseNetworkConnectionID

func ParseNetworkConnectionID(input string) (*NetworkConnectionId, error)

ParseNetworkConnectionID parses 'input' into a NetworkConnectionId

func ParseNetworkConnectionIDInsensitively

func ParseNetworkConnectionIDInsensitively(input string) (*NetworkConnectionId, error)

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

func (*NetworkConnectionId) FromParseResult

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

func (NetworkConnectionId) ID

func (id NetworkConnectionId) ID() string

ID returns the formatted Network Connection ID

func (NetworkConnectionId) Segments

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

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

func (NetworkConnectionId) String

func (id NetworkConnectionId) String() string

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

type OutboundEnvironmentEndpoint

type OutboundEnvironmentEndpoint struct {
	Category  *string               `json:"category,omitempty"`
	Endpoints *[]EndpointDependency `json:"endpoints,omitempty"`
}

type OutboundEnvironmentEndpointOperationPredicate

type OutboundEnvironmentEndpointOperationPredicate struct {
	Category *string
}

func (OutboundEnvironmentEndpointOperationPredicate) Matches

func (p OutboundEnvironmentEndpointOperationPredicate) Matches(input OutboundEnvironmentEndpoint) bool

type RunHealthChecksOperationResponse

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