Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Watchlist

Package version

Represents a Watchlist in Azure Security Insights.

Hierarchy

Index

Properties

Optional contentType

contentType: undefined | string

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

Optional created

created: Date

The time the watchlist was created

Optional createdBy

createdBy: UserInfo

Describes a user that created the watchlist

Optional defaultDuration

defaultDuration: undefined | string

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

Optional description

description: undefined | string

A description of the watchlist

Optional displayName

displayName: undefined | string

The display name of the watchlist

Optional etag

etag: undefined | string

Etag of the azure resource

Optional id

id: undefined | string

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.

Optional isDeleted

isDeleted: undefined | false | true

A flag that indicates if the watchlist is deleted or not

Optional itemsSearchKey

itemsSearchKey: undefined | string

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.

Optional labels

labels: string[]

List of labels relevant to this watchlist

Optional name

name: undefined | string

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

Optional numberOfLinesToSkip

numberOfLinesToSkip: undefined | number

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

Optional provider

provider: undefined | string

The provider of the watchlist

Optional rawContent

rawContent: undefined | string

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

Optional source

source: undefined | string

The filename of the watchlist, called 'source'

Optional sourceType

sourceType: SourceType

The sourceType of the watchlist

Optional systemData

systemData: 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.

Optional tenantId

tenantId: undefined | string

The tenantId where the watchlist belongs to

Optional type

type: undefined | string

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.

Optional updated

updated: Date

The last time the watchlist was updated

Optional updatedBy

updatedBy: UserInfo

Describes a user that updated the watchlist

Optional uploadStatus

uploadStatus: undefined | string

The status of the Watchlist upload : New, InProgress or Complete. Pls note : When a Watchlist upload status is equal to InProgress, the Watchlist cannot be deleted

Optional watchlistAlias

watchlistAlias: undefined | string

The alias of the watchlist

Optional watchlistId

watchlistId: undefined | string

The id (a Guid) of the watchlist

Optional watchlistType

watchlistType: undefined | string

The type of the watchlist

Generated using TypeDoc