alertruletemplates

package
v0.20220907.1111434 Latest Latest
Warning

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

 Go to latest Published: Sep 7, 2022 License: MPL-2.0 Imports: 11 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/securityinsights/2021-09-01-preview/alertruletemplates Documentation

The alertruletemplates SDK allows for interaction with the Azure Resource Manager Service securityinsights (API Version 2021-09-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/2021-09-01-preview/alertruletemplates"

Client Initialization

client := alertruletemplates.NewAlertRuleTemplatesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: AlertRuleTemplatesClient.AlertRuleTemplatesGet

ctx := context.TODO()
id := alertruletemplates.NewAlertRuleTemplateID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "alertRuleTemplateIdValue")

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

Example Usage: AlertRuleTemplatesClient.AlertRuleTemplatesList

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

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForAlertRuleKind 

func PossibleValuesForAlertRuleKind() []string

func PossibleValuesForAlertSeverity 

func PossibleValuesForAlertSeverity() []string

func PossibleValuesForAttackTactic 

func PossibleValuesForAttackTactic() []string

func ValidateAlertRuleTemplateID 

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

ValidateAlertRuleTemplateID checks that 'input' can be parsed as a Alert Rule Template ID

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 AlertRuleKind 

type AlertRuleKind string
const (
	AlertRuleKindFusion                            AlertRuleKind = "Fusion"
	AlertRuleKindMLBehaviorAnalytics               AlertRuleKind = "MLBehaviorAnalytics"
	AlertRuleKindMicrosoftSecurityIncidentCreation AlertRuleKind = "MicrosoftSecurityIncidentCreation"
	AlertRuleKindNRT                               AlertRuleKind = "NRT"
	AlertRuleKindScheduled                         AlertRuleKind = "Scheduled"
	AlertRuleKindThreatIntelligence                AlertRuleKind = "ThreatIntelligence"
)

type AlertRuleTemplate 

type AlertRuleTemplate interface {
}

type AlertRuleTemplateId 

type AlertRuleTemplateId struct {
	SubscriptionId      string
	ResourceGroupName   string
	WorkspaceName       string
	AlertRuleTemplateId string
}

AlertRuleTemplateId is a struct representing the Resource ID for a Alert Rule Template

func NewAlertRuleTemplateID 

func NewAlertRuleTemplateID(subscriptionId string, resourceGroupName string, workspaceName string, alertRuleTemplateId string) AlertRuleTemplateId

NewAlertRuleTemplateID returns a new AlertRuleTemplateId struct

func ParseAlertRuleTemplateID 

func ParseAlertRuleTemplateID(input string) (*AlertRuleTemplateId, error)

ParseAlertRuleTemplateID parses 'input' into a AlertRuleTemplateId

func ParseAlertRuleTemplateIDInsensitively 

func ParseAlertRuleTemplateIDInsensitively(input string) (*AlertRuleTemplateId, error)

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

func (AlertRuleTemplateId) ID 

func (id AlertRuleTemplateId) ID() string

ID returns the formatted Alert Rule Template ID

