alertprocessingrules

package
v0.20230823.1052657 Latest Latest
Warning

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

 Go to latest Published: Aug 23, 2023 License: MPL-2.0 Imports: 12 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/alertsmanagement/2021-08-08/alertprocessingrules Documentation

The alertprocessingrules SDK allows for interaction with the Azure Resource Manager Service alertsmanagement (API Version 2021-08-08).

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/alertsmanagement/2021-08-08/alertprocessingrules"

Client Initialization

client := alertprocessingrules.NewAlertProcessingRulesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: AlertProcessingRulesClient.AlertProcessingRulesCreateOrUpdate

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

payload := alertprocessingrules.AlertProcessingRule{
	// ...
}


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

Example Usage: AlertProcessingRulesClient.AlertProcessingRulesDelete

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

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

Example Usage: AlertProcessingRulesClient.AlertProcessingRulesGetByName

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

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

Example Usage: AlertProcessingRulesClient.AlertProcessingRulesListByResourceGroup

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

// alternatively `client.AlertProcessingRulesListByResourceGroup(ctx, id)` can be used to do batched pagination
items, err := client.AlertProcessingRulesListByResourceGroupComplete(ctx, id)
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: AlertProcessingRulesClient.AlertProcessingRulesListBySubscription

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

// alternatively `client.AlertProcessingRulesListBySubscription(ctx, id)` can be used to do batched pagination
items, err := client.AlertProcessingRulesListBySubscriptionComplete(ctx, id)
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: AlertProcessingRulesClient.AlertProcessingRulesUpdate

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

payload := alertprocessingrules.PatchObject{
	// ...
}


read, err := client.AlertProcessingRulesUpdate(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 PossibleValuesForActionType 

func PossibleValuesForActionType() []string

func PossibleValuesForDaysOfWeek 

func PossibleValuesForDaysOfWeek() []string

func PossibleValuesForField 

func PossibleValuesForField() []string

func PossibleValuesForOperator 

func PossibleValuesForOperator() []string

func PossibleValuesForRecurrenceType 

func PossibleValuesForRecurrenceType() []string

func ValidateActionRuleID 

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

ValidateActionRuleID checks that 'input' can be parsed as a Action Rule ID

Types

type Action 

type Action interface {
}

type ActionRuleId 

type ActionRuleId struct {
	SubscriptionId    string
	ResourceGroupName string
	ActionRuleName    string
}

ActionRuleId is a struct representing the Resource ID for a Action Rule

func NewActionRuleID 

func NewActionRuleID(subscriptionId string, resourceGroupName string, actionRuleName string) ActionRuleId

NewActionRuleID returns a new ActionRuleId struct

func ParseActionRuleID 

func ParseActionRuleID(input string) (*ActionRuleId, error)

ParseActionRuleID parses 'input' into a ActionRuleId

func ParseActionRuleIDInsensitively 

func ParseActionRuleIDInsensitively(input string) (*ActionRuleId, error)

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

func (ActionRuleId) ID 

func (id ActionRuleId) ID() string

ID returns the formatted Action Rule ID

func (ActionRuleId) Segments 

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

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

func (ActionRuleId) String 

func (id ActionRuleId) String() string

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

type ActionType 

type ActionType string
const (
	ActionTypeAddActionGroups       ActionType = "AddActionGroups"
	ActionTypeRemoveAllActionGroups ActionType = "RemoveAllActionGroups"
)

func (*ActionType) UnmarshalJSON added in v0.20230731.1080956 

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

type AddActionGroups 

type AddActionGroups struct {
	ActionGroupIds []string `json:"actionGroupIds"`
}

func (AddActionGroups) MarshalJSON 

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

type AlertProcessingRule 

type AlertProcessingRule struct {
	Id         *string                        `json:"id,omitempty"`
	Location   string                         `json:"location"`
	Name       *string                        `json:"name,omitempty"`
	Properties *AlertProcessingRuleProperties `json:"properties,omitempty"`
	SystemData *systemdata.SystemData         `json:"systemData,omitempty"`
	Tags       *map[string]string             `json:"tags,omitempty"`
	Type       *string                        `json:"type,omitempty"`
}

type AlertProcessingRuleOperationPredicate 

type AlertProcessingRuleOperationPredicate struct {
	Id       *string
	Location *string
	Name     *string
	Type     *string
}

func (AlertProcessingRuleOperationPredicate) Matches 

func (p AlertProcessingRuleOperationPredicate) Matches(input AlertProcessingRule) bool

type AlertProcessingRuleProperties 

type AlertProcessingRuleProperties struct {
	Actions     []Action     `json:"actions"`
	Conditions  *[]Condition `json:"conditions,omitempty"`
	Description *string      `json:"description,omitempty"`
	Enabled     *bool        `json:"enabled,omitempty"`
	Schedule    *Schedule    `json:"schedule,omitempty"`
	Scopes      []string     `json:"scopes"`
}

func (*AlertProcessingRuleProperties) UnmarshalJSON 

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

type AlertProcessingRulesClient 

type AlertProcessingRulesClient struct {
	Client *resourcemanager.Client
}

func NewAlertProcessingRulesClientWithBaseURI 

func NewAlertProcessingRulesClientWithBaseURI(sdkApi sdkEnv.Api) (*AlertProcessingRulesClient, error)

func (AlertProcessingRulesClient) AlertProcessingRulesCreateOrUpdate 

func (c AlertProcessingRulesClient) AlertProcessingRulesCreateOrUpdate(ctx context.Context, id ActionRuleId, input AlertProcessingRule) (result AlertProcessingRulesCreateOrUpdateOperationResponse, err error)

AlertProcessingRulesCreateOrUpdate ...

func (AlertProcessingRulesClient) AlertProcessingRulesDelete 

func (c AlertProcessingRulesClient) AlertProcessingRulesDelete(ctx context.Context, id ActionRuleId) (result AlertProcessingRulesDeleteOperationResponse, err error)

AlertProcessingRulesDelete ...

func (AlertProcessingRulesClient) AlertProcessingRulesGetByName 

func (c AlertProcessingRulesClient) AlertProcessingRulesGetByName(ctx context.Context, id ActionRuleId) (result AlertProcessingRulesGetByNameOperationResponse, err error)

AlertProcessingRulesGetByName ...

func (AlertProcessingRulesClient) AlertProcessingRulesListByResourceGroup 

func (c AlertProcessingRulesClient) AlertProcessingRulesListByResourceGroup(ctx context.Context, id commonids.ResourceGroupId) (result AlertProcessingRulesListByResourceGroupOperationResponse, err error)

AlertProcessingRulesListByResourceGroup ...

func (AlertProcessingRulesClient) AlertProcessingRulesListByResourceGroupComplete 

func (c AlertProcessingRulesClient) AlertProcessingRulesListByResourceGroupComplete(ctx context.Context, id commonids.ResourceGroupId) (AlertProcessingRulesListByResourceGroupCompleteResult, error)

AlertProcessingRulesListByResourceGroupComplete retrieves all the results into a single object

func (AlertProcessingRulesClient) AlertProcessingRulesListByResourceGroupCompleteMatchingPredicate 

func (c AlertProcessingRulesClient) AlertProcessingRulesListByResourceGroupCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, predicate AlertProcessingRuleOperationPredicate) (result AlertProcessingRulesListByResourceGroupCompleteResult, err error)

AlertProcessingRulesListByResourceGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (AlertProcessingRulesClient) AlertProcessingRulesListBySubscription 

func (c AlertProcessingRulesClient) AlertProcessingRulesListBySubscription(ctx context.Context, id commonids.SubscriptionId) (result AlertProcessingRulesListBySubscriptionOperationResponse, err error)

AlertProcessingRulesListBySubscription ...

func (AlertProcessingRulesClient) AlertProcessingRulesListBySubscriptionComplete 

func (c AlertProcessingRulesClient) AlertProcessingRulesListBySubscriptionComplete(ctx context.Context, id commonids.SubscriptionId) (AlertProcessingRulesListBySubscriptionCompleteResult, error)

AlertProcessingRulesListBySubscriptionComplete retrieves all the results into a single object

func (AlertProcessingRulesClient) AlertProcessingRulesListBySubscriptionCompleteMatchingPredicate 

func (c AlertProcessingRulesClient) AlertProcessingRulesListBySubscriptionCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, predicate AlertProcessingRuleOperationPredicate) (result AlertProcessingRulesListBySubscriptionCompleteResult, err error)

AlertProcessingRulesListBySubscriptionCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (AlertProcessingRulesClient) AlertProcessingRulesUpdate 

func (c AlertProcessingRulesClient) AlertProcessingRulesUpdate(ctx context.Context, id ActionRuleId, input PatchObject) (result AlertProcessingRulesUpdateOperationResponse, err error)

AlertProcessingRulesUpdate ...

type AlertProcessingRulesCreateOrUpdateOperationResponse 

type AlertProcessingRulesCreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *AlertProcessingRule
}

type AlertProcessingRulesDeleteOperationResponse 

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

type AlertProcessingRulesGetByNameOperationResponse 

type AlertProcessingRulesGetByNameOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *AlertProcessingRule
}

type AlertProcessingRulesListByResourceGroupCompleteResult 

type AlertProcessingRulesListByResourceGroupCompleteResult struct {
	Items []AlertProcessingRule
}

type AlertProcessingRulesListByResourceGroupOperationResponse 

type AlertProcessingRulesListByResourceGroupOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]AlertProcessingRule
}

type AlertProcessingRulesListBySubscriptionCompleteResult 

type AlertProcessingRulesListBySubscriptionCompleteResult struct {
	Items []AlertProcessingRule
}

type AlertProcessingRulesListBySubscriptionOperationResponse 

type AlertProcessingRulesListBySubscriptionOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]AlertProcessingRule
}

type AlertProcessingRulesUpdateOperationResponse 

type AlertProcessingRulesUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *AlertProcessingRule
}

type Condition 

type Condition struct {
	Field    *Field    `json:"field,omitempty"`
	Operator *Operator `json:"operator,omitempty"`
	Values   *[]string `json:"values,omitempty"`
}

type DailyRecurrence 

type DailyRecurrence struct {

	// Fields inherited from Recurrence
	EndTime   *string `json:"endTime,omitempty"`
	StartTime *string `json:"startTime,omitempty"`
}

func (DailyRecurrence) MarshalJSON 

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

type DaysOfWeek 

type DaysOfWeek string
const (
	DaysOfWeekFriday    DaysOfWeek = "Friday"
	DaysOfWeekMonday    DaysOfWeek = "Monday"
	DaysOfWeekSaturday  DaysOfWeek = "Saturday"
	DaysOfWeekSunday    DaysOfWeek = "Sunday"
	DaysOfWeekThursday  DaysOfWeek = "Thursday"
	DaysOfWeekTuesday   DaysOfWeek = "Tuesday"
	DaysOfWeekWednesday DaysOfWeek = "Wednesday"
)

func (*DaysOfWeek) UnmarshalJSON added in v0.20230731.1080956 

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

type Field 

type Field string
const (
	FieldAlertContext        Field = "AlertContext"
	FieldAlertRuleId         Field = "AlertRuleId"
	FieldAlertRuleName       Field = "AlertRuleName"
	FieldDescription         Field = "Description"
	FieldMonitorCondition    Field = "MonitorCondition"
	FieldMonitorService      Field = "MonitorService"
	FieldSeverity            Field = "Severity"
	FieldSignalType          Field = "SignalType"
	FieldTargetResource      Field = "TargetResource"
	FieldTargetResourceGroup Field = "TargetResourceGroup"
	FieldTargetResourceType  Field = "TargetResourceType"
)

func (*Field) UnmarshalJSON added in v0.20230731.1080956 

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

type MonthlyRecurrence 

type MonthlyRecurrence struct {
	DaysOfMonth []int64 `json:"daysOfMonth"`

	// Fields inherited from Recurrence
	EndTime   *string `json:"endTime,omitempty"`
	StartTime *string `json:"startTime,omitempty"`
}

func (MonthlyRecurrence) MarshalJSON 

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

type Operator 

type Operator string
const (
	OperatorContains       Operator = "Contains"
	OperatorDoesNotContain Operator = "DoesNotContain"
	OperatorEquals         Operator = "Equals"
	OperatorNotEquals      Operator = "NotEquals"
)

func (*Operator) UnmarshalJSON added in v0.20230731.1080956 

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

type PatchObject 

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

type PatchProperties 

type PatchProperties struct {
	Enabled *bool `json:"enabled,omitempty"`
}

type RawActionImpl added in v0.20230807.1063129 

type RawActionImpl struct {
	Type   string
	Values map[string]interface{}
}

RawModeOfTransitImpl 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 RawRecurrenceImpl added in v0.20230807.1063129 

type RawRecurrenceImpl struct {
	Type   string
	Values map[string]interface{}
}

RawModeOfTransitImpl 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 Recurrence 

type Recurrence interface {
}

type RecurrenceType 

type RecurrenceType string
const (
	RecurrenceTypeDaily   RecurrenceType = "Daily"
	RecurrenceTypeMonthly RecurrenceType = "Monthly"
	RecurrenceTypeWeekly  RecurrenceType = "Weekly"
)

func (*RecurrenceType) UnmarshalJSON added in v0.20230731.1080956 

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

type RemoveAllActionGroups 

type RemoveAllActionGroups struct {
}

func (RemoveAllActionGroups) MarshalJSON 

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

type Schedule 

type Schedule struct {
	EffectiveFrom  *string       `json:"effectiveFrom,omitempty"`
	EffectiveUntil *string       `json:"effectiveUntil,omitempty"`
	Recurrences    *[]Recurrence `json:"recurrences,omitempty"`
	TimeZone       *string       `json:"timeZone,omitempty"`
}

func (*Schedule) UnmarshalJSON 

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

type WeeklyRecurrence 

type WeeklyRecurrence struct {
	DaysOfWeek []DaysOfWeek `json:"daysOfWeek"`

	// Fields inherited from Recurrence
	EndTime   *string `json:"endTime,omitempty"`
	StartTime *string `json:"startTime,omitempty"`
}

func (WeeklyRecurrence) MarshalJSON 

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

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.