trafficanalytics

README

github.com/hashicorp/go-azure-sdk/resource-manager/network/2023-09-01/trafficanalytics Documentation

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

Client Initialization

client := trafficanalytics.NewTrafficAnalyticsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: TrafficAnalyticsClient.NetworkWatchersGetFlowLogStatus

ctx := context.TODO()
id := trafficanalytics.NewNetworkWatcherID("12345678-1234-9876-4563-123456789012", "example-resource-group", "networkWatcherName")

payload := trafficanalytics.FlowLogStatusParameters{
	// ...
}


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

Example Usage: TrafficAnalyticsClient.NetworkWatchersSetFlowLogConfiguration

ctx := context.TODO()
id := trafficanalytics.NewNetworkWatcherID("12345678-1234-9876-4563-123456789012", "example-resource-group", "networkWatcherName")

payload := trafficanalytics.FlowLogInformation{
	// ...
}


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

Documentation

Index

• func PossibleValuesForFlowLogFormatType() []string
• func ValidateNetworkWatcherID(input interface{}, key string) (warnings []string, errors []error)
• type FlowLogFormatParameters
• type FlowLogFormatType
  • func (s *FlowLogFormatType) UnmarshalJSON(bytes []byte) error
• type FlowLogInformation
• type FlowLogProperties
• type FlowLogStatusParameters
• type NetworkWatcherId
  • func NewNetworkWatcherID(subscriptionId string, resourceGroupName string, networkWatcherName string) NetworkWatcherId
  • func ParseNetworkWatcherID(input string) (*NetworkWatcherId, error)
  • func ParseNetworkWatcherIDInsensitively(input string) (*NetworkWatcherId, error)
  • func (id *NetworkWatcherId) FromParseResult(input resourceids.ParseResult) error
  • func (id NetworkWatcherId) ID() string
  • func (id NetworkWatcherId) Segments() []resourceids.Segment
  • func (id NetworkWatcherId) String() string
• type NetworkWatchersGetFlowLogStatusOperationResponse
• type NetworkWatchersSetFlowLogConfigurationOperationResponse
• type RetentionPolicyParameters
• type TrafficAnalyticsClient
  • func NewTrafficAnalyticsClientWithBaseURI(sdkApi sdkEnv.Api) (*TrafficAnalyticsClient, error)
  • func (c TrafficAnalyticsClient) NetworkWatchersGetFlowLogStatus(ctx context.Context, id NetworkWatcherId, input FlowLogStatusParameters) (result NetworkWatchersGetFlowLogStatusOperationResponse, err error)
  • func (c TrafficAnalyticsClient) NetworkWatchersGetFlowLogStatusThenPoll(ctx context.Context, id NetworkWatcherId, input FlowLogStatusParameters) error
  • func (c TrafficAnalyticsClient) NetworkWatchersSetFlowLogConfiguration(ctx context.Context, id NetworkWatcherId, input FlowLogInformation) (result NetworkWatchersSetFlowLogConfigurationOperationResponse, err error)
  • func (c TrafficAnalyticsClient) NetworkWatchersSetFlowLogConfigurationThenPoll(ctx context.Context, id NetworkWatcherId, input FlowLogInformation) error
• type TrafficAnalyticsConfigurationProperties
• type TrafficAnalyticsProperties

Functions

func PossibleValuesForFlowLogFormatType

func PossibleValuesForFlowLogFormatType() []string

func ValidateNetworkWatcherID

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

ValidateNetworkWatcherID checks that 'input' can be parsed as a Network Watcher ID

Types

type FlowLogFormatParameters

type FlowLogFormatParameters struct {
	Type    *FlowLogFormatType `json:"type,omitempty"`
	Version *int64             `json:"version,omitempty"`
}

type FlowLogFormatType

type FlowLogFormatType string

const (
	FlowLogFormatTypeJSON FlowLogFormatType = "JSON"
)

func (*FlowLogFormatType) UnmarshalJSON

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

type FlowLogInformation

type FlowLogInformation struct {
	FlowAnalyticsConfiguration *TrafficAnalyticsProperties `json:"flowAnalyticsConfiguration,omitempty"`
	Properties                 FlowLogProperties           `json:"properties"`
	TargetResourceId           string                      `json:"targetResourceId"`
}

type FlowLogProperties

type FlowLogProperties struct {
	Enabled         bool                       `json:"enabled"`
	Format          *FlowLogFormatParameters   `json:"format,omitempty"`
	RetentionPolicy *RetentionPolicyParameters `json:"retentionPolicy,omitempty"`
	StorageId       string                     `json:"storageId"`
}

