alertrulesapis

README

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

The alertrulesapis 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-sdk/resource-manager/insights/2016-03-01/alertrulesapis"

Client Initialization

client := alertrulesapis.NewAlertRulesAPIsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: AlertRulesAPIsClient.AlertRulesUpdate

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

payload := alertrulesapis.AlertRuleResourcePatch{
	// ...
}


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

Documentation

Index

• func PossibleValuesForConditionOperator() []string
• func PossibleValuesForTimeAggregationOperator() []string
• func ValidateAlertRuleID(input interface{}, key string) (warnings []string, errors []error)
• type AlertRule
  • func (o *AlertRule) GetLastUpdatedTimeAsTime() (*time.Time, error)
  • func (o *AlertRule) SetLastUpdatedTimeAsTime(input time.Time)
  • func (s *AlertRule) UnmarshalJSON(bytes []byte) error
• type AlertRuleId
  • func NewAlertRuleID(subscriptionId string, resourceGroupName string, alertRuleName string) AlertRuleId
  • func ParseAlertRuleID(input string) (*AlertRuleId, error)
  • func ParseAlertRuleIDInsensitively(input string) (*AlertRuleId, error)
  • func (id AlertRuleId) ID() string
  • func (id AlertRuleId) Segments() []resourceids.Segment
  • func (id AlertRuleId) String() string
• type AlertRuleResource
• type AlertRuleResourcePatch
• type AlertRulesAPIsClient
  • func NewAlertRulesAPIsClientWithBaseURI(endpoint string) AlertRulesAPIsClient
  • func (c AlertRulesAPIsClient) AlertRulesUpdate(ctx context.Context, id AlertRuleId, input AlertRuleResourcePatch) (result AlertRulesUpdateOperationResponse, err error)
• type AlertRulesUpdateOperationResponse
• type ConditionOperator
• type LocationThresholdRuleCondition
  • func (s LocationThresholdRuleCondition) MarshalJSON() ([]byte, error)
  • func (s *LocationThresholdRuleCondition) UnmarshalJSON(bytes []byte) error
• type ManagementEventAggregationCondition
• type ManagementEventRuleCondition
  • func (s ManagementEventRuleCondition) MarshalJSON() ([]byte, error)
  • func (s *ManagementEventRuleCondition) UnmarshalJSON(bytes []byte) error
• type RuleAction
• type RuleCondition
• type RuleDataSource
• type RuleEmailAction
  • func (s RuleEmailAction) MarshalJSON() ([]byte, error)
• type RuleManagementEventClaimsDataSource
• type RuleManagementEventDataSource
  • func (s RuleManagementEventDataSource) MarshalJSON() ([]byte, error)
• type RuleMetricDataSource
  • func (s RuleMetricDataSource) MarshalJSON() ([]byte, error)
• type RuleWebhookAction
  • func (s RuleWebhookAction) MarshalJSON() ([]byte, error)
• type ThresholdRuleCondition
  • func (s ThresholdRuleCondition) MarshalJSON() ([]byte, error)
  • func (s *ThresholdRuleCondition) UnmarshalJSON(bytes []byte) error
• type TimeAggregationOperator

Functions

func PossibleValuesForConditionOperator

func PossibleValuesForConditionOperator() []string

func PossibleValuesForTimeAggregationOperator

func PossibleValuesForTimeAggregationOperator() []string

func ValidateAlertRuleID

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

ValidateAlertRuleID checks that 'input' can be parsed as a Alert Rule ID

Types

type AlertRule

type AlertRule struct {
	Action            RuleAction    `json:"action"`
	Actions           *[]RuleAction `json:"actions,omitempty"`
	Condition         RuleCondition `json:"condition"`
	Description       *string       `json:"description,omitempty"`
	IsEnabled         bool          `json:"isEnabled"`
	LastUpdatedTime   *string       `json:"lastUpdatedTime,omitempty"`
	Name              string        `json:"name"`
	ProvisioningState *string       `json:"provisioningState,omitempty"`
}

func (*AlertRule) GetLastUpdatedTimeAsTime

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

func (*AlertRule) SetLastUpdatedTimeAsTime

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

func (*AlertRule) UnmarshalJSON

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

type AlertRuleId

type AlertRuleId struct {
	SubscriptionId    string
	ResourceGroupName string
	AlertRuleName     string
}

AlertRuleId is a struct representing the Resource ID for a Alert Rule

func NewAlertRuleID

func NewAlertRuleID(subscriptionId string, resourceGroupName string, alertRuleName string) AlertRuleId

NewAlertRuleID returns a new AlertRuleId struct

func ParseAlertRuleID

func ParseAlertRuleID(input string) (*AlertRuleId, error)

ParseAlertRuleID parses 'input' into a AlertRuleId

func ParseAlertRuleIDInsensitively

func ParseAlertRuleIDInsensitively(input string) (*AlertRuleId, error)

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

func (AlertRuleId) ID

func (id AlertRuleId) ID() string

ID returns the formatted Alert Rule ID

func (AlertRuleId) Segments

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

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

func (AlertRuleId) String

func (id AlertRuleId) String() string

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

type AlertRuleResource

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

type AlertRuleResourcePatch

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

type AlertRulesAPIsClient

type AlertRulesAPIsClient struct {
	Client autorest.Client
	// contains filtered or unexported fields
}

func NewAlertRulesAPIsClientWithBaseURI

func NewAlertRulesAPIsClientWithBaseURI(endpoint string) AlertRulesAPIsClient

