README ¶
github.com/hashicorp/go-azure-sdk/resource-manager/insights/2016-03-01/alertrules
Documentation
The alertrules
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/alertrules"
Client Initialization
client := alertrules.NewAlertRulesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer
Example Usage: AlertRulesClient.CreateOrUpdate
ctx := context.TODO()
id := alertrules.NewAlertRuleID("12345678-1234-9876-4563-123456789012", "example-resource-group", "alertRuleValue")
payload := alertrules.AlertRuleResource{
// ...
}
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: AlertRulesClient.Delete
ctx := context.TODO()
id := alertrules.NewAlertRuleID("12345678-1234-9876-4563-123456789012", "example-resource-group", "alertRuleValue")
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: AlertRulesClient.Get
ctx := context.TODO()
id := alertrules.NewAlertRuleID("12345678-1234-9876-4563-123456789012", "example-resource-group", "alertRuleValue")
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: AlertRulesClient.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: AlertRulesClient.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
}
Documentation ¶
Index ¶
- func PossibleValuesForConditionOperator() []string
- func PossibleValuesForTimeAggregationOperator() []string
- func ValidateAlertRuleID(input interface{}, key string) (warnings []string, errors []error)
- type AlertRule
- type AlertRuleId
- type AlertRuleResource
- type AlertRuleResourceCollection
- type AlertRulesClient
- func (c AlertRulesClient) CreateOrUpdate(ctx context.Context, id AlertRuleId, input AlertRuleResource) (result CreateOrUpdateOperationResponse, err error)
- func (c AlertRulesClient) Delete(ctx context.Context, id AlertRuleId) (result DeleteOperationResponse, err error)
- func (c AlertRulesClient) Get(ctx context.Context, id AlertRuleId) (result GetOperationResponse, err error)
- func (c AlertRulesClient) ListByResourceGroup(ctx context.Context, id commonids.ResourceGroupId) (result ListByResourceGroupOperationResponse, err error)
- func (c AlertRulesClient) ListBySubscription(ctx context.Context, id commonids.SubscriptionId) (result ListBySubscriptionOperationResponse, err error)
- type ConditionOperator
- type CreateOrUpdateOperationResponse
- type DeleteOperationResponse
- type GetOperationResponse
- type ListByResourceGroupOperationResponse
- type ListBySubscriptionOperationResponse
- type LocationThresholdRuleCondition
- type ManagementEventAggregationCondition
- type ManagementEventRuleCondition
- type RawRuleActionImpl
- type RawRuleConditionImpl
- type RawRuleDataSourceImpl
- type RuleAction
- type RuleCondition
- type RuleDataSource
- type RuleEmailAction
- type RuleManagementEventClaimsDataSource
- type RuleManagementEventDataSource
- type RuleMetricDataSource
- type RuleWebhookAction
- type ThresholdRuleCondition
- type TimeAggregationOperator
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func PossibleValuesForConditionOperator ¶
func PossibleValuesForConditionOperator() []string
func PossibleValuesForTimeAggregationOperator ¶
func PossibleValuesForTimeAggregationOperator() []string
func ValidateAlertRuleID ¶
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 (*AlertRule) SetLastUpdatedTimeAsTime ¶
func (*AlertRule) UnmarshalJSON ¶
type AlertRuleId ¶
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) FromParseResult ¶
func (id *AlertRuleId) FromParseResult(input resourceids.ParseResult) error
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 AlertRuleResourceCollection ¶
type AlertRuleResourceCollection struct {
Value *[]AlertRuleResource `json:"value,omitempty"`
}
type AlertRulesClient ¶
func NewAlertRulesClientWithBaseURI ¶
func NewAlertRulesClientWithBaseURI(endpoint string) AlertRulesClient
func (AlertRulesClient) CreateOrUpdate ¶
func (c AlertRulesClient) CreateOrUpdate(ctx context.Context, id AlertRuleId, input AlertRuleResource) (result CreateOrUpdateOperationResponse, err error)
CreateOrUpdate ...
func (AlertRulesClient) Delete ¶
func (c AlertRulesClient) Delete(ctx context.Context, id AlertRuleId) (result DeleteOperationResponse, err error)
Delete ...
func (AlertRulesClient) Get ¶
func (c AlertRulesClient) Get(ctx context.Context, id AlertRuleId) (result GetOperationResponse, err error)
Get ...
func (AlertRulesClient) ListByResourceGroup ¶
func (c AlertRulesClient) ListByResourceGroup(ctx context.Context, id commonids.ResourceGroupId) (result ListByResourceGroupOperationResponse, err error)
ListByResourceGroup ...
func (AlertRulesClient) ListBySubscription ¶
func (c AlertRulesClient) ListBySubscription(ctx context.Context, id commonids.SubscriptionId) (result ListBySubscriptionOperationResponse, err error)
ListBySubscription ...
type ConditionOperator ¶
type ConditionOperator string
const ( ConditionOperatorGreaterThan ConditionOperator = "GreaterThan" ConditionOperatorGreaterThanOrEqual ConditionOperator = "GreaterThanOrEqual" ConditionOperatorLessThan ConditionOperator = "LessThan" ConditionOperatorLessThanOrEqual ConditionOperator = "LessThanOrEqual" )
type CreateOrUpdateOperationResponse ¶
type CreateOrUpdateOperationResponse struct { HttpResponse *http.Response Model *AlertRuleResource }
type DeleteOperationResponse ¶
type GetOperationResponse ¶
type GetOperationResponse struct { HttpResponse *http.Response Model *AlertRuleResource }
type ListByResourceGroupOperationResponse ¶
type ListByResourceGroupOperationResponse struct { HttpResponse *http.Response Model *AlertRuleResourceCollection }
type ListBySubscriptionOperationResponse ¶
type ListBySubscriptionOperationResponse struct { HttpResponse *http.Response Model *AlertRuleResourceCollection }
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 RawRuleActionImpl ¶
RawRuleActionImpl 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).
type RawRuleConditionImpl ¶
RawRuleConditionImpl 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).
type RawRuleDataSourceImpl ¶
RawRuleDataSourceImpl 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).
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" )
Source Files ¶
- client.go
- constants.go
- id_alertrule.go
- method_createorupdate_autorest.go
- method_delete_autorest.go
- method_get_autorest.go
- method_listbyresourcegroup_autorest.go
- method_listbysubscription_autorest.go
- model_alertrule.go
- model_alertruleresource.go
- model_alertruleresourcecollection.go
- model_locationthresholdrulecondition.go
- model_managementeventaggregationcondition.go
- model_managementeventrulecondition.go
- model_ruleaction.go
- model_rulecondition.go
- model_ruledatasource.go
- model_ruleemailaction.go
- model_rulemanagementeventclaimsdatasource.go
- model_rulemanagementeventdatasource.go
- model_rulemetricdatasource.go
- model_rulewebhookaction.go
- model_thresholdrulecondition.go
- version.go