triggeredanalyticsruleruns

README

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

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

Client Initialization

client := triggeredanalyticsruleruns.NewTriggeredAnalyticsRuleRunsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: TriggeredAnalyticsRuleRunsClient.GetTriggeredAnalyticsRuleRunsList

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

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

Documentation

Index

• func PossibleValuesForProvisioningState() []string
• func ValidateWorkspaceID(input interface{}, key string) (warnings []string, errors []error)
• type GetTriggeredAnalyticsRuleRunsListCompleteResult
• type GetTriggeredAnalyticsRuleRunsListCustomPager
  • func (p *GetTriggeredAnalyticsRuleRunsListCustomPager) NextPageLink() *odata.Link
• type GetTriggeredAnalyticsRuleRunsListOperationResponse
• type ProvisioningState
  • func (s *ProvisioningState) UnmarshalJSON(bytes []byte) error
• type TriggeredAnalyticsRuleRun
• type TriggeredAnalyticsRuleRunOperationPredicate
  • func (p TriggeredAnalyticsRuleRunOperationPredicate) Matches(input TriggeredAnalyticsRuleRun) bool
• type TriggeredAnalyticsRuleRunProperties
  • func (o *TriggeredAnalyticsRuleRunProperties) GetExecutionTimeUtcAsTime() (*time.Time, error)
  • func (o *TriggeredAnalyticsRuleRunProperties) SetExecutionTimeUtcAsTime(input time.Time)
• type TriggeredAnalyticsRuleRunsClient
  • func NewTriggeredAnalyticsRuleRunsClientWithBaseURI(sdkApi sdkEnv.Api) (*TriggeredAnalyticsRuleRunsClient, error)
  • func (c TriggeredAnalyticsRuleRunsClient) GetTriggeredAnalyticsRuleRunsList(ctx context.Context, id WorkspaceId) (result GetTriggeredAnalyticsRuleRunsListOperationResponse, err error)
  • func (c TriggeredAnalyticsRuleRunsClient) GetTriggeredAnalyticsRuleRunsListComplete(ctx context.Context, id WorkspaceId) (GetTriggeredAnalyticsRuleRunsListCompleteResult, error)
  • func (c TriggeredAnalyticsRuleRunsClient) GetTriggeredAnalyticsRuleRunsListCompleteMatchingPredicate(ctx context.Context, id WorkspaceId, ...) (result GetTriggeredAnalyticsRuleRunsListCompleteResult, err error)
• type WorkspaceId
  • func NewWorkspaceID(subscriptionId string, resourceGroupName string, workspaceName string) WorkspaceId
  • func ParseWorkspaceID(input string) (*WorkspaceId, error)
  • func ParseWorkspaceIDInsensitively(input string) (*WorkspaceId, error)
  • func (id *WorkspaceId) FromParseResult(input resourceids.ParseResult) error
  • func (id WorkspaceId) ID() string
  • func (id WorkspaceId) Segments() []resourceids.Segment
  • func (id WorkspaceId) String() string

Functions

func PossibleValuesForProvisioningState

func PossibleValuesForProvisioningState() []string

func ValidateWorkspaceID

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

ValidateWorkspaceID checks that 'input' can be parsed as a Workspace ID

Types

type GetTriggeredAnalyticsRuleRunsListCompleteResult

type GetTriggeredAnalyticsRuleRunsListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []TriggeredAnalyticsRuleRun
}

type GetTriggeredAnalyticsRuleRunsListCustomPager

type GetTriggeredAnalyticsRuleRunsListCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}

func (*GetTriggeredAnalyticsRuleRunsListCustomPager) NextPageLink

func (p *GetTriggeredAnalyticsRuleRunsListCustomPager) NextPageLink() *odata.Link

type GetTriggeredAnalyticsRuleRunsListOperationResponse

type GetTriggeredAnalyticsRuleRunsListOperationResponse 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 TriggeredAnalyticsRuleRunOperationPredicate

type TriggeredAnalyticsRuleRunOperationPredicate struct {
	Etag *string
	Id   *string
	Name *string
	Type *string
}

func (TriggeredAnalyticsRuleRunOperationPredicate) Matches

func (p TriggeredAnalyticsRuleRunOperationPredicate) Matches(input TriggeredAnalyticsRuleRun) bool

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)

type TriggeredAnalyticsRuleRunsClient

type TriggeredAnalyticsRuleRunsClient struct {
	Client *resourcemanager.Client
}

func NewTriggeredAnalyticsRuleRunsClientWithBaseURI

func NewTriggeredAnalyticsRuleRunsClientWithBaseURI(sdkApi sdkEnv.Api) (*TriggeredAnalyticsRuleRunsClient, error)

func (TriggeredAnalyticsRuleRunsClient) GetTriggeredAnalyticsRuleRunsList

func (c TriggeredAnalyticsRuleRunsClient) GetTriggeredAnalyticsRuleRunsList(ctx context.Context, id WorkspaceId) (result GetTriggeredAnalyticsRuleRunsListOperationResponse, err error)

GetTriggeredAnalyticsRuleRunsList ...

func (TriggeredAnalyticsRuleRunsClient) GetTriggeredAnalyticsRuleRunsListComplete

func (c TriggeredAnalyticsRuleRunsClient) GetTriggeredAnalyticsRuleRunsListComplete(ctx context.Context, id WorkspaceId) (GetTriggeredAnalyticsRuleRunsListCompleteResult, error)

GetTriggeredAnalyticsRuleRunsListComplete retrieves all the results into a single object

func (TriggeredAnalyticsRuleRunsClient) GetTriggeredAnalyticsRuleRunsListCompleteMatchingPredicate

func (c TriggeredAnalyticsRuleRunsClient) GetTriggeredAnalyticsRuleRunsListCompleteMatchingPredicate(ctx context.Context, id WorkspaceId, predicate TriggeredAnalyticsRuleRunOperationPredicate) (result GetTriggeredAnalyticsRuleRunsListCompleteResult, err error)

GetTriggeredAnalyticsRuleRunsListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type WorkspaceId

type WorkspaceId struct {
	SubscriptionId    string
	ResourceGroupName string
	WorkspaceName     string
}

WorkspaceId is a struct representing the Resource ID for a Workspace

func NewWorkspaceID

func NewWorkspaceID(subscriptionId string, resourceGroupName string, workspaceName string) WorkspaceId

NewWorkspaceID returns a new WorkspaceId struct

func ParseWorkspaceID

func ParseWorkspaceID(input string) (*WorkspaceId, error)

ParseWorkspaceID parses 'input' into a WorkspaceId

func ParseWorkspaceIDInsensitively

func ParseWorkspaceIDInsensitively(input string) (*WorkspaceId, error)

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

func (*WorkspaceId) FromParseResult

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

func (WorkspaceId) ID

func (id WorkspaceId) ID() string

ID returns the formatted Workspace ID

func (WorkspaceId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Workspace ID

func (WorkspaceId) String

func (id WorkspaceId) String() string

String returns a human-readable description of this Workspace ID