func (AlertRulesAPIsClient) AlertRulesUpdate

func (c AlertRulesAPIsClient) AlertRulesUpdate(ctx context.Context, id AlertRuleId, input AlertRuleResourcePatch) (result AlertRulesUpdateOperationResponse, err error)

AlertRulesUpdate ...

type AlertRulesUpdateOperationResponse

type AlertRulesUpdateOperationResponse struct {
	HttpResponse *http.Response
	Model        *AlertRuleResource
}

type ConditionOperator

type ConditionOperator string

const (
	ConditionOperatorGreaterThan        ConditionOperator = "GreaterThan"
	ConditionOperatorGreaterThanOrEqual ConditionOperator = "GreaterThanOrEqual"
	ConditionOperatorLessThan           ConditionOperator = "LessThan"
	ConditionOperatorLessThanOrEqual    ConditionOperator = "LessThanOrEqual"
)

type LocationThresholdRuleCondition

type LocationThresholdRuleCondition struct {
	FailedLocationCount int64   `json:"failedLocationCount"`
	WindowSize          *string `json:"windowSize,omitempty"`

	// Fields inherited from RuleCondition
	DataSource RuleDataSource `json:"dataSource"`
}

func (LocationThresholdRuleCondition) MarshalJSON

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

func (*LocationThresholdRuleCondition) UnmarshalJSON

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

type ManagementEventAggregationCondition

type ManagementEventAggregationCondition struct {
	Operator   *ConditionOperator `json:"operator,omitempty"`
	Threshold  *float64           `json:"threshold,omitempty"`
	WindowSize *string            `json:"windowSize,omitempty"`
}

type ManagementEventRuleCondition

type ManagementEventRuleCondition struct {
	Aggregation *ManagementEventAggregationCondition `json:"aggregation,omitempty"`

	// Fields inherited from RuleCondition
	DataSource RuleDataSource `json:"dataSource"`
}

func (ManagementEventRuleCondition) MarshalJSON

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

func (*ManagementEventRuleCondition) UnmarshalJSON

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

type RuleAction

type RuleAction interface {
}

type RuleCondition

type RuleCondition interface {
}

type RuleDataSource

type RuleDataSource interface {
}

type RuleEmailAction

type RuleEmailAction struct {
	CustomEmails        *[]string `json:"customEmails,omitempty"`
	SendToServiceOwners *bool     `json:"sendToServiceOwners,omitempty"`
}

func (RuleEmailAction) MarshalJSON

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

type RuleManagementEventClaimsDataSource

type RuleManagementEventClaimsDataSource struct {
	EmailAddress *string `json:"emailAddress,omitempty"`
}

type RuleManagementEventDataSource

type RuleManagementEventDataSource struct {
	Claims               *RuleManagementEventClaimsDataSource `json:"claims,omitempty"`
	EventName            *string                              `json:"eventName,omitempty"`
	EventSource          *string                              `json:"eventSource,omitempty"`
	Level                *string                              `json:"level,omitempty"`
	OperationName        *string                              `json:"operationName,omitempty"`
	ResourceGroupName    *string                              `json:"resourceGroupName,omitempty"`
	ResourceProviderName *string                              `json:"resourceProviderName,omitempty"`
	Status               *string                              `json:"status,omitempty"`
	SubStatus            *string                              `json:"subStatus,omitempty"`

	// Fields inherited from RuleDataSource
	LegacyResourceId *string `json:"legacyResourceId,omitempty"`
	MetricNamespace  *string `json:"metricNamespace,omitempty"`
	ResourceLocation *string `json:"resourceLocation,omitempty"`
	ResourceUri      *string `json:"resourceUri,omitempty"`
}

func (RuleManagementEventDataSource) MarshalJSON

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

type RuleMetricDataSource

type RuleMetricDataSource struct {
	MetricName *string `json:"metricName,omitempty"`

	// Fields inherited from RuleDataSource
	LegacyResourceId *string `json:"legacyResourceId,omitempty"`
	MetricNamespace  *string `json:"metricNamespace,omitempty"`
	ResourceLocation *string `json:"resourceLocation,omitempty"`
	ResourceUri      *string `json:"resourceUri,omitempty"`
}

func (RuleMetricDataSource) MarshalJSON

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

type RuleWebhookAction

type RuleWebhookAction struct {
	Properties *map[string]string `json:"properties,omitempty"`
	ServiceUri *string            `json:"serviceUri,omitempty"`
}

func (RuleWebhookAction) MarshalJSON

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

type ThresholdRuleCondition

type ThresholdRuleCondition struct {
	Operator        ConditionOperator        `json:"operator"`
	Threshold       float64                  `json:"threshold"`
	TimeAggregation *TimeAggregationOperator `json:"timeAggregation,omitempty"`
	WindowSize      *string                  `json:"windowSize,omitempty"`

	// Fields inherited from RuleCondition
	DataSource RuleDataSource `json:"dataSource"`
}

func (ThresholdRuleCondition) MarshalJSON

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

func (*ThresholdRuleCondition) UnmarshalJSON

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

type TimeAggregationOperator

type TimeAggregationOperator string

const (
	TimeAggregationOperatorAverage TimeAggregationOperator = "Average"
	TimeAggregationOperatorLast    TimeAggregationOperator = "Last"
	TimeAggregationOperatorMaximum TimeAggregationOperator = "Maximum"
	TimeAggregationOperatorMinimum TimeAggregationOperator = "Minimum"
	TimeAggregationOperatorTotal   TimeAggregationOperator = "Total"
)