HuntingBookmark interface

Package:

@azure/arm-securityinsight

Represents a Hunting bookmark entity.

Extends

Entity

Properties

additionalData	A bag of custom fields that should be part of the entity and will be presented to the user. NOTE: This property will not be serialized. It can only be populated by the server.
created	The time the bookmark was created
createdBy	Describes a user that created the bookmark
displayName	The display name of the bookmark
eventTime	The time of the event
friendlyName	The graph item display name which is a short humanly readable description of the graph item instance. This property is optional and might be system generated. NOTE: This property will not be serialized. It can only be populated by the server.
incidentInfo	Describes an incident that relates to bookmark
kind	Polymorphic discriminator, which specifies the different types this object can be
labels	List of labels relevant to this bookmark
notes	The notes of the bookmark
query	The query of the bookmark.
queryResult	The query result of the bookmark.
updated	The last time the bookmark was updated
updatedBy	Describes a user that updated the bookmark

Inherited Properties

id	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.
name	The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.
type	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

additionalData

A bag of custom fields that should be part of the entity and will be presented to the user. NOTE: This property will not be serialized. It can only be populated by the server.

additionalData?: {[propertyName: string]: Record<string, unknown>}

Property Value

{[propertyName: string]: Record<string, unknown>}

created

The time the bookmark was created

created?: Date

Property Value

Date

createdBy

Describes a user that created the bookmark

createdBy?: UserInfo

Property Value

UserInfo

displayName

The display name of the bookmark

displayName?: string

Property Value

string

eventTime

The time of the event

eventTime?: Date

Property Value

Date

friendlyName

The graph item display name which is a short humanly readable description of the graph item instance. This property is optional and might be system generated. NOTE: This property will not be serialized. It can only be populated by the server.

friendlyName?: string

Property Value

string

incidentInfo

Describes an incident that relates to bookmark

incidentInfo?: IncidentInfo

Property Value

IncidentInfo

kind

Polymorphic discriminator, which specifies the different types this object can be

kind: "Bookmark"

Property Value

"Bookmark"

labels

List of labels relevant to this bookmark

labels?: string[]

Property Value

string[]

notes

The notes of the bookmark

notes?: string

Property Value

string

query

The query of the bookmark.

query?: string

Property Value

string

queryResult

The query result of the bookmark.

queryResult?: string

Property Value

string

updated

The last time the bookmark was updated

updated?: Date

Property Value

Date

updatedBy

Describes a user that updated the bookmark

updatedBy?: UserInfo

Property Value

UserInfo

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From Entity.id

name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From Entity.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

SystemData

Inherited From Entity.systemData

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From Entity.type