Watchlists | @azure/arm-securityinsight

Interface representing a Watchlists.

Hierarchy

Watchlists

Implemented by

WatchlistsImpl

Index

Methods

createOrUpdate

createOrUpdate(resourceGroupName: string, workspaceName: string, watchlistAlias: string, watchlist: Watchlist, options?: WatchlistsCreateOrUpdateOptionalParams): Promise<WatchlistsCreateOrUpdateResponse>

- Defined in operationsInterfaces/watchlists.ts:74
Create or update a Watchlist and its Watchlist Items (bulk creation, e.g. through text/csv content type). To create a Watchlist and its Items, we should call this endpoint with either rawContent or a valid SAR URI and contentType properties. The rawContent is mainly used for small watchlist (content size below 3.8 MB). The SAS URI enables the creation of large watchlist, where the content size can go up to 500 MB. The status of processing such large file can be polled through the URL returned in Azure-AsyncOperation header.

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
- watchlist: Watchlist
  
  The watchlist
- Optional options: WatchlistsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<WatchlistsCreateOrUpdateResponse>

delete

delete(resourceGroupName: string, workspaceName: string, watchlistAlias: string, options?: WatchlistsDeleteOptionalParams): Promise<WatchlistsDeleteResponse>

- Defined in operationsInterfaces/watchlists.ts:55
Delete a watchlist.

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
- Optional options: WatchlistsDeleteOptionalParams
  
  The options parameters.
Returns Promise<WatchlistsDeleteResponse>

get

get(resourceGroupName: string, workspaceName: string, watchlistAlias: string, options?: WatchlistsGetOptionalParams): Promise<WatchlistsGetResponse>

- Defined in operationsInterfaces/watchlists.ts:42
Gets a watchlist, without its watchlist items.

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
- Optional options: WatchlistsGetOptionalParams
  
  The options parameters.
Returns Promise<WatchlistsGetResponse>

list

list(resourceGroupName: string, workspaceName: string, options?: WatchlistsListOptionalParams): PagedAsyncIterableIterator<Watchlist>

- Defined in operationsInterfaces/watchlists.ts:30
Gets all watchlists, without watchlist items.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- workspaceName: string
  
  The name of the workspace.
- Optional options: WatchlistsListOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<Watchlist>

Hierarchy

Implemented by

Index

Methods

Methods

createOrUpdate

Parameters

resourceGroupName: string

workspaceName: string

watchlistAlias: string

watchlist: Watchlist

Optional options: WatchlistsCreateOrUpdateOptionalParams

Returns Promise<WatchlistsCreateOrUpdateResponse>

delete

Parameters

resourceGroupName: string

workspaceName: string

watchlistAlias: string

Optional options: WatchlistsDeleteOptionalParams

Returns Promise<WatchlistsDeleteResponse>

get

Parameters

resourceGroupName: string

workspaceName: string

watchlistAlias: string

Optional options: WatchlistsGetOptionalParams

Returns Promise<WatchlistsGetResponse>

list

Parameters

resourceGroupName: string

workspaceName: string

Optional options: WatchlistsListOptionalParams

Returns PagedAsyncIterableIterator<Watchlist>