performconnectivitycheck

README

github.com/hashicorp/go-azure-sdk/resource-manager/apimanagement/2022-08-01/performconnectivitycheck Documentation

The performconnectivitycheck SDK allows for interaction with the Azure Resource Manager Service apimanagement (API Version 2022-08-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/apimanagement/2022-08-01/performconnectivitycheck"

Client Initialization

client := performconnectivitycheck.NewPerformConnectivityCheckClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: PerformConnectivityCheckClient.Async

ctx := context.TODO()
id := performconnectivitycheck.NewServiceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue")

payload := performconnectivitycheck.ConnectivityCheckRequest{
	// ...
}


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

Documentation

Index

• func PossibleValuesForConnectionStatus() []string
• func PossibleValuesForConnectivityCheckProtocol() []string
• func PossibleValuesForIssueType() []string
• func PossibleValuesForMethod() []string
• func PossibleValuesForOrigin() []string
• func PossibleValuesForPreferredIPVersion() []string
• func PossibleValuesForSeverity() []string
• func ValidateServiceID(input interface{}, key string) (warnings []string, errors []error)
• type AsyncOperationResponse
• type ConnectionStatus
• type ConnectivityCheckProtocol
• type ConnectivityCheckRequest
• type ConnectivityCheckRequestDestination
• type ConnectivityCheckRequestProtocolConfiguration
• type ConnectivityCheckRequestProtocolConfigurationHTTPConfiguration
• type ConnectivityCheckRequestSource
• type ConnectivityCheckResponse
• type ConnectivityHop
• type ConnectivityIssue
• type HTTPHeader
• type IssueType
• type Method
• type Origin
• type PerformConnectivityCheckClient
  • func NewPerformConnectivityCheckClientWithBaseURI(endpoint string) PerformConnectivityCheckClient
  • func (c PerformConnectivityCheckClient) Async(ctx context.Context, id ServiceId, input ConnectivityCheckRequest) (result AsyncOperationResponse, err error)
  • func (c PerformConnectivityCheckClient) AsyncThenPoll(ctx context.Context, id ServiceId, input ConnectivityCheckRequest) error
• type PreferredIPVersion
• type ServiceId
  • func NewServiceID(subscriptionId string, resourceGroupName string, serviceName string) ServiceId
  • func ParseServiceID(input string) (*ServiceId, error)
  • func ParseServiceIDInsensitively(input string) (*ServiceId, error)
  • func (id ServiceId) ID() string
  • func (id ServiceId) Segments() []resourceids.Segment
  • func (id ServiceId) String() string
• type Severity

Functions

func PossibleValuesForConnectionStatus

func PossibleValuesForConnectionStatus() []string

func PossibleValuesForConnectivityCheckProtocol

func PossibleValuesForConnectivityCheckProtocol() []string

func PossibleValuesForIssueType

func PossibleValuesForIssueType() []string

func PossibleValuesForMethod

func PossibleValuesForMethod() []string

func PossibleValuesForOrigin

func PossibleValuesForOrigin() []string

func PossibleValuesForPreferredIPVersion

func PossibleValuesForPreferredIPVersion() []string

func PossibleValuesForSeverity

func PossibleValuesForSeverity() []string

func ValidateServiceID

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

ValidateServiceID checks that 'input' can be parsed as a Service ID

Types

type AsyncOperationResponse

type AsyncOperationResponse struct {
	Poller       polling.LongRunningPoller
	HttpResponse *http.Response
}

type ConnectionStatus

type ConnectionStatus string

const (
	ConnectionStatusConnected    ConnectionStatus = "Connected"
	ConnectionStatusDegraded     ConnectionStatus = "Degraded"
	ConnectionStatusDisconnected ConnectionStatus = "Disconnected"
	ConnectionStatusUnknown      ConnectionStatus = "Unknown"
)

type ConnectivityCheckProtocol

type ConnectivityCheckProtocol string

const (
	ConnectivityCheckProtocolHTTP  ConnectivityCheckProtocol = "HTTP"
	ConnectivityCheckProtocolHTTPS ConnectivityCheckProtocol = "HTTPS"
	ConnectivityCheckProtocolTCP   ConnectivityCheckProtocol = "TCP"
)

type ConnectivityCheckRequest

type ConnectivityCheckRequest struct {
	Destination           ConnectivityCheckRequestDestination            `json:"destination"`
	PreferredIPVersion    *PreferredIPVersion                            `json:"preferredIPVersion,omitempty"`
	Protocol              *ConnectivityCheckProtocol                     `json:"protocol,omitempty"`
	ProtocolConfiguration *ConnectivityCheckRequestProtocolConfiguration `json:"protocolConfiguration,omitempty"`
	Source                ConnectivityCheckRequestSource                 `json:"source"`
}

type ConnectivityCheckRequestDestination

type ConnectivityCheckRequestDestination struct {
	Address string `json:"address"`
	Port    int64  `json:"port"`
}

type ConnectivityCheckRequestProtocolConfiguration

type ConnectivityCheckRequestProtocolConfiguration struct {
	HTTPConfiguration *ConnectivityCheckRequestProtocolConfigurationHTTPConfiguration `json:"HTTPConfiguration,omitempty"`
}

type ConnectivityCheckRequestProtocolConfigurationHTTPConfiguration

type ConnectivityCheckRequestProtocolConfigurationHTTPConfiguration struct {
	Headers          *[]HTTPHeader `json:"headers,omitempty"`
	Method           *Method       `json:"method,omitempty"`
	ValidStatusCodes *[]int64      `json:"validStatusCodes,omitempty"`
}

type ConnectivityCheckRequestSource

type ConnectivityCheckRequestSource struct {
	Instance *int64 `json:"instance,omitempty"`
	Region   string `json:"region"`
}

type ConnectivityCheckResponse

type ConnectivityCheckResponse struct {
	AvgLatencyInMs   *int64             `json:"avgLatencyInMs,omitempty"`
	ConnectionStatus *ConnectionStatus  `json:"connectionStatus,omitempty"`
	Hops             *[]ConnectivityHop `json:"hops,omitempty"`
	MaxLatencyInMs   *int64             `json:"maxLatencyInMs,omitempty"`
	MinLatencyInMs   *int64             `json:"minLatencyInMs,omitempty"`
	ProbesFailed     *int64             `json:"probesFailed,omitempty"`
	ProbesSent       *int64             `json:"probesSent,omitempty"`
}

type ConnectivityHop

type ConnectivityHop struct {
	Address    *string              `json:"address,omitempty"`
	Id         *string              `json:"id,omitempty"`
	Issues     *[]ConnectivityIssue `json:"issues,omitempty"`
	NextHopIds *[]string            `json:"nextHopIds,omitempty"`
	ResourceId *string              `json:"resourceId,omitempty"`
	Type       *string              `json:"type,omitempty"`
}

type ConnectivityIssue

type ConnectivityIssue struct {
	Context  *[]map[string]string `json:"context,omitempty"`
	Origin   *Origin              `json:"origin,omitempty"`
	Severity *Severity            `json:"severity,omitempty"`
	Type     *IssueType           `json:"type,omitempty"`
}

type HTTPHeader

type HTTPHeader struct {
	Name  string `json:"name"`
	Value string `json:"value"`
}

type IssueType

type IssueType string

const (
	IssueTypeAgentStopped        IssueType = "AgentStopped"
	IssueTypeDnsResolution       IssueType = "DnsResolution"
	IssueTypeGuestFirewall       IssueType = "GuestFirewall"
	IssueTypeNetworkSecurityRule IssueType = "NetworkSecurityRule"
	IssueTypePlatform            IssueType = "Platform"
	IssueTypePortThrottled       IssueType = "PortThrottled"
	IssueTypeSocketBind          IssueType = "SocketBind"
	IssueTypeUnknown             IssueType = "Unknown"
	IssueTypeUserDefinedRoute    IssueType = "UserDefinedRoute"
)

type Method

type Method string

const (
	MethodGET  Method = "GET"
	MethodPOST Method = "POST"
)

type Origin

type Origin string

const (
	OriginInbound  Origin = "Inbound"
	OriginLocal    Origin = "Local"
	OriginOutbound Origin = "Outbound"
)

type PerformConnectivityCheckClient

type PerformConnectivityCheckClient struct {
	Client autorest.Client
	// contains filtered or unexported fields
}

func NewPerformConnectivityCheckClientWithBaseURI

func NewPerformConnectivityCheckClientWithBaseURI(endpoint string) PerformConnectivityCheckClient

func (PerformConnectivityCheckClient) Async

func (c PerformConnectivityCheckClient) Async(ctx context.Context, id ServiceId, input ConnectivityCheckRequest) (result AsyncOperationResponse, err error)

Async ...

func (PerformConnectivityCheckClient) AsyncThenPoll

func (c PerformConnectivityCheckClient) AsyncThenPoll(ctx context.Context, id ServiceId, input ConnectivityCheckRequest) error

AsyncThenPoll performs Async then polls until it's completed

type PreferredIPVersion

type PreferredIPVersion string

const (
	PreferredIPVersionIPvFour PreferredIPVersion = "IPv4"
)

type ServiceId

type ServiceId struct {
	SubscriptionId    string
	ResourceGroupName string
	ServiceName       string
}

ServiceId is a struct representing the Resource ID for a Service

func NewServiceID

func NewServiceID(subscriptionId string, resourceGroupName string, serviceName string) ServiceId

NewServiceID returns a new ServiceId struct

func ParseServiceID

func ParseServiceID(input string) (*ServiceId, error)

ParseServiceID parses 'input' into a ServiceId

func ParseServiceIDInsensitively

func ParseServiceIDInsensitively(input string) (*ServiceId, error)

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

func (ServiceId) ID

func (id ServiceId) ID() string

ID returns the formatted Service ID

func (ServiceId) Segments

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

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

func (ServiceId) String

func (id ServiceId) String() string

String returns a human-readable description of this Service ID

type Severity

type Severity string

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