triggeranalyticsrulerun

README

github.com/hashicorp/go-azure-sdk/resource-manager/securityinsights/2023-12-01-preview/triggeranalyticsrulerun Documentation

The triggeranalyticsrulerun SDK allows for interaction with Azure Resource Manager securityinsights (API Version 2023-12-01-preview).

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/securityinsights/2023-12-01-preview/triggeranalyticsrulerun"

Client Initialization

client := triggeranalyticsrulerun.NewTriggerAnalyticsRuleRunClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: TriggerAnalyticsRuleRunClient.AlertRuleTriggerRuleRun

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

payload := triggeranalyticsrulerun.AnalyticsRuleRunTrigger{
	// ...
}


if err := client.AlertRuleTriggerRuleRunThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Documentation

Index

• func ValidateAlertRuleID(input interface{}, key string) (warnings []string, errors []error)
• type AlertRuleId
  • func NewAlertRuleID(subscriptionId string, resourceGroupName string, workspaceName string, ...) AlertRuleId
  • func ParseAlertRuleID(input string) (*AlertRuleId, error)
  • func ParseAlertRuleIDInsensitively(input string) (*AlertRuleId, error)
  • func (id *AlertRuleId) FromParseResult(input resourceids.ParseResult) error
  • func (id AlertRuleId) ID() string
  • func (id AlertRuleId) Segments() []resourceids.Segment
  • func (id AlertRuleId) String() string
• type AlertRuleTriggerRuleRunOperationResponse
• type AnalyticsRuleRunTrigger
• type AnalyticsRuleRunTriggerProperties
  • func (o *AnalyticsRuleRunTriggerProperties) GetExecutionTimeUtcAsTime() (*time.Time, error)
  • func (o *AnalyticsRuleRunTriggerProperties) SetExecutionTimeUtcAsTime(input time.Time)
• type TriggerAnalyticsRuleRunClient
  • func NewTriggerAnalyticsRuleRunClientWithBaseURI(sdkApi sdkEnv.Api) (*TriggerAnalyticsRuleRunClient, error)
  • func (c TriggerAnalyticsRuleRunClient) AlertRuleTriggerRuleRun(ctx context.Context, id AlertRuleId, input AnalyticsRuleRunTrigger) (result AlertRuleTriggerRuleRunOperationResponse, err error)
  • func (c TriggerAnalyticsRuleRunClient) AlertRuleTriggerRuleRunThenPoll(ctx context.Context, id AlertRuleId, input AnalyticsRuleRunTrigger) error

Functions

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 AlertRuleId

type AlertRuleId struct {
	SubscriptionId    string
	ResourceGroupName string
	WorkspaceName     string
	RuleId            string
}

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

func NewAlertRuleID

func NewAlertRuleID(subscriptionId string, resourceGroupName string, workspaceName string, ruleId 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) 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 AlertRuleTriggerRuleRunOperationResponse

type AlertRuleTriggerRuleRunOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type AnalyticsRuleRunTrigger

type AnalyticsRuleRunTrigger struct {
	Properties AnalyticsRuleRunTriggerProperties `json:"properties"`
}

type AnalyticsRuleRunTriggerProperties

type AnalyticsRuleRunTriggerProperties struct {
	ExecutionTimeUtc string `json:"executionTimeUtc"`
}

func (*AnalyticsRuleRunTriggerProperties) GetExecutionTimeUtcAsTime

func (o *AnalyticsRuleRunTriggerProperties) GetExecutionTimeUtcAsTime() (*time.Time, error)

func (*AnalyticsRuleRunTriggerProperties) SetExecutionTimeUtcAsTime

func (o *AnalyticsRuleRunTriggerProperties) SetExecutionTimeUtcAsTime(input time.Time)

type TriggerAnalyticsRuleRunClient

type TriggerAnalyticsRuleRunClient struct {
	Client *resourcemanager.Client
}

func NewTriggerAnalyticsRuleRunClientWithBaseURI

func NewTriggerAnalyticsRuleRunClientWithBaseURI(sdkApi sdkEnv.Api) (*TriggerAnalyticsRuleRunClient, error)

func (TriggerAnalyticsRuleRunClient) AlertRuleTriggerRuleRun

func (c TriggerAnalyticsRuleRunClient) AlertRuleTriggerRuleRun(ctx context.Context, id AlertRuleId, input AnalyticsRuleRunTrigger) (result AlertRuleTriggerRuleRunOperationResponse, err error)

AlertRuleTriggerRuleRun ...

func (TriggerAnalyticsRuleRunClient) AlertRuleTriggerRuleRunThenPoll

func (c TriggerAnalyticsRuleRunClient) AlertRuleTriggerRuleRunThenPoll(ctx context.Context, id AlertRuleId, input AnalyticsRuleRunTrigger) error

AlertRuleTriggerRuleRunThenPoll performs AlertRuleTriggerRuleRun then polls until it's completed