WatchlistProperties interface

Package:

@azure/arm-securityinsight

Describes watchlist properties

Properties

contentType	The content type of the raw content. Example : text/csv or text/tsv
created	The time the watchlist was created
createdBy	Describes a user that created the watchlist
defaultDuration	The default duration of a watchlist (in ISO 8601 duration format)
description	A description of the watchlist
displayName	The display name of the watchlist
isDeleted	A flag that indicates if the watchlist is deleted or not
itemsSearchKey	The search key is used to optimize query performance when using watchlists for joins with other data. For example, enable a column with IP addresses to be the designated SearchKey field, then use this field as the key field when joining to other event data by IP address.
labels	List of labels relevant to this watchlist
numberOfLinesToSkip	The number of lines in a csv/tsv content to skip before the header
provider	The provider of the watchlist
provisioningState	Describes provisioning state
rawContent	The raw content that represents to watchlist items to create. In case of csv/tsv content type, it's the content of the file that will parsed by the endpoint
source	The filename of the watchlist, called 'source'
sourceType	The sourceType of the watchlist
tenantId	The tenantId where the watchlist belongs to
updated	The last time the watchlist was updated
updatedBy	Describes a user that updated the watchlist
uploadStatus	The status of the Watchlist upload : New, InProgress or Complete. Note : When a Watchlist upload status is InProgress, the Watchlist cannot be deleted
watchlistAlias	The alias of the watchlist
watchlistId	The id (a Guid) of the watchlist
watchlistType	The type of the watchlist

Property Details

contentType

The content type of the raw content. Example : text/csv or text/tsv

contentType?: string

Property Value

string

created

The time the watchlist was created

created?: Date

Property Value

Date

createdBy

Describes a user that created the watchlist

createdBy?: UserInfo

Property Value

UserInfo

defaultDuration

The default duration of a watchlist (in ISO 8601 duration format)

defaultDuration?: string

Property Value

string

description

A description of the watchlist

description?: string

Property Value

string

displayName

The display name of the watchlist

displayName: string

Property Value

string

isDeleted

A flag that indicates if the watchlist is deleted or not

isDeleted?: boolean

Property Value

boolean

itemsSearchKey

The search key is used to optimize query performance when using watchlists for joins with other data. For example, enable a column with IP addresses to be the designated SearchKey field, then use this field as the key field when joining to other event data by IP address.

itemsSearchKey: string

Property Value

string

labels

List of labels relevant to this watchlist

labels?: string[]

Property Value

string[]

numberOfLinesToSkip

The number of lines in a csv/tsv content to skip before the header

numberOfLinesToSkip?: number

Property Value

number

provider

The provider of the watchlist

provider: string

Property Value

string

provisioningState

Describes provisioning state

provisioningState?: string

Property Value

string

rawContent

The raw content that represents to watchlist items to create. In case of csv/tsv content type, it's the content of the file that will parsed by the endpoint

rawContent?: string

Property Value

string

source

The filename of the watchlist, called 'source'

source?: string

Property Value

string

sourceType

The sourceType of the watchlist

sourceType?: string

Property Value

string

tenantId

The tenantId where the watchlist belongs to

tenantId?: string

Property Value

string

updated

The last time the watchlist was updated

updated?: Date

Property Value

Date

updatedBy

Describes a user that updated the watchlist

updatedBy?: UserInfo

Property Value

UserInfo

uploadStatus

The status of the Watchlist upload : New, InProgress or Complete. Note : When a Watchlist upload status is InProgress, the Watchlist cannot be deleted

uploadStatus?: string

Property Value

string

watchlistAlias

The alias of the watchlist

watchlistAlias?: string

Property Value

string

watchlistId

The id (a Guid) of the watchlist

watchlistId?: string

Property Value

string

watchlistType

The type of the watchlist

watchlistType?: string

Property Value

string