WatchlistItems | @azure/arm-securityinsight

Interface representing a WatchlistItems.

Hierarchy

WatchlistItems

Implemented by

WatchlistItemsImpl

Index

Methods

createOrUpdate

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

- Defined in operationsInterfaces/watchlistItems.ts:75
Creates or updates a watchlist item.

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

delete

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

- Defined in operationsInterfaces/watchlistItems.ts:59
Delete a watchlist item.

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)
- Optional options: WatchlistItemsDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

get

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

- Defined in operationsInterfaces/watchlistItems.ts:44
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
- watchlistItemId: string
  
  Watchlist Item Id (GUID)
- Optional options: WatchlistItemsGetOptionalParams
  
  The options parameters.
Returns Promise<WatchlistItemsGetResponse>

list

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

- Defined in operationsInterfaces/watchlistItems.ts:30
Gets all 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: WatchlistItemsListOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<WatchlistItem>

Hierarchy

Implemented by

Index

Methods

Methods

createOrUpdate

Parameters

resourceGroupName: string

workspaceName: string

watchlistAlias: string

watchlistItemId: string

watchlistItem: WatchlistItem

Optional options: WatchlistItemsCreateOrUpdateOptionalParams

Returns Promise<WatchlistItemsCreateOrUpdateResponse>

delete

Parameters

resourceGroupName: string

workspaceName: string

watchlistAlias: string

watchlistItemId: string

Optional options: WatchlistItemsDeleteOptionalParams

Returns Promise<void>

get

Parameters

resourceGroupName: string

workspaceName: string

watchlistAlias: string

watchlistItemId: string

Optional options: WatchlistItemsGetOptionalParams

Returns Promise<WatchlistItemsGetResponse>

list

Parameters

resourceGroupName: string

workspaceName: string

watchlistAlias: string

Optional options: WatchlistItemsListOptionalParams

Returns PagedAsyncIterableIterator<WatchlistItem>