heatmaps

README

github.com/hashicorp/go-azure-sdk/resource-manager/trafficmanager/2022-04-01/heatmaps Documentation

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

Client Initialization

client := heatmaps.NewHeatMapsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: HeatMapsClient.HeatMapGet

ctx := context.TODO()
id := heatmaps.NewTrafficManagerProfileID("12345678-1234-9876-4563-123456789012", "example-resource-group", "trafficManagerProfileValue")

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

Documentation

Index

• func ValidateTrafficManagerProfileID(input interface{}, key string) (warnings []string, errors []error)
• type HeatMapEndpoint
• type HeatMapGetOperationOptions
  • func DefaultHeatMapGetOperationOptions() HeatMapGetOperationOptions
  • func (o HeatMapGetOperationOptions) ToHeaders() *client.Headers
  • func (o HeatMapGetOperationOptions) ToOData() *odata.Query
  • func (o HeatMapGetOperationOptions) ToQuery() *client.QueryParams
• type HeatMapGetOperationResponse
• type HeatMapModel
• type HeatMapProperties
  • func (o *HeatMapProperties) GetEndTimeAsTime() (*time.Time, error)
  • func (o *HeatMapProperties) GetStartTimeAsTime() (*time.Time, error)
  • func (o *HeatMapProperties) SetEndTimeAsTime(input time.Time)
  • func (o *HeatMapProperties) SetStartTimeAsTime(input time.Time)
• type HeatMapsClient
  • func NewHeatMapsClientWithBaseURI(sdkApi sdkEnv.Api) (*HeatMapsClient, error)
  • func (c HeatMapsClient) HeatMapGet(ctx context.Context, id TrafficManagerProfileId, ...) (result HeatMapGetOperationResponse, err error)
• type QueryExperience
• type TrafficFlow
• type TrafficManagerProfileId
  • func NewTrafficManagerProfileID(subscriptionId string, resourceGroupName string, ...) TrafficManagerProfileId
  • func ParseTrafficManagerProfileID(input string) (*TrafficManagerProfileId, error)
  • func ParseTrafficManagerProfileIDInsensitively(input string) (*TrafficManagerProfileId, error)
  • func (id TrafficManagerProfileId) ID() string
  • func (id TrafficManagerProfileId) Segments() []resourceids.Segment
  • func (id TrafficManagerProfileId) String() string

Functions

func ValidateTrafficManagerProfileID

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

ValidateTrafficManagerProfileID checks that 'input' can be parsed as a Traffic Manager Profile ID

Types

type HeatMapEndpoint

type HeatMapEndpoint struct {
	EndpointId *int64  `json:"endpointId,omitempty"`
	ResourceId *string `json:"resourceId,omitempty"`
}

type HeatMapGetOperationOptions

type HeatMapGetOperationOptions struct {
	BotRight *string
	TopLeft  *string
}

func DefaultHeatMapGetOperationOptions

func DefaultHeatMapGetOperationOptions() HeatMapGetOperationOptions

func (HeatMapGetOperationOptions) ToHeaders

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

func (HeatMapGetOperationOptions) ToOData

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

func (HeatMapGetOperationOptions) ToQuery

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

type HeatMapGetOperationResponse

type HeatMapGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *HeatMapModel
}

type HeatMapModel

type HeatMapModel struct {
	Id         *string            `json:"id,omitempty"`
	Name       *string            `json:"name,omitempty"`
	Properties *HeatMapProperties `json:"properties,omitempty"`
	Type       *string            `json:"type,omitempty"`
}

type HeatMapProperties

type HeatMapProperties struct {
	EndTime      *string            `json:"endTime,omitempty"`
	Endpoints    *[]HeatMapEndpoint `json:"endpoints,omitempty"`
	StartTime    *string            `json:"startTime,omitempty"`
	TrafficFlows *[]TrafficFlow     `json:"trafficFlows,omitempty"`
}

func (*HeatMapProperties) GetEndTimeAsTime

func (o *HeatMapProperties) GetEndTimeAsTime() (*time.Time, error)

func (*HeatMapProperties) GetStartTimeAsTime

func (o *HeatMapProperties) GetStartTimeAsTime() (*time.Time, error)

func (*HeatMapProperties) SetEndTimeAsTime

func (o *HeatMapProperties) SetEndTimeAsTime(input time.Time)

func (*HeatMapProperties) SetStartTimeAsTime

func (o *HeatMapProperties) SetStartTimeAsTime(input time.Time)

type HeatMapsClient

type HeatMapsClient struct {
	Client *resourcemanager.Client
}

func NewHeatMapsClientWithBaseURI

func NewHeatMapsClientWithBaseURI(sdkApi sdkEnv.Api) (*HeatMapsClient, error)

func (HeatMapsClient) HeatMapGet

func (c HeatMapsClient) HeatMapGet(ctx context.Context, id TrafficManagerProfileId, options HeatMapGetOperationOptions) (result HeatMapGetOperationResponse, err error)

HeatMapGet ...

type QueryExperience

type QueryExperience struct {
	EndpointId int64    `json:"endpointId"`
	Latency    *float64 `json:"latency,omitempty"`
	QueryCount int64    `json:"queryCount"`
}

type TrafficFlow

type TrafficFlow struct {
	Latitude         *float64           `json:"latitude,omitempty"`
	Longitude        *float64           `json:"longitude,omitempty"`
	QueryExperiences *[]QueryExperience `json:"queryExperiences,omitempty"`
	SourceIP         *string            `json:"sourceIp,omitempty"`
}

type TrafficManagerProfileId

type TrafficManagerProfileId struct {
	SubscriptionId            string
	ResourceGroupName         string
	TrafficManagerProfileName string
}

TrafficManagerProfileId is a struct representing the Resource ID for a Traffic Manager Profile

func NewTrafficManagerProfileID

func NewTrafficManagerProfileID(subscriptionId string, resourceGroupName string, trafficManagerProfileName string) TrafficManagerProfileId

NewTrafficManagerProfileID returns a new TrafficManagerProfileId struct

func ParseTrafficManagerProfileID

func ParseTrafficManagerProfileID(input string) (*TrafficManagerProfileId, error)

ParseTrafficManagerProfileID parses 'input' into a TrafficManagerProfileId

func ParseTrafficManagerProfileIDInsensitively

func ParseTrafficManagerProfileIDInsensitively(input string) (*TrafficManagerProfileId, error)

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

func (TrafficManagerProfileId) ID

func (id TrafficManagerProfileId) ID() string

ID returns the formatted Traffic Manager Profile ID

func (TrafficManagerProfileId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Traffic Manager Profile ID

func (TrafficManagerProfileId) String

func (id TrafficManagerProfileId) String() string

String returns a human-readable description of this Traffic Manager Profile ID