metricalerts

package
v0.20241126.2320 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/resource-manager/insights/2018-03-01/metricalerts Documentation

The metricalerts SDK allows for interaction with Azure Resource Manager insights (API Version 2018-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/2018-03-01/metricalerts"

Client Initialization

client := metricalerts.NewMetricAlertsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: MetricAlertsClient.CreateOrUpdate

ctx := context.TODO()
id := metricalerts.NewMetricAlertID("12345678-1234-9876-4563-123456789012", "example-resource-group", "metricAlertName")

payload := metricalerts.MetricAlertResource{
	// ...
}


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

Example Usage: MetricAlertsClient.Delete

ctx := context.TODO()
id := metricalerts.NewMetricAlertID("12345678-1234-9876-4563-123456789012", "example-resource-group", "metricAlertName")

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

Example Usage: MetricAlertsClient.Get

ctx := context.TODO()
id := metricalerts.NewMetricAlertID("12345678-1234-9876-4563-123456789012", "example-resource-group", "metricAlertName")

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: MetricAlertsClient.ListByResourceGroup

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

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

Example Usage: MetricAlertsClient.ListBySubscription

ctx := context.TODO()
id := commonids.NewSubscriptionID("12345678-1234-9876-4563-123456789012")

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

Example Usage: MetricAlertsClient.Update

ctx := context.TODO()
id := metricalerts.NewMetricAlertID("12345678-1234-9876-4563-123456789012", "example-resource-group", "metricAlertName")

payload := metricalerts.MetricAlertResourcePatch{
	// ...
}


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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForAggregationTypeEnum 

func PossibleValuesForAggregationTypeEnum() []string

func PossibleValuesForCriterionType 

func PossibleValuesForCriterionType() []string

func PossibleValuesForDynamicThresholdOperator 

func PossibleValuesForDynamicThresholdOperator() []string

func PossibleValuesForDynamicThresholdSensitivity 

func PossibleValuesForDynamicThresholdSensitivity() []string

func PossibleValuesForOdatatype 

func PossibleValuesForOdatatype() []string

func PossibleValuesForOperator 

func PossibleValuesForOperator() []string

func ValidateMetricAlertID 

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

ValidateMetricAlertID checks that 'input' can be parsed as a Metric Alert ID

Types

type AggregationTypeEnum 

type AggregationTypeEnum string
const (
	AggregationTypeEnumAverage AggregationTypeEnum = "Average"
	AggregationTypeEnumCount   AggregationTypeEnum = "Count"
	AggregationTypeEnumMaximum AggregationTypeEnum = "Maximum"
	AggregationTypeEnumMinimum AggregationTypeEnum = "Minimum"
	AggregationTypeEnumTotal   AggregationTypeEnum = "Total"
)

func (*AggregationTypeEnum) UnmarshalJSON 

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

type BaseMetricAlertCriteriaImpl 

type BaseMetricAlertCriteriaImpl struct {
	OdataType Odatatype `json:"odata.type"`
}

func (BaseMetricAlertCriteriaImpl) MetricAlertCriteria 

func (s BaseMetricAlertCriteriaImpl) MetricAlertCriteria() BaseMetricAlertCriteriaImpl

type BaseMultiMetricCriteriaImpl 

type BaseMultiMetricCriteriaImpl struct {
	CriterionType        CriterionType       `json:"criterionType"`
	Dimensions           *[]MetricDimension  `json:"dimensions,omitempty"`
	MetricName           string              `json:"metricName"`
	MetricNamespace      *string             `json:"metricNamespace,omitempty"`
	Name                 string              `json:"name"`
	SkipMetricValidation *bool               `json:"skipMetricValidation,omitempty"`
	TimeAggregation      AggregationTypeEnum `json:"timeAggregation"`
}

func (BaseMultiMetricCriteriaImpl) MultiMetricCriteria 

func (s BaseMultiMetricCriteriaImpl) MultiMetricCriteria() BaseMultiMetricCriteriaImpl

type CreateOrUpdateOperationResponse 

type CreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *MetricAlertResource
}

