securitymlanalyticssettings

package
v0.20230905.1084740 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/resource-manager/securityinsights/2022-11-01/securitymlanalyticssettings Documentation

The securitymlanalyticssettings SDK allows for interaction with the Azure Resource Manager Service securityinsights (API Version 2022-11-01).

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/2022-11-01/securitymlanalyticssettings"

Client Initialization

client := securitymlanalyticssettings.NewSecurityMLAnalyticsSettingsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: SecurityMLAnalyticsSettingsClient.SecurityMLAnalyticsSettingsCreateOrUpdate

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

payload := securitymlanalyticssettings.SecurityMLAnalyticsSetting{
	// ...
}


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

Example Usage: SecurityMLAnalyticsSettingsClient.SecurityMLAnalyticsSettingsDelete

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

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

Example Usage: SecurityMLAnalyticsSettingsClient.SecurityMLAnalyticsSettingsGet

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

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

Example Usage: SecurityMLAnalyticsSettingsClient.SecurityMLAnalyticsSettingsList

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

// alternatively `client.SecurityMLAnalyticsSettingsList(ctx, id)` can be used to do batched pagination
items, err := client.SecurityMLAnalyticsSettingsListComplete(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 PossibleValuesForAttackTactic

func PossibleValuesForAttackTactic() []string

func PossibleValuesForSecurityMLAnalyticsSettingsKind

func PossibleValuesForSecurityMLAnalyticsSettingsKind() []string

func PossibleValuesForSettingsStatus

func PossibleValuesForSettingsStatus() []string

func ValidateSecurityMLAnalyticsSettingID

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

ValidateSecurityMLAnalyticsSettingID checks that 'input' can be parsed as a Security M L Analytics Setting 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 AnomalySecurityMLAnalyticsSettings

type AnomalySecurityMLAnalyticsSettings struct {
	Properties *AnomalySecurityMLAnalyticsSettingsProperties `json:"properties,omitempty"`

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

func (AnomalySecurityMLAnalyticsSettings) MarshalJSON

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

type AnomalySecurityMLAnalyticsSettingsProperties

type AnomalySecurityMLAnalyticsSettingsProperties struct {
	AnomalySettingsVersion   *int64                                   `json:"anomalySettingsVersion,omitempty"`
	AnomalyVersion           string                                   `json:"anomalyVersion"`
	CustomizableObservations *interface{}                             `json:"customizableObservations,omitempty"`
	Description              *string                                  `json:"description,omitempty"`
	DisplayName              string                                   `json:"displayName"`
	Enabled                  bool                                     `json:"enabled"`
	Frequency                string                                   `json:"frequency"`
	IsDefaultSettings        bool                                     `json:"isDefaultSettings"`
	LastModifiedUtc          *string                                  `json:"lastModifiedUtc,omitempty"`
	RequiredDataConnectors   *[]SecurityMLAnalyticsSettingsDataSource `json:"requiredDataConnectors,omitempty"`
	SettingsDefinitionId     *string                                  `json:"settingsDefinitionId,omitempty"`
	SettingsStatus           SettingsStatus                           `json:"settingsStatus"`
	Tactics                  *[]AttackTactic                          `json:"tactics,omitempty"`
	Techniques               *[]string                                `json:"techniques,omitempty"`
}

func (*AnomalySecurityMLAnalyticsSettingsProperties) GetLastModifiedUtcAsTime

func (o *AnomalySecurityMLAnalyticsSettingsProperties) GetLastModifiedUtcAsTime() (*time.Time, error)

func (*AnomalySecurityMLAnalyticsSettingsProperties) SetLastModifiedUtcAsTime

func (o *AnomalySecurityMLAnalyticsSettingsProperties) SetLastModifiedUtcAsTime(input time.Time)

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"
	AttackTacticImpairProcessControl    AttackTactic = "ImpairProcessControl"
	AttackTacticInhibitResponseFunction AttackTactic = "InhibitResponseFunction"
	AttackTacticInitialAccess           AttackTactic = "InitialAccess"
	AttackTacticLateralMovement         AttackTactic = "LateralMovement"
	AttackTacticPersistence             AttackTactic = "Persistence"
	AttackTacticPreAttack               AttackTactic = "PreAttack"
	AttackTacticPrivilegeEscalation     AttackTactic = "PrivilegeEscalation"
	AttackTacticReconnaissance          AttackTactic = "Reconnaissance"
	AttackTacticResourceDevelopment     AttackTactic = "ResourceDevelopment"
)

type RawSecurityMLAnalyticsSettingImpl added in v0.20230807.1063129

type RawSecurityMLAnalyticsSettingImpl 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 SecurityMLAnalyticsSetting

type SecurityMLAnalyticsSetting interface {
}

type SecurityMLAnalyticsSettingId

type SecurityMLAnalyticsSettingId struct {
	SubscriptionId                 string
	ResourceGroupName              string
	WorkspaceName                  string
	SecurityMLAnalyticsSettingName string
}

SecurityMLAnalyticsSettingId is a struct representing the Resource ID for a Security M L Analytics Setting

func NewSecurityMLAnalyticsSettingID

func NewSecurityMLAnalyticsSettingID(subscriptionId string, resourceGroupName string, workspaceName string, securityMLAnalyticsSettingName string) SecurityMLAnalyticsSettingId

NewSecurityMLAnalyticsSettingID returns a new SecurityMLAnalyticsSettingId struct

func ParseSecurityMLAnalyticsSettingID

func ParseSecurityMLAnalyticsSettingID(input string) (*SecurityMLAnalyticsSettingId, error)

ParseSecurityMLAnalyticsSettingID parses 'input' into a SecurityMLAnalyticsSettingId

func ParseSecurityMLAnalyticsSettingIDInsensitively

func ParseSecurityMLAnalyticsSettingIDInsensitively(input string) (*SecurityMLAnalyticsSettingId, error)

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

func (SecurityMLAnalyticsSettingId) ID

ID returns the formatted Security M L Analytics Setting ID

func (SecurityMLAnalyticsSettingId) Segments

Segments returns a slice of Resource ID Segments which comprise this Security M L Analytics Setting ID

func (SecurityMLAnalyticsSettingId) String

String returns a human-readable description of this Security M L Analytics Setting ID

type SecurityMLAnalyticsSettingOperationPredicate

type SecurityMLAnalyticsSettingOperationPredicate struct {
}

func (SecurityMLAnalyticsSettingOperationPredicate) Matches

type SecurityMLAnalyticsSettingsClient

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

func NewSecurityMLAnalyticsSettingsClientWithBaseURI

func NewSecurityMLAnalyticsSettingsClientWithBaseURI(endpoint string) SecurityMLAnalyticsSettingsClient

func (SecurityMLAnalyticsSettingsClient) SecurityMLAnalyticsSettingsCreateOrUpdate

SecurityMLAnalyticsSettingsCreateOrUpdate ...

func (SecurityMLAnalyticsSettingsClient) SecurityMLAnalyticsSettingsDelete

SecurityMLAnalyticsSettingsDelete ...

func (SecurityMLAnalyticsSettingsClient) SecurityMLAnalyticsSettingsGet

SecurityMLAnalyticsSettingsGet ...

func (SecurityMLAnalyticsSettingsClient) SecurityMLAnalyticsSettingsList

SecurityMLAnalyticsSettingsList ...

func (SecurityMLAnalyticsSettingsClient) SecurityMLAnalyticsSettingsListComplete

SecurityMLAnalyticsSettingsListComplete retrieves all of the results into a single object

func (SecurityMLAnalyticsSettingsClient) SecurityMLAnalyticsSettingsListCompleteMatchingPredicate

func (c SecurityMLAnalyticsSettingsClient) SecurityMLAnalyticsSettingsListCompleteMatchingPredicate(ctx context.Context, id WorkspaceId, predicate SecurityMLAnalyticsSettingOperationPredicate) (resp SecurityMLAnalyticsSettingsListCompleteResult, err error)

SecurityMLAnalyticsSettingsListCompleteMatchingPredicate retrieves all of the results and then applied the predicate

type SecurityMLAnalyticsSettingsCreateOrUpdateOperationResponse

type SecurityMLAnalyticsSettingsCreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	Model        *SecurityMLAnalyticsSetting
}

