GetWatchlistResult

data class GetWatchlistResult(val contentType: String? = null, val created: String? = null, val createdBy: WatchlistUserInfoResponse? = null, val defaultDuration: String? = null, val description: String? = null, val displayName: String, val etag: String? = null, val id: String, val isDeleted: Boolean? = null, val itemsSearchKey: String, val labels: List<String>? = null, val name: String, val numberOfLinesToSkip: Int? = null, val provider: String, val rawContent: String? = null, val source: String, val systemData: SystemDataResponse, val tenantId: String? = null, val type: String, val updated: String? = null, val updatedBy: WatchlistUserInfoResponse? = null, val uploadStatus: String? = null, val watchlistAlias: String? = null, val watchlistId: String? = null, val watchlistItemsCount: Int? = null, val watchlistType: String? = null)

Represents a Watchlist in Azure Security Insights.

Constructors

Link copied to clipboard
constructor(contentType: String? = null, created: String? = null, createdBy: WatchlistUserInfoResponse? = null, defaultDuration: String? = null, description: String? = null, displayName: String, etag: String? = null, id: String, isDeleted: Boolean? = null, itemsSearchKey: String, labels: List<String>? = null, name: String, numberOfLinesToSkip: Int? = null, provider: String, rawContent: String? = null, source: String, systemData: SystemDataResponse, tenantId: String? = null, type: String, updated: String? = null, updatedBy: WatchlistUserInfoResponse? = null, uploadStatus: String? = null, watchlistAlias: String? = null, watchlistId: String? = null, watchlistItemsCount: Int? = null, watchlistType: String? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val contentType: String? = null

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

Link copied to clipboard
val created: String? = null

The time the watchlist was created

Link copied to clipboard

Describes a user that created the watchlist

Link copied to clipboard
val defaultDuration: String? = null

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

Link copied to clipboard
val description: String? = null

A description of the watchlist

Link copied to clipboard

The display name of the watchlist

Link copied to clipboard
val etag: String? = null

Etag of the azure resource

Link copied to clipboard
val id: String

Azure resource Id

Link copied to clipboard
val isDeleted: Boolean? = null

A flag that indicates if the watchlist is deleted or not

Link copied to clipboard

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.

Link copied to clipboard
val labels: List<String>? = null

List of labels relevant to this watchlist

Link copied to clipboard

Azure resource name

Link copied to clipboard

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

Link copied to clipboard

The provider of the watchlist

Link copied to clipboard
val rawContent: String? = null

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

Link copied to clipboard

The source of the watchlist

Link copied to clipboard

Azure Resource Manager metadata containing createdBy and modifiedBy information.

Link copied to clipboard
val tenantId: String? = null

The tenantId where the watchlist belongs to

Link copied to clipboard

Azure resource type

Link copied to clipboard
val updated: String? = null

The last time the watchlist was updated

Link copied to clipboard

Describes a user that updated the watchlist

Link copied to clipboard
val uploadStatus: String? = null

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

Link copied to clipboard
val watchlistAlias: String? = null

The alias of the watchlist

Link copied to clipboard
val watchlistId: String? = null

The id (a Guid) of the watchlist

Link copied to clipboard

The number of Watchlist Items in the Watchlist

Link copied to clipboard
val watchlistType: String? = null

The type of the watchlist