entityqueries

package
v0.20240320.1000025 Latest Latest
Warning

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

Go to latest
Published: Mar 20, 2024 License: MPL-2.0 Imports: 13 Imported by: 0

README

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

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

Client Initialization

client := entityqueries.NewEntityQueriesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: EntityQueriesClient.CreateOrUpdate

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

payload := entityqueries.CustomEntityQuery{
	// ...
}


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

Example Usage: EntityQueriesClient.Delete

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

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

Example Usage: EntityQueriesClient.EntityQueryTemplatesGet

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

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

Example Usage: EntityQueriesClient.EntityQueryTemplatesList

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

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

Example Usage: EntityQueriesClient.Get

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

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
}

Example Usage: EntityQueriesClient.List

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

// alternatively `client.List(ctx, id, entityqueries.DefaultListOperationOptions())` can be used to do batched pagination
items, err := client.ListComplete(ctx, id, entityqueries.DefaultListOperationOptions())
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 PossibleValuesForCustomEntityQueryKind

func PossibleValuesForCustomEntityQueryKind() []string

func PossibleValuesForEntityQueryKind

func PossibleValuesForEntityQueryKind() []string

func PossibleValuesForEntityQueryTemplateKind

func PossibleValuesForEntityQueryTemplateKind() []string

func PossibleValuesForEntityType

func PossibleValuesForEntityType() []string

func PossibleValuesForKind

func PossibleValuesForKind() []string

func ValidateEntityQueryID

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

ValidateEntityQueryID checks that 'input' can be parsed as a Entity Query ID

func ValidateEntityQueryTemplateID

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

ValidateEntityQueryTemplateID checks that 'input' can be parsed as a Entity Query 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 ActivityCustomEntityQuery

