triggeredanalyticsrulerun

README

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

The triggeredanalyticsrulerun 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/triggeredanalyticsrulerun"

Client Initialization

client := triggeredanalyticsrulerun.NewTriggeredAnalyticsRuleRunClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: TriggeredAnalyticsRuleRunClient.Get

ctx := context.TODO()
id := triggeredanalyticsrulerun.NewTriggeredAnalyticsRuleRunID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceName", "ruleRunId")

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
}

Documentation

Index

• func PossibleValuesForProvisioningState() []string
• func ValidateTriggeredAnalyticsRuleRunID(input interface{}, key string) (warnings []string, errors []error)
• type GetOperationResponse
• type ProvisioningState
  • func (s *ProvisioningState) UnmarshalJSON(bytes []byte) error
• type TriggeredAnalyticsRuleRun
• type TriggeredAnalyticsRuleRunClient
  • func NewTriggeredAnalyticsRuleRunClientWithBaseURI(sdkApi sdkEnv.Api) (*TriggeredAnalyticsRuleRunClient, error)
  • func (c TriggeredAnalyticsRuleRunClient) Get(ctx context.Context, id TriggeredAnalyticsRuleRunId) (result GetOperationResponse, err error)
• type TriggeredAnalyticsRuleRunId
  • func NewTriggeredAnalyticsRuleRunID(subscriptionId string, resourceGroupName string, workspaceName string, ...) TriggeredAnalyticsRuleRunId
  • func ParseTriggeredAnalyticsRuleRunID(input string) (*TriggeredAnalyticsRuleRunId, error)
  • func ParseTriggeredAnalyticsRuleRunIDInsensitively(input string) (*TriggeredAnalyticsRuleRunId, error)
  • func (id *TriggeredAnalyticsRuleRunId) FromParseResult(input resourceids.ParseResult) error
  • func (id TriggeredAnalyticsRuleRunId) ID() string
  • func (id TriggeredAnalyticsRuleRunId) Segments() []resourceids.Segment
  • func (id TriggeredAnalyticsRuleRunId) String() string
• type TriggeredAnalyticsRuleRunProperties
  • func (o *TriggeredAnalyticsRuleRunProperties) GetExecutionTimeUtcAsTime() (*time.Time, error)
  • func (o *TriggeredAnalyticsRuleRunProperties) SetExecutionTimeUtcAsTime(input time.Time)

Functions

func PossibleValuesForProvisioningState

func PossibleValuesForProvisioningState() []string

func ValidateTriggeredAnalyticsRuleRunID

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

ValidateTriggeredAnalyticsRuleRunID checks that 'input' can be parsed as a Triggered Analytics Rule Run ID

Types

type GetOperationResponse

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

type ProvisioningState

type ProvisioningState string

const (
	ProvisioningStateAccepted   ProvisioningState = "Accepted"
	ProvisioningStateCanceled   ProvisioningState = "Canceled"
	ProvisioningStateFailed     ProvisioningState = "Failed"
	ProvisioningStateInProgress ProvisioningState = "InProgress"
	ProvisioningStateSucceeded  ProvisioningState = "Succeeded"
)

func (*ProvisioningState) UnmarshalJSON

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

type TriggeredAnalyticsRuleRun

type TriggeredAnalyticsRuleRun struct {
	Etag       *string                             `json:"etag,omitempty"`
	Id         *string                             `json:"id,omitempty"`
	Name       *string                             `json:"name,omitempty"`
	Properties TriggeredAnalyticsRuleRunProperties `json:"properties"`
	SystemData *systemdata.SystemData              `json:"systemData,omitempty"`
	Type       *string                             `json:"type,omitempty"`
}

type TriggeredAnalyticsRuleRunClient

type TriggeredAnalyticsRuleRunClient struct {
	Client *resourcemanager.Client
}

func NewTriggeredAnalyticsRuleRunClientWithBaseURI

func NewTriggeredAnalyticsRuleRunClientWithBaseURI(sdkApi sdkEnv.Api) (*TriggeredAnalyticsRuleRunClient, error)

func (TriggeredAnalyticsRuleRunClient) Get

func (c TriggeredAnalyticsRuleRunClient) Get(ctx context.Context, id TriggeredAnalyticsRuleRunId) (result GetOperationResponse, err error)

Get ...

type TriggeredAnalyticsRuleRunId

type TriggeredAnalyticsRuleRunId struct {
	SubscriptionId    string
	ResourceGroupName string
	WorkspaceName     string
	RuleRunId         string
}

TriggeredAnalyticsRuleRunId is a struct representing the Resource ID for a Triggered Analytics Rule Run

func NewTriggeredAnalyticsRuleRunID

func NewTriggeredAnalyticsRuleRunID(subscriptionId string, resourceGroupName string, workspaceName string, ruleRunId string) TriggeredAnalyticsRuleRunId

NewTriggeredAnalyticsRuleRunID returns a new TriggeredAnalyticsRuleRunId struct

func ParseTriggeredAnalyticsRuleRunID

func ParseTriggeredAnalyticsRuleRunID(input string) (*TriggeredAnalyticsRuleRunId, error)

ParseTriggeredAnalyticsRuleRunID parses 'input' into a TriggeredAnalyticsRuleRunId

func ParseTriggeredAnalyticsRuleRunIDInsensitively

func ParseTriggeredAnalyticsRuleRunIDInsensitively(input string) (*TriggeredAnalyticsRuleRunId, error)

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

func (*TriggeredAnalyticsRuleRunId) FromParseResult

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

func (TriggeredAnalyticsRuleRunId) ID

func (id TriggeredAnalyticsRuleRunId) ID() string

ID returns the formatted Triggered Analytics Rule Run ID

func (TriggeredAnalyticsRuleRunId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Triggered Analytics Rule Run ID

func (TriggeredAnalyticsRuleRunId) String

func (id TriggeredAnalyticsRuleRunId) String() string

String returns a human-readable description of this Triggered Analytics Rule Run ID

type TriggeredAnalyticsRuleRunProperties

type TriggeredAnalyticsRuleRunProperties struct {
	ExecutionTimeUtc            string                  `json:"executionTimeUtc"`
	ProvisioningState           ProvisioningState       `json:"provisioningState"`
	RuleId                      string                  `json:"ruleId"`
	RuleRunAdditionalData       *map[string]interface{} `json:"ruleRunAdditionalData,omitempty"`
	TriggeredAnalyticsRuleRunId string                  `json:"triggeredAnalyticsRuleRunId"`
}

func (*TriggeredAnalyticsRuleRunProperties) GetExecutionTimeUtcAsTime

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

func (*TriggeredAnalyticsRuleRunProperties) SetExecutionTimeUtcAsTime

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