type CriterionType 

type CriterionType string
const (
	CriterionTypeDynamicThresholdCriterion CriterionType = "DynamicThresholdCriterion"
	CriterionTypeStaticThresholdCriterion  CriterionType = "StaticThresholdCriterion"
)

func (*CriterionType) UnmarshalJSON 

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

type DeleteOperationResponse 

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

type DynamicMetricCriteria 

type DynamicMetricCriteria struct {
	AlertSensitivity DynamicThresholdSensitivity    `json:"alertSensitivity"`
	FailingPeriods   DynamicThresholdFailingPeriods `json:"failingPeriods"`
	IgnoreDataBefore *string                        `json:"ignoreDataBefore,omitempty"`
	Operator         DynamicThresholdOperator       `json:"operator"`

	CriterionType        CriterionType       `json:"criterionType"`
	Dimensions           *[]MetricDimension  `json:"dimensions,omitempty"`
	MetricName           string              `json:"metricName"`
	MetricNamespace      *string             `json:"metricNamespace,omitempty"`
	Name                 string              `json:"name"`
	SkipMetricValidation *bool               `json:"skipMetricValidation,omitempty"`
	TimeAggregation      AggregationTypeEnum `json:"timeAggregation"`
}

func (DynamicMetricCriteria) MarshalJSON 

func (s DynamicMetricCriteria) MarshalJSON() ([]byte, error)

func (DynamicMetricCriteria) MultiMetricCriteria 

func (s DynamicMetricCriteria) MultiMetricCriteria() BaseMultiMetricCriteriaImpl

type DynamicThresholdFailingPeriods 

type DynamicThresholdFailingPeriods struct {
	MinFailingPeriodsToAlert  float64 `json:"minFailingPeriodsToAlert"`
	NumberOfEvaluationPeriods float64 `json:"numberOfEvaluationPeriods"`
}

type DynamicThresholdOperator 

type DynamicThresholdOperator string
const (
	DynamicThresholdOperatorGreaterOrLessThan DynamicThresholdOperator = "GreaterOrLessThan"
	DynamicThresholdOperatorGreaterThan       DynamicThresholdOperator = "GreaterThan"
	DynamicThresholdOperatorLessThan          DynamicThresholdOperator = "LessThan"
)

func (*DynamicThresholdOperator) UnmarshalJSON 

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

type DynamicThresholdSensitivity 

type DynamicThresholdSensitivity string
const (
	DynamicThresholdSensitivityHigh   DynamicThresholdSensitivity = "High"
	DynamicThresholdSensitivityLow    DynamicThresholdSensitivity = "Low"
	DynamicThresholdSensitivityMedium DynamicThresholdSensitivity = "Medium"
)

func (*DynamicThresholdSensitivity) UnmarshalJSON 

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

type GetOperationResponse 

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

type ListByResourceGroupOperationResponse 

type ListByResourceGroupOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *MetricAlertResourceCollection
}

type ListBySubscriptionOperationResponse 

type ListBySubscriptionOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *MetricAlertResourceCollection
}

type MetricAlertAction 

type MetricAlertAction struct {
	ActionGroupId     *string            `json:"actionGroupId,omitempty"`
	WebHookProperties *map[string]string `json:"webHookProperties,omitempty"`
}

type MetricAlertCriteria 

type MetricAlertCriteria interface {
	MetricAlertCriteria() BaseMetricAlertCriteriaImpl
}

func UnmarshalMetricAlertCriteriaImplementation 

func UnmarshalMetricAlertCriteriaImplementation(input []byte) (MetricAlertCriteria, error)

type MetricAlertId 

type MetricAlertId struct {
	SubscriptionId    string
	ResourceGroupName string
	MetricAlertName   string
}

MetricAlertId is a struct representing the Resource ID for a Metric Alert

func NewMetricAlertID 

