reachabilityanalysisintents

package
v0.20241128.1112539 Latest Latest
Warning

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

 Go to latest Published: Nov 28, 2024 License: MPL-2.0 Imports: 12 Imported by: 0

README

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

The reachabilityanalysisintents 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/reachabilityanalysisintents"

Client Initialization

client := reachabilityanalysisintents.NewReachabilityAnalysisIntentsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ReachabilityAnalysisIntentsClient.Create

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

payload := reachabilityanalysisintents.ReachabilityAnalysisIntent{
	// ...
}


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: ReachabilityAnalysisIntentsClient.Get

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

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

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

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

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

ValidateReachabilityAnalysisIntentID checks that 'input' can be parsed as a Reachability Analysis Intent 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        *ReachabilityAnalysisIntent
}

type GetOperationResponse 

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

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 ListCompleteResult 

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

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

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 ReachabilityAnalysisIntent 

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

type ReachabilityAnalysisIntentId 

type ReachabilityAnalysisIntentId struct {
	SubscriptionId                 string
	ResourceGroupName              string
	NetworkManagerName             string
	VerifierWorkspaceName          string
	ReachabilityAnalysisIntentName string
}

ReachabilityAnalysisIntentId is a struct representing the Resource ID for a Reachability Analysis Intent

func NewReachabilityAnalysisIntentID 

func NewReachabilityAnalysisIntentID(subscriptionId string, resourceGroupName string, networkManagerName string, verifierWorkspaceName string, reachabilityAnalysisIntentName string) ReachabilityAnalysisIntentId

NewReachabilityAnalysisIntentID returns a new ReachabilityAnalysisIntentId struct

func ParseReachabilityAnalysisIntentID 

func ParseReachabilityAnalysisIntentID(input string) (*ReachabilityAnalysisIntentId, error)

ParseReachabilityAnalysisIntentID parses 'input' into a ReachabilityAnalysisIntentId

func ParseReachabilityAnalysisIntentIDInsensitively 

func ParseReachabilityAnalysisIntentIDInsensitively(input string) (*ReachabilityAnalysisIntentId, error)

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

func (*ReachabilityAnalysisIntentId) FromParseResult 

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

func (ReachabilityAnalysisIntentId) ID 

func (id ReachabilityAnalysisIntentId) ID() string

ID returns the formatted Reachability Analysis Intent ID

func (ReachabilityAnalysisIntentId) Segments 

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

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

func (ReachabilityAnalysisIntentId) String 

func (id ReachabilityAnalysisIntentId) String() string

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

type ReachabilityAnalysisIntentOperationPredicate 

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

func (ReachabilityAnalysisIntentOperationPredicate) Matches 

func (p ReachabilityAnalysisIntentOperationPredicate) Matches(input ReachabilityAnalysisIntent) bool

type ReachabilityAnalysisIntentProperties 

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

type ReachabilityAnalysisIntentsClient 

type ReachabilityAnalysisIntentsClient struct {
	Client *resourcemanager.Client
}

func NewReachabilityAnalysisIntentsClientWithBaseURI 

func NewReachabilityAnalysisIntentsClientWithBaseURI(sdkApi sdkEnv.Api) (*ReachabilityAnalysisIntentsClient, error)

func (ReachabilityAnalysisIntentsClient) Create 

func (c ReachabilityAnalysisIntentsClient) Create(ctx context.Context, id ReachabilityAnalysisIntentId, input ReachabilityAnalysisIntent) (result CreateOperationResponse, err error)

Create ...

func (ReachabilityAnalysisIntentsClient) Get 

func (c ReachabilityAnalysisIntentsClient) Get(ctx context.Context, id ReachabilityAnalysisIntentId) (result GetOperationResponse, err error)

Get ...

func (ReachabilityAnalysisIntentsClient) List 

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

List ...

func (ReachabilityAnalysisIntentsClient) ListComplete 

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

ListComplete retrieves all the results into a single object

func (ReachabilityAnalysisIntentsClient) ListCompleteMatchingPredicate 

func (c ReachabilityAnalysisIntentsClient) ListCompleteMatchingPredicate(ctx context.Context, id VerifierWorkspaceId, options ListOperationOptions, predicate ReachabilityAnalysisIntentOperationPredicate) (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.