Package com.azure.resourcemanager.securityinsights.fluent

Interface WatchlistItemsClient

public interface WatchlistItemsClient

An instance of this class provides access to all the operations defined in WatchlistItemsClient.

Method Summary

Modifier and Type	Method	Description
WatchlistItemInner	createOrUpdate(String resourceGroupName, String workspaceName, String watchlistAlias, String watchlistItemId, WatchlistItemInner watchlistItem)	Creates or updates a watchlist item.
com.azure.core.http.rest.Response<WatchlistItemInner>	createOrUpdateWithResponse(String resourceGroupName, String workspaceName, String watchlistAlias, String watchlistItemId, WatchlistItemInner watchlistItem, com.azure.core.util.Context context)	Creates or updates a watchlist item.
void	delete(String resourceGroupName, String workspaceName, String watchlistAlias, String watchlistItemId)	Delete a watchlist item.
com.azure.core.http.rest.Response<Void>	deleteWithResponse(String resourceGroupName, String workspaceName, String watchlistAlias, String watchlistItemId, com.azure.core.util.Context context)	Delete a watchlist item.
WatchlistItemInner	get(String resourceGroupName, String workspaceName, String watchlistAlias, String watchlistItemId)	Gets a watchlist, without its watchlist items.
com.azure.core.http.rest.Response<WatchlistItemInner>	getWithResponse(String resourceGroupName, String workspaceName, String watchlistAlias, String watchlistItemId, com.azure.core.util.Context context)	Gets a watchlist, without its watchlist items.
com.azure.core.http.rest.PagedIterable<WatchlistItemInner>	list(String resourceGroupName, String workspaceName, String watchlistAlias)	Gets all watchlist Items.
com.azure.core.http.rest.PagedIterable<WatchlistItemInner>	list(String resourceGroupName, String workspaceName, String watchlistAlias, String skipToken, com.azure.core.util.Context context)	Gets all watchlist Items.

Method Detail

list

com.azure.core.http.rest.PagedIterable<WatchlistItemInner> list(String resourceGroupName,
                                                                String workspaceName,
                                                                String watchlistAlias)

Gets all 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:

all 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<WatchlistItemInner> list(String resourceGroupName,
                                                                String workspaceName,
                                                                String watchlistAlias,
                                                                String skipToken,
                                                                com.azure.core.util.Context context)

Gets all watchlist Items.

Parameters:

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

workspaceName - The name of the workspace.

watchlistAlias - Watchlist Alias.

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 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

WatchlistItemInner get(String resourceGroupName,
                       String workspaceName,
                       String watchlistAlias,
                       String watchlistItemId)

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.

watchlistItemId - Watchlist Item Id (GUID).

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<WatchlistItemInner> getWithResponse(String resourceGroupName,
                                                                      String workspaceName,
                                                                      String watchlistAlias,
                                                                      String watchlistItemId,
                                                                      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.

watchlistItemId - Watchlist Item Id (GUID).

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,
            String watchlistItemId)

Delete a watchlist item.

Parameters:

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

workspaceName - The name of the workspace.

watchlistAlias - Watchlist Alias.

watchlistItemId - Watchlist Item Id (GUID).

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

com.azure.core.http.rest.Response<Void> deleteWithResponse(String resourceGroupName,
                                                           String workspaceName,
                                                           String watchlistAlias,
                                                           String watchlistItemId,
                                                           com.azure.core.util.Context context)

Delete a watchlist item.

Parameters:

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

workspaceName - The name of the workspace.

watchlistAlias - Watchlist Alias.

watchlistItemId - Watchlist Item Id (GUID).

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

WatchlistItemInner createOrUpdate(String resourceGroupName,
                                  String workspaceName,
                                  String watchlistAlias,
                                  String watchlistItemId,
                                  WatchlistItemInner watchlistItem)

Creates or updates a watchlist item.

Parameters:

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

workspaceName - The name of the workspace.

watchlistAlias - Watchlist Alias.

watchlistItemId - Watchlist Item Id (GUID).

watchlistItem - The watchlist item.

Returns:

represents a Watchlist item 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

com.azure.core.http.rest.Response<WatchlistItemInner> createOrUpdateWithResponse(String resourceGroupName,
                                                                                 String workspaceName,
                                                                                 String watchlistAlias,
                                                                                 String watchlistItemId,
                                                                                 WatchlistItemInner watchlistItem,
                                                                                 com.azure.core.util.Context context)

Creates or updates a watchlist item.

Parameters:

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

workspaceName - The name of the workspace.

watchlistAlias - Watchlist Alias.

watchlistItemId - Watchlist Item Id (GUID).

watchlistItem - The watchlist item.

context - The context to associate with this operation.

Returns:

represents a Watchlist item in Azure Security Insights 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.