type ActivityCustomEntityQuery struct {
	Properties *ActivityEntityQueriesProperties `json:"properties,omitempty"`

	// Fields inherited from CustomEntityQuery
	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 (ActivityCustomEntityQuery) MarshalJSON

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

type ActivityEntityQueriesProperties

type ActivityEntityQueriesProperties struct {
	Content                 *string                                          `json:"content,omitempty"`
	CreatedTimeUtc          *string                                          `json:"createdTimeUtc,omitempty"`
	Description             *string                                          `json:"description,omitempty"`
	Enabled                 *bool                                            `json:"enabled,omitempty"`
	EntitiesFilter          *map[string][]string                             `json:"entitiesFilter,omitempty"`
	InputEntityType         *EntityType                                      `json:"inputEntityType,omitempty"`
	LastModifiedTimeUtc     *string                                          `json:"lastModifiedTimeUtc,omitempty"`
	QueryDefinitions        *ActivityEntityQueriesPropertiesQueryDefinitions `json:"queryDefinitions,omitempty"`
	RequiredInputFieldsSets *[][]string                                      `json:"requiredInputFieldsSets,omitempty"`
	TemplateName            *string                                          `json:"templateName,omitempty"`
	Title                   *string                                          `json:"title,omitempty"`
}

func (*ActivityEntityQueriesProperties) GetCreatedTimeUtcAsTime

func (o *ActivityEntityQueriesProperties) GetCreatedTimeUtcAsTime() (*time.Time, error)

func (*ActivityEntityQueriesProperties) GetLastModifiedTimeUtcAsTime

func (o *ActivityEntityQueriesProperties) GetLastModifiedTimeUtcAsTime() (*time.Time, error)

func (*ActivityEntityQueriesProperties) SetCreatedTimeUtcAsTime

func (o *ActivityEntityQueriesProperties) SetCreatedTimeUtcAsTime(input time.Time)

func (*ActivityEntityQueriesProperties) SetLastModifiedTimeUtcAsTime

func (o *ActivityEntityQueriesProperties) SetLastModifiedTimeUtcAsTime(input time.Time)

type ActivityEntityQueriesPropertiesQueryDefinitions

type ActivityEntityQueriesPropertiesQueryDefinitions struct {
	Query *string `json:"query,omitempty"`
}

type ActivityEntityQuery

type ActivityEntityQuery struct {
	Properties *ActivityEntityQueriesProperties `json:"properties,omitempty"`

	// Fields inherited from EntityQuery
	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 (ActivityEntityQuery) MarshalJSON

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

type ActivityEntityQueryTemplate

type ActivityEntityQueryTemplate struct {
	Properties *ActivityEntityQueryTemplateProperties `json:"properties,omitempty"`

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

func (ActivityEntityQueryTemplate) MarshalJSON

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

type ActivityEntityQueryTemplateProperties

type ActivityEntityQueryTemplateProperties struct {
	Content                 *string                                                `json:"content,omitempty"`
	DataTypes               *[]DataTypeDefinitions                                 `json:"dataTypes,omitempty"`
	Description             *string                                                `json:"description,omitempty"`
	EntitiesFilter          *map[string][]string                                   `json:"entitiesFilter,omitempty"`
	InputEntityType         *EntityType                                            `json:"inputEntityType,omitempty"`
	QueryDefinitions        *ActivityEntityQueryTemplatePropertiesQueryDefinitions `json:"queryDefinitions,omitempty"`
	RequiredInputFieldsSets *[][]string                                            `json:"requiredInputFieldsSets,omitempty"`
	Title                   *string                                                `json:"title,omitempty"`
}

type ActivityEntityQueryTemplatePropertiesQueryDefinitions

type ActivityEntityQueryTemplatePropertiesQueryDefinitions struct {
	Query       *string `json:"query,omitempty"`
	SummarizeBy *string `json:"summarizeBy,omitempty"`
}

type CreateOrUpdateOperationResponse

type CreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *EntityQuery
}

type CustomEntityQuery

type CustomEntityQuery interface {
}

type CustomEntityQueryKind

type CustomEntityQueryKind string
const (
	CustomEntityQueryKindActivity CustomEntityQueryKind = "Activity"
)

func (*CustomEntityQueryKind) UnmarshalJSON added in v0.20240221.1115631

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

type DataTypeDefinitions

type DataTypeDefinitions struct {
	DataType *string `json:"dataType,omitempty"`
}

type DeleteOperationResponse

type DeleteOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
}

type EntityQueriesClient

type EntityQueriesClient struct {
	Client *resourcemanager.Client
}

func NewEntityQueriesClientWithBaseURI

func NewEntityQueriesClientWithBaseURI(sdkApi sdkEnv.Api) (*EntityQueriesClient, error)

func (EntityQueriesClient) CreateOrUpdate

CreateOrUpdate ...

func (EntityQueriesClient) Delete

Delete ...

func (EntityQueriesClient) EntityQueryTemplatesGet

EntityQueryTemplatesGet ...

func (EntityQueriesClient) EntityQueryTemplatesList

EntityQueryTemplatesList ...

func (EntityQueriesClient) EntityQueryTemplatesListComplete

EntityQueryTemplatesListComplete retrieves all the results into a single object

func (EntityQueriesClient) EntityQueryTemplatesListCompleteMatchingPredicate

func (c EntityQueriesClient) EntityQueryTemplatesListCompleteMatchingPredicate(ctx context.Context, id WorkspaceId, options EntityQueryTemplatesListOperationOptions, predicate EntityQueryTemplateOperationPredicate) (result EntityQueryTemplatesListCompleteResult, err error)

EntityQueryTemplatesListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (EntityQueriesClient) Get

Get ...

func (EntityQueriesClient) List

List ...

func (EntityQueriesClient) ListComplete

ListComplete retrieves all the results into a single object

func (EntityQueriesClient) ListCompleteMatchingPredicate

func (c EntityQueriesClient) ListCompleteMatchingPredicate(ctx context.Context, id WorkspaceId, options ListOperationOptions, predicate EntityQueryOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type EntityQuery

type EntityQuery interface {
}

type EntityQueryId

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

EntityQueryId is a struct representing the Resource ID for a Entity Query

func NewEntityQueryID

func NewEntityQueryID(subscriptionId string, resourceGroupName string, workspaceName string, entityQueryId string) EntityQueryId

NewEntityQueryID returns a new EntityQueryId struct

func ParseEntityQueryID

func ParseEntityQueryID(input string) (*EntityQueryId, error)

ParseEntityQueryID parses 'input' into a EntityQueryId

func ParseEntityQueryIDInsensitively

func ParseEntityQueryIDInsensitively(input string) (*EntityQueryId, error)

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

func (*EntityQueryId) FromParseResult

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

func (EntityQueryId) ID

func (id EntityQueryId) ID() string

ID returns the formatted Entity Query ID

func (EntityQueryId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Entity Query ID

func (EntityQueryId) String

func (id EntityQueryId) String() string

String returns a human-readable description of this Entity Query ID

type EntityQueryKind

type EntityQueryKind string
const (
	EntityQueryKindActivity  EntityQueryKind = "Activity"
	EntityQueryKindExpansion EntityQueryKind = "Expansion"
	EntityQueryKindInsight   EntityQueryKind = "Insight"
)

func (*EntityQueryKind) UnmarshalJSON added in v0.20240221.1115631

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

type EntityQueryOperationPredicate

type EntityQueryOperationPredicate struct {
}

func (EntityQueryOperationPredicate) Matches

type EntityQueryTemplate

type EntityQueryTemplate interface {
}

type EntityQueryTemplateId

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

EntityQueryTemplateId is a struct representing the Resource ID for a Entity Query Template

func NewEntityQueryTemplateID

func NewEntityQueryTemplateID(subscriptionId string, resourceGroupName string, workspaceName string, entityQueryTemplateId string) EntityQueryTemplateId

NewEntityQueryTemplateID returns a new EntityQueryTemplateId struct

func ParseEntityQueryTemplateID

func ParseEntityQueryTemplateID(input string) (*EntityQueryTemplateId, error)

ParseEntityQueryTemplateID parses 'input' into a EntityQueryTemplateId

func ParseEntityQueryTemplateIDInsensitively

func ParseEntityQueryTemplateIDInsensitively(input string) (*EntityQueryTemplateId, error)

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

func (*EntityQueryTemplateId) FromParseResult

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

func (EntityQueryTemplateId) ID

func (id EntityQueryTemplateId) ID() string

ID returns the formatted Entity Query Template ID

func (EntityQueryTemplateId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Entity Query Template ID

func (EntityQueryTemplateId) String

func (id EntityQueryTemplateId) String() string

String returns a human-readable description of this Entity Query Template ID

type EntityQueryTemplateKind

type EntityQueryTemplateKind string
const (
	EntityQueryTemplateKindActivity EntityQueryTemplateKind = "Activity"
)

func (*EntityQueryTemplateKind) UnmarshalJSON added in v0.20240221.1115631

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

type EntityQueryTemplateOperationPredicate

type EntityQueryTemplateOperationPredicate struct {
}

func (EntityQueryTemplateOperationPredicate) Matches

type EntityQueryTemplatesGetOperationResponse

type EntityQueryTemplatesGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *EntityQueryTemplate
}

type EntityQueryTemplatesListCompleteResult

type EntityQueryTemplatesListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []EntityQueryTemplate
}

type EntityQueryTemplatesListOperationOptions

type EntityQueryTemplatesListOperationOptions struct {
	Kind *Kind
}

func DefaultEntityQueryTemplatesListOperationOptions

func DefaultEntityQueryTemplatesListOperationOptions() EntityQueryTemplatesListOperationOptions

func (EntityQueryTemplatesListOperationOptions) ToHeaders added in v0.20240221.1115631

func (EntityQueryTemplatesListOperationOptions) ToOData added in v0.20240221.1115631

func (EntityQueryTemplatesListOperationOptions) ToQuery added in v0.20240221.1115631

type EntityQueryTemplatesListOperationResponse

type EntityQueryTemplatesListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]EntityQueryTemplate
}

type EntityType

type EntityType string
const (
	EntityTypeAccount          EntityType = "Account"
	EntityTypeAzureResource    EntityType = "AzureResource"
	EntityTypeCloudApplication EntityType = "CloudApplication"
	EntityTypeDNS              EntityType = "DNS"
	EntityTypeFile             EntityType = "File"
	EntityTypeFileHash         EntityType = "FileHash"
	EntityTypeHost             EntityType = "Host"
	EntityTypeHuntingBookmark  EntityType = "HuntingBookmark"
	EntityTypeIP               EntityType = "IP"
	EntityTypeIoTDevice        EntityType = "IoTDevice"
	EntityTypeMailCluster      EntityType = "MailCluster"
	EntityTypeMailMessage      EntityType = "MailMessage"
	EntityTypeMailbox          EntityType = "Mailbox"
	EntityTypeMalware          EntityType = "Malware"
	EntityTypeProcess          EntityType = "Process"
	EntityTypeRegistryKey      EntityType = "RegistryKey"
	EntityTypeRegistryValue    EntityType = "RegistryValue"
	EntityTypeSecurityAlert    EntityType = "SecurityAlert"
	EntityTypeSecurityGroup    EntityType = "SecurityGroup"
	EntityTypeSubmissionMail   EntityType = "SubmissionMail"
	EntityTypeURL              EntityType = "URL"
)

