reachabilityanalysisruns

package
v0.20250114.1063937 Latest Latest
Warning

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

 Go to latest Published: Jan 14, 2025 License: MPL-2.0 Imports: 13 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/network/2024-05-01/reachabilityanalysisruns Documentation

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

Client Initialization

client := reachabilityanalysisruns.NewReachabilityAnalysisRunsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ReachabilityAnalysisRunsClient.Create

ctx := context.TODO()
id := reachabilityanalysisruns.NewReachabilityAnalysisRunID("12345678-1234-9876-4563-123456789012", "example-resource-group", "networkManagerName", "verifierWorkspaceName", "reachabilityAnalysisRunName")

payload := reachabilityanalysisruns.ReachabilityAnalysisRun{
	// ...
}


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

Example Usage: ReachabilityAnalysisRunsClient.Delete

ctx := context.TODO()
id := reachabilityanalysisruns.NewReachabilityAnalysisRunID("12345678-1234-9876-4563-123456789012", "example-resource-group", "networkManagerName", "verifierWorkspaceName", "reachabilityAnalysisRunName")

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

Example Usage: ReachabilityAnalysisRunsClient.Get

ctx := context.TODO()
id := reachabilityanalysisruns.NewReachabilityAnalysisRunID("12345678-1234-9876-4563-123456789012", "example-resource-group", "networkManagerName", "verifierWorkspaceName", "reachabilityAnalysisRunName")

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

ctx := context.TODO()
id := reachabilityanalysisruns.NewVerifierWorkspaceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "networkManagerName", "verifierWorkspaceName")

// alternatively `client.List(ctx, id, reachabilityanalysisruns.DefaultListOperationOptions())` can be used to do batched pagination
items, err := client.ListComplete(ctx, id, reachabilityanalysisruns.DefaultListOperationOptions())
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 PossibleValuesForNetworkProtocol 

func PossibleValuesForNetworkProtocol() []string

func PossibleValuesForProvisioningState 

func PossibleValuesForProvisioningState() []string

func ValidateReachabilityAnalysisRunID 

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

ValidateReachabilityAnalysisRunID checks that 'input' can be parsed as a Reachability Analysis Run ID

func ValidateVerifierWorkspaceID 

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

ValidateVerifierWorkspaceID checks that 'input' can be parsed as a Verifier Workspace ID

Types

type CreateOperationResponse 

type CreateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ReachabilityAnalysisRun
}

type DeleteOperationResponse 

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

type GetOperationResponse 

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

type IPTraffic 

type IPTraffic struct {
	DestinationIPs   []string          `json:"destinationIps"`
	DestinationPorts []string          `json:"destinationPorts"`
	Protocols        []NetworkProtocol `json:"protocols"`
	SourceIPs        []string          `json:"sourceIps"`
	SourcePorts      []string          `json:"sourcePorts"`
}

type IntentContent 

type IntentContent struct {
	Description           *string   `json:"description,omitempty"`
	DestinationResourceId string    `json:"destinationResourceId"`
	IPTraffic             IPTraffic `json:"ipTraffic"`
	SourceResourceId      string    `json:"sourceResourceId"`
}

type ListCompleteResult 

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

type ListCustomPager 

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

type ListOperationOptions 

type ListOperationOptions struct {
	Skip      *int64
	SkipToken *string
	SortKey   *string
	SortValue *string
	Top       *int64
}

func DefaultListOperationOptions 

func DefaultListOperationOptions() ListOperationOptions

func (ListOperationOptions) ToHeaders 

func (o ListOperationOptions) ToHeaders() *client.Headers

func (ListOperationOptions) ToOData 

func (o ListOperationOptions) ToOData() *odata.Query

func (ListOperationOptions) ToQuery 

func (o ListOperationOptions) ToQuery() *client.QueryParams

type ListOperationResponse 

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ReachabilityAnalysisRun
}

type NetworkProtocol 

type NetworkProtocol string
const (
	NetworkProtocolAny  NetworkProtocol = "Any"
	NetworkProtocolICMP NetworkProtocol = "ICMP"
	NetworkProtocolTCP  NetworkProtocol = "TCP"
	NetworkProtocolUDP  NetworkProtocol = "UDP"
)

func (*NetworkProtocol) UnmarshalJSON 

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

type ProvisioningState 

type ProvisioningState string
const (
	ProvisioningStateCanceled  ProvisioningState = "Canceled"
	ProvisioningStateCreating  ProvisioningState = "Creating"
	ProvisioningStateDeleting  ProvisioningState = "Deleting"
	ProvisioningStateFailed    ProvisioningState = "Failed"
	ProvisioningStateSucceeded ProvisioningState = "Succeeded"
	ProvisioningStateUpdating  ProvisioningState = "Updating"
)

func (*ProvisioningState) UnmarshalJSON 

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

type ReachabilityAnalysisRun 

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

type ReachabilityAnalysisRunId 

type ReachabilityAnalysisRunId struct {
	SubscriptionId              string
	ResourceGroupName           string
	NetworkManagerName          string
	VerifierWorkspaceName       string
	ReachabilityAnalysisRunName string
}

ReachabilityAnalysisRunId is a struct representing the Resource ID for a Reachability Analysis Run

func NewReachabilityAnalysisRunID 

