README ¶
github.com/hashicorp/go-azure-sdk/resource-manager/securityinsights/2021-09-01-preview/bookmark
Documentation
The bookmark
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/bookmark"
Client Initialization
client := bookmark.NewBookmarkClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer
Example Usage: BookmarkClient.Expand
ctx := context.TODO()
id := bookmark.NewBookmarkID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "bookmarkIdValue")
payload := bookmark.BookmarkExpandParameters{
// ...
}
read, err := client.Expand(ctx, id, payload)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Documentation ¶
Index ¶
- func PossibleValuesForEntityKind() []string
- func ValidateBookmarkID(input interface{}, key string) (warnings []string, errors []error)
- type BookmarkClient
- type BookmarkExpandParameters
- type BookmarkExpandResponse
- type BookmarkExpandResponseValue
- type BookmarkId
- type ConnectedEntity
- type Entity
- type EntityKind
- type ExpandOperationResponse
- type ExpansionResultAggregation
- type ExpansionResultsMetadata
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func PossibleValuesForEntityKind ¶
func PossibleValuesForEntityKind() []string
func ValidateBookmarkID ¶
ValidateBookmarkID checks that 'input' can be parsed as a Bookmark ID
Types ¶
type BookmarkClient ¶
func NewBookmarkClientWithBaseURI ¶
func NewBookmarkClientWithBaseURI(endpoint string) BookmarkClient
func (BookmarkClient) Expand ¶
func (c BookmarkClient) Expand(ctx context.Context, id BookmarkId, input BookmarkExpandParameters) (result ExpandOperationResponse, err error)
Expand ...
type BookmarkExpandParameters ¶
type BookmarkExpandParameters struct { EndTime *string `json:"endTime,omitempty"` ExpansionId *string `json:"expansionId,omitempty"` StartTime *string `json:"startTime,omitempty"` }
func (*BookmarkExpandParameters) GetEndTimeAsTime ¶
func (o *BookmarkExpandParameters) GetEndTimeAsTime() (*time.Time, error)
func (*BookmarkExpandParameters) GetStartTimeAsTime ¶
func (o *BookmarkExpandParameters) GetStartTimeAsTime() (*time.Time, error)
func (*BookmarkExpandParameters) SetEndTimeAsTime ¶
func (o *BookmarkExpandParameters) SetEndTimeAsTime(input time.Time)
func (*BookmarkExpandParameters) SetStartTimeAsTime ¶
func (o *BookmarkExpandParameters) SetStartTimeAsTime(input time.Time)
type BookmarkExpandResponse ¶
type BookmarkExpandResponse struct { MetaData *ExpansionResultsMetadata `json:"metaData,omitempty"` Value *BookmarkExpandResponseValue `json:"value,omitempty"` }
type BookmarkExpandResponseValue ¶
type BookmarkExpandResponseValue struct { Edges *[]ConnectedEntity `json:"edges,omitempty"` Entities *[]Entity `json:"entities,omitempty"` }
type BookmarkId ¶
type BookmarkId struct { SubscriptionId string ResourceGroupName string WorkspaceName string BookmarkId string }
BookmarkId is a struct representing the Resource ID for a Bookmark
func NewBookmarkID ¶
func NewBookmarkID(subscriptionId string, resourceGroupName string, workspaceName string, bookmarkId string) BookmarkId
NewBookmarkID returns a new BookmarkId struct
func ParseBookmarkID ¶
func ParseBookmarkID(input string) (*BookmarkId, error)
ParseBookmarkID parses 'input' into a BookmarkId
func ParseBookmarkIDInsensitively ¶
func ParseBookmarkIDInsensitively(input string) (*BookmarkId, error)
ParseBookmarkIDInsensitively parses 'input' case-insensitively into a BookmarkId note: this method should only be used for API response data and not user input
func (BookmarkId) Segments ¶
func (id BookmarkId) Segments() []resourceids.Segment
Segments returns a slice of Resource ID Segments which comprise this Bookmark ID
func (BookmarkId) String ¶
func (id BookmarkId) String() string
String returns a human-readable description of this Bookmark ID
type ConnectedEntity ¶
type ConnectedEntity struct { AdditionalData *interface{} `json:"additionalData,omitempty"` TargetEntityId *string `json:"targetEntityId,omitempty"` }
type Entity ¶
type Entity struct { Id *string `json:"id,omitempty"` Kind EntityKind `json:"kind"` Name *string `json:"name,omitempty"` SystemData *systemdata.SystemData `json:"systemData,omitempty"` Type *string `json:"type,omitempty"` }
type EntityKind ¶
type EntityKind string
const ( EntityKindAccount EntityKind = "Account" EntityKindAzureResource EntityKind = "AzureResource" EntityKindBookmark EntityKind = "Bookmark" EntityKindCloudApplication EntityKind = "CloudApplication" EntityKindDnsResolution EntityKind = "DnsResolution" EntityKindFile EntityKind = "File" EntityKindFileHash EntityKind = "FileHash" EntityKindHost EntityKind = "Host" EntityKindIP EntityKind = "Ip" EntityKindIoTDevice EntityKind = "IoTDevice" EntityKindMailCluster EntityKind = "MailCluster" EntityKindMailMessage EntityKind = "MailMessage" EntityKindMailbox EntityKind = "Mailbox" EntityKindMalware EntityKind = "Malware" EntityKindProcess EntityKind = "Process" EntityKindRegistryKey EntityKind = "RegistryKey" EntityKindRegistryValue EntityKind = "RegistryValue" EntityKindSecurityAlert EntityKind = "SecurityAlert" EntityKindSecurityGroup EntityKind = "SecurityGroup" EntityKindSubmissionMail EntityKind = "SubmissionMail" EntityKindUrl EntityKind = "Url" )
type ExpandOperationResponse ¶
type ExpandOperationResponse struct { HttpResponse *http.Response Model *BookmarkExpandResponse }
type ExpansionResultAggregation ¶
type ExpansionResultAggregation struct { AggregationType *string `json:"aggregationType,omitempty"` Count int64 `json:"count"` DisplayName *string `json:"displayName,omitempty"` EntityKind EntityKind `json:"entityKind"` }
type ExpansionResultsMetadata ¶
type ExpansionResultsMetadata struct {
Aggregations *[]ExpansionResultAggregation `json:"aggregations,omitempty"`
}