settings

package
v0.20230726.1190715 Latest Latest
Warning

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

Go to latest
Published: Jul 26, 2023 License: MPL-2.0 Imports: 9 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/securityinsights/2022-10-01-preview/settings Documentation

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

Client Initialization

client := settings.NewSettingsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: SettingsClient.ProductSettingsDelete

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

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

Example Usage: SettingsClient.ProductSettingsGet

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

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

Example Usage: SettingsClient.ProductSettingsList

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

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

Example Usage: SettingsClient.ProductSettingsUpdate

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

payload := settings.Settings{
	// ...
}


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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForEntityProviders

func PossibleValuesForEntityProviders() []string

func PossibleValuesForSettingKind

func PossibleValuesForSettingKind() []string

func PossibleValuesForUebaDataSources

func PossibleValuesForUebaDataSources() []string

func ValidateSettingID

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

ValidateSettingID checks that 'input' can be parsed as a 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 Anomalies

type Anomalies struct {
	Properties *AnomaliesSettingsProperties `json:"properties,omitempty"`

	// Fields inherited from Settings
	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 (Anomalies) MarshalJSON

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

type AnomaliesSettingsProperties

type AnomaliesSettingsProperties struct {
	IsEnabled *bool `json:"isEnabled,omitempty"`
}

type EntityAnalytics

type EntityAnalytics struct {
	Properties *EntityAnalyticsProperties `json:"properties,omitempty"`

	// Fields inherited from Settings
	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 (EntityAnalytics) MarshalJSON

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

type EntityAnalyticsProperties

type EntityAnalyticsProperties struct {
	EntityProviders *[]EntityProviders `json:"entityProviders,omitempty"`
}

type EntityProviders

type EntityProviders string
const (
	EntityProvidersActiveDirectory      EntityProviders = "ActiveDirectory"
	EntityProvidersAzureActiveDirectory EntityProviders = "AzureActiveDirectory"
)

type EyesOn

type EyesOn struct {
	Properties *EyesOnSettingsProperties `json:"properties,omitempty"`

	// Fields inherited from Settings
	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 (EyesOn) MarshalJSON

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

type EyesOnSettingsProperties

type EyesOnSettingsProperties struct {
	IsEnabled *bool `json:"isEnabled,omitempty"`
}

type ProductSettingsDeleteOperationResponse

type ProductSettingsDeleteOperationResponse struct {
	HttpResponse *http.Response
}

type ProductSettingsGetOperationResponse

type ProductSettingsGetOperationResponse struct {
	HttpResponse *http.Response
	Model        *Settings
}

type ProductSettingsListOperationResponse

type ProductSettingsListOperationResponse struct {
	HttpResponse *http.Response
	Model        *SettingList
}

type ProductSettingsUpdateOperationResponse

type ProductSettingsUpdateOperationResponse struct {
	HttpResponse *http.Response
	Model        *Settings
}

type SettingId

type SettingId struct {
	SubscriptionId    string
	ResourceGroupName string
	WorkspaceName     string
	SettingName       string
}

SettingId is a struct representing the Resource ID for a Setting

func NewSettingID

func NewSettingID(subscriptionId string, resourceGroupName string, workspaceName string, settingName string) SettingId

NewSettingID returns a new SettingId struct

func ParseSettingID

func ParseSettingID(input string) (*SettingId, error)

ParseSettingID parses 'input' into a SettingId

func ParseSettingIDInsensitively

func ParseSettingIDInsensitively(input string) (*SettingId, error)

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

func (SettingId) ID

func (id SettingId) ID() string

ID returns the formatted Setting ID

func (SettingId) Segments

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

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

func (SettingId) String

func (id SettingId) String() string

String returns a human-readable description of this Setting ID

type SettingKind

type SettingKind string
const (
	SettingKindAnomalies       SettingKind = "Anomalies"
	SettingKindEntityAnalytics SettingKind = "EntityAnalytics"
	SettingKindEyesOn          SettingKind = "EyesOn"
	SettingKindUeba            SettingKind = "Ueba"
)

type SettingList

type SettingList struct {
	Value []Settings `json:"value"`
}

func (*SettingList) UnmarshalJSON

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

type Settings

type Settings interface {
}

type SettingsClient

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

func NewSettingsClientWithBaseURI

func NewSettingsClientWithBaseURI(endpoint string) SettingsClient

func (SettingsClient) ProductSettingsDelete

func (c SettingsClient) ProductSettingsDelete(ctx context.Context, id SettingId) (result ProductSettingsDeleteOperationResponse, err error)

ProductSettingsDelete ...

func (SettingsClient) ProductSettingsGet

func (c SettingsClient) ProductSettingsGet(ctx context.Context, id SettingId) (result ProductSettingsGetOperationResponse, err error)

ProductSettingsGet ...

func (SettingsClient) ProductSettingsList

func (c SettingsClient) ProductSettingsList(ctx context.Context, id WorkspaceId) (result ProductSettingsListOperationResponse, err error)

ProductSettingsList ...

func (SettingsClient) ProductSettingsUpdate

func (c SettingsClient) ProductSettingsUpdate(ctx context.Context, id SettingId, input Settings) (result ProductSettingsUpdateOperationResponse, err error)

ProductSettingsUpdate ...

type Ueba

type Ueba struct {
	Properties *UebaProperties `json:"properties,omitempty"`

	// Fields inherited from Settings
	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 (Ueba) MarshalJSON

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

type UebaDataSources

type UebaDataSources string
const (
	UebaDataSourcesAuditLogs     UebaDataSources = "AuditLogs"
	UebaDataSourcesAzureActivity UebaDataSources = "AzureActivity"
	UebaDataSourcesSecurityEvent UebaDataSources = "SecurityEvent"
	UebaDataSourcesSigninLogs    UebaDataSources = "SigninLogs"
)

type UebaProperties

type UebaProperties struct {
	DataSources *[]UebaDataSources `json:"dataSources,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

Jump to

Keyboard shortcuts

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