func NewMetricAlertID(subscriptionId string, resourceGroupName string, metricAlertName string) MetricAlertId

NewMetricAlertID returns a new MetricAlertId struct

func ParseMetricAlertID 

func ParseMetricAlertID(input string) (*MetricAlertId, error)

ParseMetricAlertID parses 'input' into a MetricAlertId

func ParseMetricAlertIDInsensitively 

func ParseMetricAlertIDInsensitively(input string) (*MetricAlertId, error)

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

func (*MetricAlertId) FromParseResult 

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

func (MetricAlertId) ID 

func (id MetricAlertId) ID() string

ID returns the formatted Metric Alert ID

func (MetricAlertId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Metric Alert ID

func (MetricAlertId) String 

func (id MetricAlertId) String() string

String returns a human-readable description of this Metric Alert ID

type MetricAlertMultipleResourceMultipleMetricCriteria 

type MetricAlertMultipleResourceMultipleMetricCriteria struct {
	AllOf *[]MultiMetricCriteria `json:"allOf,omitempty"`

	OdataType Odatatype `json:"odata.type"`
}

func (MetricAlertMultipleResourceMultipleMetricCriteria) MarshalJSON 

func (s MetricAlertMultipleResourceMultipleMetricCriteria) MarshalJSON() ([]byte, error)

func (MetricAlertMultipleResourceMultipleMetricCriteria) MetricAlertCriteria 

func (s MetricAlertMultipleResourceMultipleMetricCriteria) MetricAlertCriteria() BaseMetricAlertCriteriaImpl

func (*MetricAlertMultipleResourceMultipleMetricCriteria) UnmarshalJSON 

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

type MetricAlertProperties 

type MetricAlertProperties struct {
	Actions              *[]MetricAlertAction `json:"actions,omitempty"`
	AutoMitigate         *bool                `json:"autoMitigate,omitempty"`
	Criteria             MetricAlertCriteria  `json:"criteria"`
	Description          *string              `json:"description,omitempty"`
	Enabled              bool                 `json:"enabled"`
	EvaluationFrequency  string               `json:"evaluationFrequency"`
	IsMigrated           *bool                `json:"isMigrated,omitempty"`
	LastUpdatedTime      *string              `json:"lastUpdatedTime,omitempty"`
	Scopes               []string             `json:"scopes"`
	Severity             int64                `json:"severity"`
	TargetResourceRegion *string              `json:"targetResourceRegion,omitempty"`
	TargetResourceType   *string              `json:"targetResourceType,omitempty"`
	WindowSize           string               `json:"windowSize"`
}

func (*MetricAlertProperties) GetLastUpdatedTimeAsTime 

func (o *MetricAlertProperties) GetLastUpdatedTimeAsTime() (*time.Time, error)

func (*MetricAlertProperties) SetLastUpdatedTimeAsTime 

func (o *MetricAlertProperties) SetLastUpdatedTimeAsTime(input time.Time)

func (*MetricAlertProperties) UnmarshalJSON 

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

type MetricAlertPropertiesPatch 

type MetricAlertPropertiesPatch struct {
	Actions              *[]MetricAlertAction `json:"actions,omitempty"`
	AutoMitigate         *bool                `json:"autoMitigate,omitempty"`
	Criteria             MetricAlertCriteria  `json:"criteria"`
	Description          *string              `json:"description,omitempty"`
	Enabled              *bool                `json:"enabled,omitempty"`
	EvaluationFrequency  *string              `json:"evaluationFrequency,omitempty"`
	IsMigrated           *bool                `json:"isMigrated,omitempty"`
	LastUpdatedTime      *string              `json:"lastUpdatedTime,omitempty"`
	Scopes               *[]string            `json:"scopes,omitempty"`
	Severity             *int64               `json:"severity,omitempty"`
	TargetResourceRegion *string              `json:"targetResourceRegion,omitempty"`
	TargetResourceType   *string              `json:"targetResourceType,omitempty"`
	WindowSize           *string              `json:"windowSize,omitempty"`
}

func (*MetricAlertPropertiesPatch) GetLastUpdatedTimeAsTime 

func (o *MetricAlertPropertiesPatch) GetLastUpdatedTimeAsTime() (*time.Time, error)

func (*MetricAlertPropertiesPatch) SetLastUpdatedTimeAsTime 

func (o *MetricAlertPropertiesPatch) SetLastUpdatedTimeAsTime(input time.Time)

func (*MetricAlertPropertiesPatch) UnmarshalJSON 

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

type MetricAlertResource 

type MetricAlertResource struct {
	Id         *string               `json:"id,omitempty"`
	Location   string                `json:"location"`
	Name       *string               `json:"name,omitempty"`
	Properties MetricAlertProperties `json:"properties"`
	Tags       *map[string]string    `json:"tags,omitempty"`
	Type       *string               `json:"type,omitempty"`
}

type MetricAlertResourceCollection 

type MetricAlertResourceCollection struct {
	Value *[]MetricAlertResource `json:"value,omitempty"`
}

type MetricAlertResourcePatch 

type MetricAlertResourcePatch struct {
	Properties *MetricAlertPropertiesPatch `json:"properties,omitempty"`
	Tags       *map[string]string          `json:"tags,omitempty"`
}

type MetricAlertSingleResourceMultipleMetricCriteria 

type MetricAlertSingleResourceMultipleMetricCriteria struct {
	AllOf *[]MetricCriteria `json:"allOf,omitempty"`

	OdataType Odatatype `json:"odata.type"`
}

func (MetricAlertSingleResourceMultipleMetricCriteria) MarshalJSON 

func (s MetricAlertSingleResourceMultipleMetricCriteria) MarshalJSON() ([]byte, error)

func (MetricAlertSingleResourceMultipleMetricCriteria) MetricAlertCriteria 

func (s MetricAlertSingleResourceMultipleMetricCriteria) MetricAlertCriteria() BaseMetricAlertCriteriaImpl

type MetricAlertsClient 

type MetricAlertsClient struct {
	Client *resourcemanager.Client
}

func NewMetricAlertsClientWithBaseURI 

func NewMetricAlertsClientWithBaseURI(sdkApi sdkEnv.Api) (*MetricAlertsClient, error)

func (MetricAlertsClient) CreateOrUpdate 

func (c MetricAlertsClient) CreateOrUpdate(ctx context.Context, id MetricAlertId, input MetricAlertResource) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (MetricAlertsClient) Delete 

func (c MetricAlertsClient) Delete(ctx context.Context, id MetricAlertId) (result DeleteOperationResponse, err error)

Delete ...

func (MetricAlertsClient) Get 

func (c MetricAlertsClient) Get(ctx context.Context, id MetricAlertId) (result GetOperationResponse, err error)

Get ...

func (MetricAlertsClient) ListByResourceGroup 

func (c MetricAlertsClient) ListByResourceGroup(ctx context.Context, id commonids.ResourceGroupId) (result ListByResourceGroupOperationResponse, err error)

ListByResourceGroup ...

func (MetricAlertsClient) ListBySubscription 

func (c MetricAlertsClient) ListBySubscription(ctx context.Context, id commonids.SubscriptionId) (result ListBySubscriptionOperationResponse, err error)

ListBySubscription ...

func (MetricAlertsClient) Update 

func (c MetricAlertsClient) Update(ctx context.Context, id MetricAlertId, input MetricAlertResourcePatch) (result UpdateOperationResponse, err error)

Update ...

type MetricCriteria 

type MetricCriteria struct {
	Operator  Operator `json:"operator"`
	Threshold float64  `json:"threshold"`

	CriterionType        CriterionType       `json:"criterionType"`
	Dimensions           *[]MetricDimension  `json:"dimensions,omitempty"`
	MetricName           string              `json:"metricName"`
	MetricNamespace      *string             `json:"metricNamespace,omitempty"`
	Name                 string              `json:"name"`
	SkipMetricValidation *bool               `json:"skipMetricValidation,omitempty"`
	TimeAggregation      AggregationTypeEnum `json:"timeAggregation"`
}

func (MetricCriteria) MarshalJSON 

func (s MetricCriteria) MarshalJSON() ([]byte, error)

func (MetricCriteria) MultiMetricCriteria 

func (s MetricCriteria) MultiMetricCriteria() BaseMultiMetricCriteriaImpl

type MetricDimension 

type MetricDimension struct {
	Name     string   `json:"name"`
	Operator string   `json:"operator"`
	Values   []string `json:"values"`
}

type MultiMetricCriteria 

type MultiMetricCriteria interface {
	MultiMetricCriteria() BaseMultiMetricCriteriaImpl
}

func UnmarshalMultiMetricCriteriaImplementation 

func UnmarshalMultiMetricCriteriaImplementation(input []byte) (MultiMetricCriteria, error)

type Odatatype 

type Odatatype string
const (
	OdatatypeMicrosoftPointAzurePointMonitorPointMultipleResourceMultipleMetricCriteria Odatatype = "Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria"
	OdatatypeMicrosoftPointAzurePointMonitorPointSingleResourceMultipleMetricCriteria   Odatatype = "Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria"
	OdatatypeMicrosoftPointAzurePointMonitorPointWebtestLocationAvailabilityCriteria    Odatatype = "Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria"
)

func (*Odatatype) UnmarshalJSON 

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

type Operator 

type Operator string
const (
	OperatorEquals             Operator = "Equals"
	OperatorGreaterThan        Operator = "GreaterThan"
	OperatorGreaterThanOrEqual Operator = "GreaterThanOrEqual"
	OperatorLessThan           Operator = "LessThan"
	OperatorLessThanOrEqual    Operator = "LessThanOrEqual"
)

func (*Operator) UnmarshalJSON 

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

type RawMetricAlertCriteriaImpl 

type RawMetricAlertCriteriaImpl struct {
	Type   string
	Values map[string]interface{}
	// contains filtered or unexported fields
}

RawMetricAlertCriteriaImpl is returned when the Discriminated Value doesn't match any of the defined types NOTE: this should only be used when a type isn't defined for this type of Object (as a workaround) and is used only for Deserialization (e.g. this cannot be used as a Request Payload).

func (RawMetricAlertCriteriaImpl) MetricAlertCriteria 

func (s RawMetricAlertCriteriaImpl) MetricAlertCriteria() BaseMetricAlertCriteriaImpl

type RawMultiMetricCriteriaImpl 

type RawMultiMetricCriteriaImpl struct {
	Type   string
	Values map[string]interface{}
	// contains filtered or unexported fields
}

RawMultiMetricCriteriaImpl is returned when the Discriminated Value doesn't match any of the defined types NOTE: this should only be used when a type isn't defined for this type of Object (as a workaround) and is used only for Deserialization (e.g. this cannot be used as a Request Payload).

func (RawMultiMetricCriteriaImpl) MultiMetricCriteria 

func (s RawMultiMetricCriteriaImpl) MultiMetricCriteria() BaseMultiMetricCriteriaImpl

type UpdateOperationResponse 

type UpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *MetricAlertResource
}

type WebtestLocationAvailabilityCriteria 

type WebtestLocationAvailabilityCriteria struct {
	ComponentId         string  `json:"componentId"`
	FailedLocationCount float64 `json:"failedLocationCount"`
	WebTestId           string  `json:"webTestId"`

	OdataType Odatatype `json:"odata.type"`
}

func (WebtestLocationAvailabilityCriteria) MarshalJSON 

func (s WebtestLocationAvailabilityCriteria) MarshalJSON() ([]byte, error)

func (WebtestLocationAvailabilityCriteria) MetricAlertCriteria 

func (s WebtestLocationAvailabilityCriteria) MetricAlertCriteria() BaseMetricAlertCriteriaImpl

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.