watchlistitems

package
v0.20241126.2320 Latest Latest
Warning

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

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

README

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

The watchlistitems SDK allows for interaction with Azure Resource Manager 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/watchlistitems"

Client Initialization

client := watchlistitems.NewWatchlistItemsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: WatchlistItemsClient.CreateOrUpdate

ctx := context.TODO()
id := watchlistitems.NewWatchlistItemID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceName", "watchlistAlias", "watchlistItemId")

payload := watchlistitems.WatchlistItem{
	// ...
}


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: WatchlistItemsClient.Delete

ctx := context.TODO()
id := watchlistitems.NewWatchlistItemID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceName", "watchlistAlias", "watchlistItemId")

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: WatchlistItemsClient.Get

ctx := context.TODO()
id := watchlistitems.NewWatchlistItemID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceName", "watchlistAlias", "watchlistItemId")

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: WatchlistItemsClient.List

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

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

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

ValidateWatchlistID checks that 'input' can be parsed as a Watchlist ID

func ValidateWatchlistItemID 

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

ValidateWatchlistItemID checks that 'input' can be parsed as a Watchlist Item ID

Types

type CreateOrUpdateOperationResponse 

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

type DeleteOperationResponse 

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

type GetOperationResponse 

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

type ListCompleteResult 

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

type ListCustomPager 

type ListCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *ListCustomPager) NextPageLink() *odata.Link

type ListOperationResponse 

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

type UserInfo 

type UserInfo struct {
	Email    *string `json:"email,omitempty"`
	Name     *string `json:"name,omitempty"`
	ObjectId *string `json:"objectId,omitempty"`
}

type WatchlistId 

type WatchlistId struct {
	SubscriptionId    string
	ResourceGroupName string
	WorkspaceName     string
	WatchlistAlias    string
}

WatchlistId is a struct representing the Resource ID for a Watchlist

func NewWatchlistID 

func NewWatchlistID(subscriptionId string, resourceGroupName string, workspaceName string, watchlistAlias string) WatchlistId

NewWatchlistID returns a new WatchlistId struct

func ParseWatchlistID 

func ParseWatchlistID(input string) (*WatchlistId, error)

ParseWatchlistID parses 'input' into a WatchlistId

func ParseWatchlistIDInsensitively 

func ParseWatchlistIDInsensitively(input string) (*WatchlistId, error)

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

func (*WatchlistId) FromParseResult 

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

func (WatchlistId) ID 

func (id WatchlistId) ID() string

ID returns the formatted Watchlist ID

func (WatchlistId) Segments 

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

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

func (WatchlistId) String 

func (id WatchlistId) String() string

String returns a human-readable description of this Watchlist ID

type WatchlistItem 

type WatchlistItem struct {
	Etag       *string                  `json:"etag,omitempty"`
	Id         *string                  `json:"id,omitempty"`
	Name       *string                  `json:"name,omitempty"`
	Properties *WatchlistItemProperties `json:"properties,omitempty"`
	SystemData *systemdata.SystemData   `json:"systemData,omitempty"`
	Type       *string                  `json:"type,omitempty"`
}

type WatchlistItemId 

type WatchlistItemId struct {
	SubscriptionId    string
	ResourceGroupName string
	WorkspaceName     string
	WatchlistAlias    string
	WatchlistItemId   string
}

WatchlistItemId is a struct representing the Resource ID for a Watchlist Item

func NewWatchlistItemID 

func NewWatchlistItemID(subscriptionId string, resourceGroupName string, workspaceName string, watchlistAlias string, watchlistItemId string) WatchlistItemId

NewWatchlistItemID returns a new WatchlistItemId struct

func ParseWatchlistItemID 

func ParseWatchlistItemID(input string) (*WatchlistItemId, error)

ParseWatchlistItemID parses 'input' into a WatchlistItemId

func ParseWatchlistItemIDInsensitively 

func ParseWatchlistItemIDInsensitively(input string) (*WatchlistItemId, error)

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

func (*WatchlistItemId) FromParseResult 

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

func (WatchlistItemId) ID 

func (id WatchlistItemId) ID() string

ID returns the formatted Watchlist Item ID

func (WatchlistItemId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Watchlist Item ID

func (WatchlistItemId) String 

func (id WatchlistItemId) String() string

String returns a human-readable description of this Watchlist Item ID

type WatchlistItemOperationPredicate 

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

func (WatchlistItemOperationPredicate) Matches 

func (p WatchlistItemOperationPredicate) Matches(input WatchlistItem) bool

type WatchlistItemProperties 

type WatchlistItemProperties struct {
	Created           *string      `json:"created,omitempty"`
	CreatedBy         *UserInfo    `json:"createdBy,omitempty"`
	EntityMapping     *interface{} `json:"entityMapping,omitempty"`
	IsDeleted         *bool        `json:"isDeleted,omitempty"`
	ItemsKeyValue     interface{}  `json:"itemsKeyValue"`
	TenantId          *string      `json:"tenantId,omitempty"`
	Updated           *string      `json:"updated,omitempty"`
	UpdatedBy         *UserInfo    `json:"updatedBy,omitempty"`
	WatchlistItemId   *string      `json:"watchlistItemId,omitempty"`
	WatchlistItemType *string      `json:"watchlistItemType,omitempty"`
}

func (*WatchlistItemProperties) GetCreatedAsTime 

func (o *WatchlistItemProperties) GetCreatedAsTime() (*time.Time, error)

func (*WatchlistItemProperties) GetUpdatedAsTime 

func (o *WatchlistItemProperties) GetUpdatedAsTime() (*time.Time, error)

func (*WatchlistItemProperties) SetCreatedAsTime 

func (o *WatchlistItemProperties) SetCreatedAsTime(input time.Time)

func (*WatchlistItemProperties) SetUpdatedAsTime 

func (o *WatchlistItemProperties) SetUpdatedAsTime(input time.Time)

type WatchlistItemsClient 

type WatchlistItemsClient struct {
	Client *resourcemanager.Client
}

func NewWatchlistItemsClientWithBaseURI 

func NewWatchlistItemsClientWithBaseURI(sdkApi sdkEnv.Api) (*WatchlistItemsClient, error)

func (WatchlistItemsClient) CreateOrUpdate 

func (c WatchlistItemsClient) CreateOrUpdate(ctx context.Context, id WatchlistItemId, input WatchlistItem) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (WatchlistItemsClient) Delete 

func (c WatchlistItemsClient) Delete(ctx context.Context, id WatchlistItemId) (result DeleteOperationResponse, err error)

Delete ...

func (WatchlistItemsClient) Get 

func (c WatchlistItemsClient) Get(ctx context.Context, id WatchlistItemId) (result GetOperationResponse, err error)

Get ...

func (WatchlistItemsClient) List 

func (c WatchlistItemsClient) List(ctx context.Context, id WatchlistId) (result ListOperationResponse, err error)

List ...

func (WatchlistItemsClient) ListComplete 

func (c WatchlistItemsClient) ListComplete(ctx context.Context, id WatchlistId) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (WatchlistItemsClient) ListCompleteMatchingPredicate 

func (c WatchlistItemsClient) ListCompleteMatchingPredicate(ctx context.Context, id WatchlistId, predicate WatchlistItemOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

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.