type SecurityMLAnalyticsSettingsDataSource

type SecurityMLAnalyticsSettingsDataSource struct {
	ConnectorId *string   `json:"connectorId,omitempty"`
	DataTypes   *[]string `json:"dataTypes,omitempty"`
}

type SecurityMLAnalyticsSettingsDeleteOperationResponse

type SecurityMLAnalyticsSettingsDeleteOperationResponse struct {
	HttpResponse *http.Response
}

type SecurityMLAnalyticsSettingsGetOperationResponse

type SecurityMLAnalyticsSettingsGetOperationResponse struct {
	HttpResponse *http.Response
	Model        *SecurityMLAnalyticsSetting
}

type SecurityMLAnalyticsSettingsKind

type SecurityMLAnalyticsSettingsKind string
const (
	SecurityMLAnalyticsSettingsKindAnomaly SecurityMLAnalyticsSettingsKind = "Anomaly"
)

type SecurityMLAnalyticsSettingsListCompleteResult

type SecurityMLAnalyticsSettingsListCompleteResult struct {
	Items []SecurityMLAnalyticsSetting
}

type SecurityMLAnalyticsSettingsListOperationResponse

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

func (SecurityMLAnalyticsSettingsListOperationResponse) HasMore

func (SecurityMLAnalyticsSettingsListOperationResponse) LoadMore

type SettingsStatus

type SettingsStatus string
const (
	SettingsStatusFlighting  SettingsStatus = "Flighting"
	SettingsStatusProduction SettingsStatus = "Production"
)

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL