metricdefinitions

README

github.com/hashicorp/go-azure-sdk/resource-manager/insights/2016-03-01/metricdefinitions Documentation

The metricdefinitions SDK allows for interaction with the Azure Resource Manager Service insights (API Version 2016-03-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-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/insights/2016-03-01/metricdefinitions"

Client Initialization

client := metricdefinitions.NewMetricDefinitionsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: MetricDefinitionsClient.List

ctx := context.TODO()
id := commonids.NewScopeID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group")

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

Documentation

Index

• func PossibleValuesForAggregationType() []string
• func PossibleValuesForUnit() []string
• type AggregationType
  • func (s *AggregationType) UnmarshalJSON(bytes []byte) error
• type ListOperationOptions
  • func DefaultListOperationOptions() ListOperationOptions
  • func (o ListOperationOptions) ToHeaders() *client.Headers
  • func (o ListOperationOptions) ToOData() *odata.Query
  • func (o ListOperationOptions) ToQuery() *client.QueryParams
• type ListOperationResponse
• type LocalizableString
• type MetricAvailability
• type MetricDefinition
• type MetricDefinitionCollection
• type MetricDefinitionsClient
  • func NewMetricDefinitionsClientWithBaseURI(sdkApi sdkEnv.Api) (*MetricDefinitionsClient, error)
  • func (c MetricDefinitionsClient) List(ctx context.Context, id commonids.ScopeId, options ListOperationOptions) (result ListOperationResponse, err error)
• type Unit
  • func (s *Unit) UnmarshalJSON(bytes []byte) error

Functions

func PossibleValuesForAggregationType

func PossibleValuesForAggregationType() []string

func PossibleValuesForUnit

func PossibleValuesForUnit() []string

Types

type AggregationType

type AggregationType string

const (
	AggregationTypeAverage AggregationType = "Average"
	AggregationTypeCount   AggregationType = "Count"
	AggregationTypeMaximum AggregationType = "Maximum"
	AggregationTypeMinimum AggregationType = "Minimum"
	AggregationTypeNone    AggregationType = "None"
	AggregationTypeTotal   AggregationType = "Total"
)

func (*AggregationType) UnmarshalJSON

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

type ListOperationOptions

type ListOperationOptions struct {
	Filter *string
}

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        *MetricDefinitionCollection
}

type LocalizableString

type LocalizableString struct {
	LocalizedValue *string `json:"localizedValue,omitempty"`
	Value          string  `json:"value"`
}

type MetricAvailability

type MetricAvailability struct {
	Retention *string `json:"retention,omitempty"`
	TimeGrain *string `json:"timeGrain,omitempty"`
}

type MetricDefinition

type MetricDefinition struct {
	Id                     *string               `json:"id,omitempty"`
	MetricAvailabilities   *[]MetricAvailability `json:"metricAvailabilities,omitempty"`
	Name                   *LocalizableString    `json:"name,omitempty"`
	PrimaryAggregationType *AggregationType      `json:"primaryAggregationType,omitempty"`
	ResourceId             *string               `json:"resourceId,omitempty"`
	Unit                   *Unit                 `json:"unit,omitempty"`
}

type MetricDefinitionCollection

type MetricDefinitionCollection struct {
	Value []MetricDefinition `json:"value"`
}

type MetricDefinitionsClient

type MetricDefinitionsClient struct {
	Client *resourcemanager.Client
}

func NewMetricDefinitionsClientWithBaseURI

func NewMetricDefinitionsClientWithBaseURI(sdkApi sdkEnv.Api) (*MetricDefinitionsClient, error)

func (MetricDefinitionsClient) List

func (c MetricDefinitionsClient) List(ctx context.Context, id commonids.ScopeId, options ListOperationOptions) (result ListOperationResponse, err error)

List ...

type Unit

type Unit string

const (
	UnitBitsPerSecond  Unit = "BitsPerSecond"
	UnitByteSeconds    Unit = "ByteSeconds"
	UnitBytes          Unit = "Bytes"
	UnitBytesPerSecond Unit = "BytesPerSecond"
	UnitCores          Unit = "Cores"
	UnitCount          Unit = "Count"
	UnitCountPerSecond Unit = "CountPerSecond"
	UnitMilliCores     Unit = "MilliCores"
	UnitMilliSeconds   Unit = "MilliSeconds"
	UnitNanoCores      Unit = "NanoCores"
	UnitPercent        Unit = "Percent"
	UnitSeconds        Unit = "Seconds"
	UnitUnspecified    Unit = "Unspecified"
)

func (*Unit) UnmarshalJSON

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