func (AlertRuleTemplateId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Alert Rule Template ID

func (AlertRuleTemplateId) String 

func (id AlertRuleTemplateId) String() string

String returns a human-readable description of this Alert Rule Template ID

type AlertRuleTemplateOperationPredicate 

type AlertRuleTemplateOperationPredicate struct {
}

func (AlertRuleTemplateOperationPredicate) Matches 

func (p AlertRuleTemplateOperationPredicate) Matches(input AlertRuleTemplate) bool

type AlertRuleTemplatesClient 

type AlertRuleTemplatesClient struct {
	Client autorest.Client
	// contains filtered or unexported fields
}

func NewAlertRuleTemplatesClientWithBaseURI 

func NewAlertRuleTemplatesClientWithBaseURI(endpoint string) AlertRuleTemplatesClient

func (AlertRuleTemplatesClient) AlertRuleTemplatesGet 

func (c AlertRuleTemplatesClient) AlertRuleTemplatesGet(ctx context.Context, id AlertRuleTemplateId) (result AlertRuleTemplatesGetOperationResponse, err error)

AlertRuleTemplatesGet ...

func (AlertRuleTemplatesClient) AlertRuleTemplatesList 

func (c AlertRuleTemplatesClient) AlertRuleTemplatesList(ctx context.Context, id WorkspaceId) (resp AlertRuleTemplatesListOperationResponse, err error)

AlertRuleTemplatesList ...

func (AlertRuleTemplatesClient) AlertRuleTemplatesListComplete 

func (c AlertRuleTemplatesClient) AlertRuleTemplatesListComplete(ctx context.Context, id WorkspaceId) (AlertRuleTemplatesListCompleteResult, error)

AlertRuleTemplatesListComplete retrieves all of the results into a single object

func (AlertRuleTemplatesClient) AlertRuleTemplatesListCompleteMatchingPredicate 

func (c AlertRuleTemplatesClient) AlertRuleTemplatesListCompleteMatchingPredicate(ctx context.Context, id WorkspaceId, predicate AlertRuleTemplateOperationPredicate) (resp AlertRuleTemplatesListCompleteResult, err error)

AlertRuleTemplatesListCompleteMatchingPredicate retrieves all of the results and then applied the predicate

type AlertRuleTemplatesGetOperationResponse 

type AlertRuleTemplatesGetOperationResponse struct {
	HttpResponse *http.Response
	Model        *AlertRuleTemplate
}

type AlertRuleTemplatesListCompleteResult 

type AlertRuleTemplatesListCompleteResult struct {
	Items []AlertRuleTemplate
}

type AlertRuleTemplatesListOperationResponse 

type AlertRuleTemplatesListOperationResponse struct {
	HttpResponse *http.Response
	Model        *[]AlertRuleTemplate
	// contains filtered or unexported fields
}

func (AlertRuleTemplatesListOperationResponse) HasMore 

func (r AlertRuleTemplatesListOperationResponse) HasMore() bool

func (AlertRuleTemplatesListOperationResponse) LoadMore 

func (r AlertRuleTemplatesListOperationResponse) LoadMore(ctx context.Context) (resp AlertRuleTemplatesListOperationResponse, err error)

type AlertSeverity 

type AlertSeverity string
const (
	AlertSeverityHigh          AlertSeverity = "High"
	AlertSeverityInformational AlertSeverity = "Informational"
	AlertSeverityLow           AlertSeverity = "Low"
	AlertSeverityMedium        AlertSeverity = "Medium"
)

type AttackTactic 

type AttackTactic string
const (
	AttackTacticCollection          AttackTactic = "Collection"
	AttackTacticCommandAndControl   AttackTactic = "CommandAndControl"
	AttackTacticCredentialAccess    AttackTactic = "CredentialAccess"
	AttackTacticDefenseEvasion      AttackTactic = "DefenseEvasion"
	AttackTacticDiscovery           AttackTactic = "Discovery"
	AttackTacticExecution           AttackTactic = "Execution"
	AttackTacticExfiltration        AttackTactic = "Exfiltration"
	AttackTacticImpact              AttackTactic = "Impact"
	AttackTacticInitialAccess       AttackTactic = "InitialAccess"
	AttackTacticLateralMovement     AttackTactic = "LateralMovement"
	AttackTacticPersistence         AttackTactic = "Persistence"
	AttackTacticPreAttack           AttackTactic = "PreAttack"
	AttackTacticPrivilegeEscalation AttackTactic = "PrivilegeEscalation"
)

type FusionAlertRuleTemplate 

type FusionAlertRuleTemplate struct {
	Properties *FusionAlertRuleTemplateProperties `json:"properties,omitempty"`

	// Fields inherited from AlertRuleTemplate
	Id         *string                `json:"id,omitempty"`
	Name       *string                `json:"name,omitempty"`
	SystemData *systemdata.SystemData `json:"systemData,omitempty"`
	Type       *string                `json:"type,omitempty"`
}

func (FusionAlertRuleTemplate) MarshalJSON 

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

type FusionAlertRuleTemplateProperties 

type FusionAlertRuleTemplateProperties struct {
	Severity AlertSeverity   `json:"severity"`
	Tactics  *[]AttackTactic `json:"tactics,omitempty"`
}

type MLBehaviorAnalyticsAlertRuleTemplate 

type MLBehaviorAnalyticsAlertRuleTemplate struct {
	Properties *MLBehaviorAnalyticsAlertRuleTemplateProperties `json:"properties,omitempty"`

	// Fields inherited from AlertRuleTemplate
	Id         *string                `json:"id,omitempty"`
	Name       *string                `json:"name,omitempty"`
	SystemData *systemdata.SystemData `json:"systemData,omitempty"`
	Type       *string                `json:"type,omitempty"`
}

func (MLBehaviorAnalyticsAlertRuleTemplate) MarshalJSON 

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

type MLBehaviorAnalyticsAlertRuleTemplateProperties 

type MLBehaviorAnalyticsAlertRuleTemplateProperties struct {
	Severity AlertSeverity   `json:"severity"`
	Tactics  *[]AttackTactic `json:"tactics,omitempty"`
}

type MicrosoftSecurityIncidentCreationAlertRuleTemplate 

type MicrosoftSecurityIncidentCreationAlertRuleTemplate struct {
	Properties AlertRuleTemplate `json:"properties"`

	// Fields inherited from AlertRuleTemplate
	Id         *string                `json:"id,omitempty"`
	Name       *string                `json:"name,omitempty"`
	SystemData *systemdata.SystemData `json:"systemData,omitempty"`
	Type       *string                `json:"type,omitempty"`
}

func (MicrosoftSecurityIncidentCreationAlertRuleTemplate) MarshalJSON 

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

func (*MicrosoftSecurityIncidentCreationAlertRuleTemplate) UnmarshalJSON 

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

type NrtAlertRuleTemplate 

type NrtAlertRuleTemplate struct {
	Properties AlertRuleTemplate `json:"properties"`

	// Fields inherited from AlertRuleTemplate
	Id         *string                `json:"id,omitempty"`
	Name       *string                `json:"name,omitempty"`
	SystemData *systemdata.SystemData `json:"systemData,omitempty"`
	Type       *string                `json:"type,omitempty"`
}

func (NrtAlertRuleTemplate) MarshalJSON 

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

func (*NrtAlertRuleTemplate) UnmarshalJSON 

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

type ScheduledAlertRuleTemplate 

type ScheduledAlertRuleTemplate struct {
	Properties *ScheduledAlertRuleTemplateProperties `json:"properties,omitempty"`

	// Fields inherited from AlertRuleTemplate
	Id         *string                `json:"id,omitempty"`
	Name       *string                `json:"name,omitempty"`
	SystemData *systemdata.SystemData `json:"systemData,omitempty"`
	Type       *string                `json:"type,omitempty"`
}

func (ScheduledAlertRuleTemplate) MarshalJSON 

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

type ScheduledAlertRuleTemplateProperties 

type ScheduledAlertRuleTemplateProperties struct {
	Tactics *[]AttackTactic `json:"tactics,omitempty"`
}

type ThreatIntelligenceAlertRuleTemplate 

type ThreatIntelligenceAlertRuleTemplate struct {
	Properties *ThreatIntelligenceAlertRuleTemplateProperties `json:"properties,omitempty"`

	// Fields inherited from AlertRuleTemplate
	Id         *string                `json:"id,omitempty"`
	Name       *string                `json:"name,omitempty"`
	SystemData *systemdata.SystemData `json:"systemData,omitempty"`
	Type       *string                `json:"type,omitempty"`
}

func (ThreatIntelligenceAlertRuleTemplate) MarshalJSON 

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

type ThreatIntelligenceAlertRuleTemplateProperties 

type ThreatIntelligenceAlertRuleTemplateProperties struct {
	Severity AlertSeverity   `json:"severity"`
	Tactics  *[]AttackTactic `json:"tactics,omitempty"`
}

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) 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

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.