Interface WatchlistsClient


public interface WatchlistsClient
An instance of this class provides access to all the operations defined in WatchlistsClient.
  • Method Details

    • list

      com.azure.core.http.rest.PagedIterable<WatchlistInner> list(String resourceGroupName, String workspaceName)
      Gets all watchlists, without watchlist items.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      workspaceName - The name of the workspace.
      Returns:
      all watchlists, without watchlist items as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • list

      com.azure.core.http.rest.PagedIterable<WatchlistInner> list(String resourceGroupName, String workspaceName, String skipToken, com.azure.core.util.Context context)
      Gets all watchlists, without watchlist items.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      workspaceName - The name of the workspace.
      skipToken - Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls. Optional.
      context - The context to associate with this operation.
      Returns:
      all watchlists, without watchlist items as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • get

      WatchlistInner get(String resourceGroupName, String workspaceName, String watchlistAlias)
      Gets a watchlist, without its watchlist items.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      workspaceName - The name of the workspace.
      watchlistAlias - Watchlist Alias.
      Returns:
      a watchlist, without its watchlist items.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • getWithResponse

      com.azure.core.http.rest.Response<WatchlistInner> getWithResponse(String resourceGroupName, String workspaceName, String watchlistAlias, com.azure.core.util.Context context)
      Gets a watchlist, without its watchlist items.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      workspaceName - The name of the workspace.
      watchlistAlias - Watchlist Alias.
      context - The context to associate with this operation.
      Returns:
      a watchlist, without its watchlist items along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • delete

      void delete(String resourceGroupName, String workspaceName, String watchlistAlias)
      Delete a watchlist.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      workspaceName - The name of the workspace.
      watchlistAlias - Watchlist Alias.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • deleteWithResponse

      WatchlistsDeleteResponse deleteWithResponse(String resourceGroupName, String workspaceName, String watchlistAlias, com.azure.core.util.Context context)
      Delete a watchlist.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      workspaceName - The name of the workspace.
      watchlistAlias - Watchlist Alias.
      context - The context to associate with this operation.
      Returns:
      the response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • createOrUpdate

      WatchlistInner createOrUpdate(String resourceGroupName, String workspaceName, String watchlistAlias, WatchlistInner watchlist)
      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 - The name of the resource group. The name is case insensitive.
      workspaceName - The name of the workspace.
      watchlistAlias - Watchlist Alias.
      watchlist - The watchlist.
      Returns:
      represents a Watchlist in Azure Security Insights.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • createOrUpdateWithResponse

      WatchlistsCreateOrUpdateResponse createOrUpdateWithResponse(String resourceGroupName, String workspaceName, String watchlistAlias, WatchlistInner watchlist, com.azure.core.util.Context context)
      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 - The name of the resource group. The name is case insensitive.
      workspaceName - The name of the workspace.
      watchlistAlias - Watchlist Alias.
      watchlist - The watchlist.
      context - The context to associate with this operation.
      Returns:
      represents a Watchlist in Azure Security Insights.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.