func (*EntityType) UnmarshalJSON added in v0.20240221.1115631

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

type ExpansionEntityQueriesProperties

type ExpansionEntityQueriesProperties struct {
	DataSources       *[]string     `json:"dataSources,omitempty"`
	DisplayName       *string       `json:"displayName,omitempty"`
	InputEntityType   *EntityType   `json:"inputEntityType,omitempty"`
	InputFields       *[]string     `json:"inputFields,omitempty"`
	OutputEntityTypes *[]EntityType `json:"outputEntityTypes,omitempty"`
	QueryTemplate     *string       `json:"queryTemplate,omitempty"`
}

type ExpansionEntityQuery

type ExpansionEntityQuery struct {
	Properties *ExpansionEntityQueriesProperties `json:"properties,omitempty"`

	// Fields inherited from EntityQuery
	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 (ExpansionEntityQuery) MarshalJSON

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

type GetOperationResponse

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

type Kind

type Kind string
const (
	KindActivity  Kind = "Activity"
	KindExpansion Kind = "Expansion"
)

func (*Kind) UnmarshalJSON added in v0.20240221.1115631

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

type ListCompleteResult

type ListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []EntityQuery
}

type ListOperationOptions

type ListOperationOptions struct {
	Kind *Kind
}

func DefaultListOperationOptions

func DefaultListOperationOptions() ListOperationOptions

func (ListOperationOptions) ToHeaders added in v0.20240221.1115631

func (o ListOperationOptions) ToHeaders() *client.Headers

func (ListOperationOptions) ToOData added in v0.20240221.1115631

func (o ListOperationOptions) ToOData() *odata.Query

func (ListOperationOptions) ToQuery added in v0.20240221.1115631

type ListOperationResponse

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]EntityQuery
}

type RawCustomEntityQueryImpl

type RawCustomEntityQueryImpl struct {
	Type   string
	Values map[string]interface{}
}

RawCustomEntityQueryImpl 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 RawEntityQueryImpl

type RawEntityQueryImpl struct {
	Type   string
	Values map[string]interface{}
}

RawEntityQueryImpl 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 RawEntityQueryTemplateImpl

type RawEntityQueryTemplateImpl struct {
	Type   string
	Values map[string]interface{}
}

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

Jump to

Keyboard shortcuts

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