func NewReachabilityAnalysisRunID(subscriptionId string, resourceGroupName string, networkManagerName string, verifierWorkspaceName string, reachabilityAnalysisRunName string) ReachabilityAnalysisRunId

NewReachabilityAnalysisRunID returns a new ReachabilityAnalysisRunId struct

func ParseReachabilityAnalysisRunID 

func ParseReachabilityAnalysisRunID(input string) (*ReachabilityAnalysisRunId, error)

ParseReachabilityAnalysisRunID parses 'input' into a ReachabilityAnalysisRunId

func ParseReachabilityAnalysisRunIDInsensitively 

func ParseReachabilityAnalysisRunIDInsensitively(input string) (*ReachabilityAnalysisRunId, error)

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

func (*ReachabilityAnalysisRunId) FromParseResult 

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

func (ReachabilityAnalysisRunId) ID 

func (id ReachabilityAnalysisRunId) ID() string

ID returns the formatted Reachability Analysis Run ID

func (ReachabilityAnalysisRunId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Reachability Analysis Run ID

func (ReachabilityAnalysisRunId) String 

func (id ReachabilityAnalysisRunId) String() string

String returns a human-readable description of this Reachability Analysis Run ID

type ReachabilityAnalysisRunOperationPredicate 

type ReachabilityAnalysisRunOperationPredicate struct {
	Id   *string
	Name *string
	Type *string
}

func (ReachabilityAnalysisRunOperationPredicate) Matches 

func (p ReachabilityAnalysisRunOperationPredicate) Matches(input ReachabilityAnalysisRun) bool

type ReachabilityAnalysisRunProperties 

type ReachabilityAnalysisRunProperties struct {
	AnalysisResult    *string            `json:"analysisResult,omitempty"`
	Description       *string            `json:"description,omitempty"`
	ErrorMessage      *string            `json:"errorMessage,omitempty"`
	IntentContent     *IntentContent     `json:"intentContent,omitempty"`
	IntentId          string             `json:"intentId"`
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty"`
}

type ReachabilityAnalysisRunsClient 

type ReachabilityAnalysisRunsClient struct {
	Client *resourcemanager.Client
}

func NewReachabilityAnalysisRunsClientWithBaseURI 

func NewReachabilityAnalysisRunsClientWithBaseURI(sdkApi sdkEnv.Api) (*ReachabilityAnalysisRunsClient, error)

func (ReachabilityAnalysisRunsClient) Create 

func (c ReachabilityAnalysisRunsClient) Create(ctx context.Context, id ReachabilityAnalysisRunId, input ReachabilityAnalysisRun) (result CreateOperationResponse, err error)

Create ...

func (ReachabilityAnalysisRunsClient) Delete 

func (c ReachabilityAnalysisRunsClient) Delete(ctx context.Context, id ReachabilityAnalysisRunId) (result DeleteOperationResponse, err error)

Delete ...

func (ReachabilityAnalysisRunsClient) DeleteThenPoll 

func (c ReachabilityAnalysisRunsClient) DeleteThenPoll(ctx context.Context, id ReachabilityAnalysisRunId) error

DeleteThenPoll performs Delete then polls until it's completed

func (ReachabilityAnalysisRunsClient) Get 

func (c ReachabilityAnalysisRunsClient) Get(ctx context.Context, id ReachabilityAnalysisRunId) (result GetOperationResponse, err error)

Get ...

func (ReachabilityAnalysisRunsClient) List 

func (c ReachabilityAnalysisRunsClient) List(ctx context.Context, id VerifierWorkspaceId, options ListOperationOptions) (result ListOperationResponse, err error)

List ...

func (ReachabilityAnalysisRunsClient) ListComplete 

func (c ReachabilityAnalysisRunsClient) ListComplete(ctx context.Context, id VerifierWorkspaceId, options ListOperationOptions) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (ReachabilityAnalysisRunsClient) ListCompleteMatchingPredicate 

func (c ReachabilityAnalysisRunsClient) ListCompleteMatchingPredicate(ctx context.Context, id VerifierWorkspaceId, options ListOperationOptions, predicate ReachabilityAnalysisRunOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type VerifierWorkspaceId 

type VerifierWorkspaceId struct {
	SubscriptionId        string
	ResourceGroupName     string
	NetworkManagerName    string
	VerifierWorkspaceName string
}

VerifierWorkspaceId is a struct representing the Resource ID for a Verifier Workspace

func NewVerifierWorkspaceID 

func NewVerifierWorkspaceID(subscriptionId string, resourceGroupName string, networkManagerName string, verifierWorkspaceName string) VerifierWorkspaceId

NewVerifierWorkspaceID returns a new VerifierWorkspaceId struct

func ParseVerifierWorkspaceID 

func ParseVerifierWorkspaceID(input string) (*VerifierWorkspaceId, error)

ParseVerifierWorkspaceID parses 'input' into a VerifierWorkspaceId

func ParseVerifierWorkspaceIDInsensitively 

func ParseVerifierWorkspaceIDInsensitively(input string) (*VerifierWorkspaceId, error)

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

func (*VerifierWorkspaceId) FromParseResult 

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

func (VerifierWorkspaceId) ID 

func (id VerifierWorkspaceId) ID() string

ID returns the formatted Verifier Workspace ID

func (VerifierWorkspaceId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Verifier Workspace ID

func (VerifierWorkspaceId) String 

func (id VerifierWorkspaceId) String() string

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