WatchlistItems interface

Package:

@azure/arm-securityinsight

Interface representing a WatchlistItems.

Methods

createOrUpdate(string, string, string, string, WatchlistItem, WatchlistItemsCreateOrUpdateOptionalParams)	Creates or updates a watchlist item.
delete(string, string, string, string, WatchlistItemsDeleteOptionalParams)	Delete a watchlist item.
get(string, string, string, string, WatchlistItemsGetOptionalParams)	Gets a watchlist, without its watchlist items.
list(string, string, string, WatchlistItemsListOptionalParams)	Gets all watchlist Items.

Method Details

createOrUpdate(string, string, string, string, WatchlistItem, WatchlistItemsCreateOrUpdateOptionalParams)

Creates or updates a watchlist item.

function createOrUpdate(resourceGroupName: string, workspaceName: string, watchlistAlias: string, watchlistItemId: string, watchlistItem: WatchlistItem, options?: WatchlistItemsCreateOrUpdateOptionalParams): Promise<WatchlistItem>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

workspaceName

string

The name of the workspace.

watchlistAlias

string

Watchlist Alias

watchlistItemId

string

Watchlist Item Id (GUID)

watchlistItem

WatchlistItem

The watchlist item

options

WatchlistItemsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<WatchlistItem>

delete(string, string, string, string, WatchlistItemsDeleteOptionalParams)

Delete a watchlist item.

function delete(resourceGroupName: string, workspaceName: string, watchlistAlias: string, watchlistItemId: string, options?: WatchlistItemsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

workspaceName

string

The name of the workspace.

watchlistAlias

string

Watchlist Alias

watchlistItemId

string

Watchlist Item Id (GUID)

options

WatchlistItemsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, string, WatchlistItemsGetOptionalParams)

Gets a watchlist, without its watchlist items.

function get(resourceGroupName: string, workspaceName: string, watchlistAlias: string, watchlistItemId: string, options?: WatchlistItemsGetOptionalParams): Promise<WatchlistItem>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

workspaceName

string

The name of the workspace.

watchlistAlias

string

Watchlist Alias

watchlistItemId

string

Watchlist Item Id (GUID)

options

WatchlistItemsGetOptionalParams

The options parameters.

Returns

Promise<WatchlistItem>

list(string, string, string, WatchlistItemsListOptionalParams)

Gets all watchlist Items.

function list(resourceGroupName: string, workspaceName: string, watchlistAlias: string, options?: WatchlistItemsListOptionalParams): PagedAsyncIterableIterator<WatchlistItem, WatchlistItem[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

workspaceName

string

The name of the workspace.

watchlistAlias

string

Watchlist Alias

options

WatchlistItemsListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<WatchlistItem, WatchlistItem[], PageSettings>