type FlowLogStatusParameters

type FlowLogStatusParameters struct {
	TargetResourceId string `json:"targetResourceId"`
}

type NetworkWatcherId

type NetworkWatcherId struct {
	SubscriptionId     string
	ResourceGroupName  string
	NetworkWatcherName string
}

NetworkWatcherId is a struct representing the Resource ID for a Network Watcher

func NewNetworkWatcherID

func NewNetworkWatcherID(subscriptionId string, resourceGroupName string, networkWatcherName string) NetworkWatcherId

NewNetworkWatcherID returns a new NetworkWatcherId struct

func ParseNetworkWatcherID

func ParseNetworkWatcherID(input string) (*NetworkWatcherId, error)

ParseNetworkWatcherID parses 'input' into a NetworkWatcherId

func ParseNetworkWatcherIDInsensitively

func ParseNetworkWatcherIDInsensitively(input string) (*NetworkWatcherId, error)

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

func (*NetworkWatcherId) FromParseResult

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

func (NetworkWatcherId) ID

func (id NetworkWatcherId) ID() string

ID returns the formatted Network Watcher ID

func (NetworkWatcherId) Segments

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

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

func (NetworkWatcherId) String

func (id NetworkWatcherId) String() string

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

type NetworkWatchersGetFlowLogStatusOperationResponse

type NetworkWatchersGetFlowLogStatusOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *FlowLogInformation
}

type NetworkWatchersSetFlowLogConfigurationOperationResponse

type NetworkWatchersSetFlowLogConfigurationOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *FlowLogInformation
}

type RetentionPolicyParameters

type RetentionPolicyParameters struct {
	Days    *int64 `json:"days,omitempty"`
	Enabled *bool  `json:"enabled,omitempty"`
}

type TrafficAnalyticsClient

type TrafficAnalyticsClient struct {
	Client *resourcemanager.Client
}

func NewTrafficAnalyticsClientWithBaseURI

func NewTrafficAnalyticsClientWithBaseURI(sdkApi sdkEnv.Api) (*TrafficAnalyticsClient, error)

func (TrafficAnalyticsClient) NetworkWatchersGetFlowLogStatus

func (c TrafficAnalyticsClient) NetworkWatchersGetFlowLogStatus(ctx context.Context, id NetworkWatcherId, input FlowLogStatusParameters) (result NetworkWatchersGetFlowLogStatusOperationResponse, err error)

NetworkWatchersGetFlowLogStatus ...

func (TrafficAnalyticsClient) NetworkWatchersGetFlowLogStatusThenPoll

func (c TrafficAnalyticsClient) NetworkWatchersGetFlowLogStatusThenPoll(ctx context.Context, id NetworkWatcherId, input FlowLogStatusParameters) error

NetworkWatchersGetFlowLogStatusThenPoll performs NetworkWatchersGetFlowLogStatus then polls until it's completed

func (TrafficAnalyticsClient) NetworkWatchersSetFlowLogConfiguration

func (c TrafficAnalyticsClient) NetworkWatchersSetFlowLogConfiguration(ctx context.Context, id NetworkWatcherId, input FlowLogInformation) (result NetworkWatchersSetFlowLogConfigurationOperationResponse, err error)

NetworkWatchersSetFlowLogConfiguration ...

func (TrafficAnalyticsClient) NetworkWatchersSetFlowLogConfigurationThenPoll

func (c TrafficAnalyticsClient) NetworkWatchersSetFlowLogConfigurationThenPoll(ctx context.Context, id NetworkWatcherId, input FlowLogInformation) error

NetworkWatchersSetFlowLogConfigurationThenPoll performs NetworkWatchersSetFlowLogConfiguration then polls until it's completed

type TrafficAnalyticsConfigurationProperties

type TrafficAnalyticsConfigurationProperties struct {
	Enabled                  *bool   `json:"enabled,omitempty"`
	TrafficAnalyticsInterval *int64  `json:"trafficAnalyticsInterval,omitempty"`
	WorkspaceId              *string `json:"workspaceId,omitempty"`
	WorkspaceRegion          *string `json:"workspaceRegion,omitempty"`
	WorkspaceResourceId      *string `json:"workspaceResourceId,omitempty"`
}

type TrafficAnalyticsProperties

type TrafficAnalyticsProperties struct {
	NetworkWatcherFlowAnalyticsConfiguration *TrafficAnalyticsConfigurationProperties `json:"networkWatcherFlowAnalyticsConfiguration,omitempty"`
}