Watchlists interface
Interface representing a Watchlists.
Methods
| create |
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. |
| delete(string, string, string, Watchlists |
Delete a watchlist. |
| get(string, string, string, Watchlists |
Gets a watchlist, without its watchlist items. |
| list(string, string, Watchlists |
Gets all watchlists, without watchlist items. |
Method Details
createOrUpdate(string, string, string, Watchlist, WatchlistsCreateOrUpdateOptionalParams)
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.
function createOrUpdate(resourceGroupName: string, workspaceName: string, watchlistAlias: string, watchlist: Watchlist, options?: WatchlistsCreateOrUpdateOptionalParams): Promise<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
- watchlist
- Watchlist
The watchlist
The options parameters.
Returns
Promise<Watchlist>
delete(string, string, string, WatchlistsDeleteOptionalParams)
Delete a watchlist.
function delete(resourceGroupName: string, workspaceName: string, watchlistAlias: string, options?: WatchlistsDeleteOptionalParams): Promise<WatchlistsDeleteHeaders>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
- WatchlistsDeleteOptionalParams
The options parameters.
Returns
Promise<WatchlistsDeleteHeaders>
get(string, string, string, WatchlistsGetOptionalParams)
Gets a watchlist, without its watchlist items.
function get(resourceGroupName: string, workspaceName: string, watchlistAlias: string, options?: WatchlistsGetOptionalParams): Promise<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
- options
- WatchlistsGetOptionalParams
The options parameters.
Returns
Promise<Watchlist>
list(string, string, WatchlistsListOptionalParams)
Gets all watchlists, without watchlist items.
function list(resourceGroupName: string, workspaceName: string, options?: WatchlistsListOptionalParams): PagedAsyncIterableIterator<Watchlist, Watchlist[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- workspaceName
-
string
The name of the workspace.
- options
- WatchlistsListOptionalParams
The options parameters.
Returns
Azure SDK for JavaScript