Package com.azure.resourcemanager.securityinsights.models

Interface Entities

public interface Entities

Resource collection API of Entities.

Method Summary

Modifier and Type	Method	Description
EntityExpandResponse	expand(String resourceGroupName, String workspaceName, String entityId, EntityExpandParameters parameters)	Expands an entity.
com.azure.core.http.rest.Response<EntityExpandResponse>	expandWithResponse(String resourceGroupName, String workspaceName, String entityId, EntityExpandParameters parameters, com.azure.core.util.Context context)	Expands an entity.
Entity	get(String resourceGroupName, String workspaceName, String entityId)	Gets an entity.
EntityGetInsightsResponse	getInsights(String resourceGroupName, String workspaceName, String entityId, EntityGetInsightsParameters parameters)	Execute Insights for an entity.
com.azure.core.http.rest.Response<EntityGetInsightsResponse>	getInsightsWithResponse(String resourceGroupName, String workspaceName, String entityId, EntityGetInsightsParameters parameters, com.azure.core.util.Context context)	Execute Insights for an entity.
com.azure.core.http.rest.Response<Entity>	getWithResponse(String resourceGroupName, String workspaceName, String entityId, com.azure.core.util.Context context)	Gets an entity.
com.azure.core.http.rest.PagedIterable<Entity>	list(String resourceGroupName, String workspaceName)	Gets all entities.
com.azure.core.http.rest.PagedIterable<Entity>	list(String resourceGroupName, String workspaceName, com.azure.core.util.Context context)	Gets all entities.
GetQueriesResponse	queries(String resourceGroupName, String workspaceName, String entityId, EntityItemQueryKind kind)	Get Insights and Activities for an entity.
com.azure.core.http.rest.Response<GetQueriesResponse>	queriesWithResponse(String resourceGroupName, String workspaceName, String entityId, EntityItemQueryKind kind, com.azure.core.util.Context context)	Get Insights and Activities for an entity.

Method Detail

list

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

Gets all entities.

Parameters:

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

workspaceName - The name of the workspace.

Returns:

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

Gets all entities.

Parameters:

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

workspaceName - The name of the workspace.

context - The context to associate with this operation.

Returns:

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

Entity get(String resourceGroupName,
           String workspaceName,
           String entityId)

Gets an entity.

Parameters:

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

workspaceName - The name of the workspace.

entityId - entity ID.

Returns:

an entity.

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<Entity> getWithResponse(String resourceGroupName,
                                                          String workspaceName,
                                                          String entityId,
                                                          com.azure.core.util.Context context)

Gets an entity.

Parameters:

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

workspaceName - The name of the workspace.

entityId - entity ID.

context - The context to associate with this operation.

Returns:

an entity 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.

expand

EntityExpandResponse expand(String resourceGroupName,
                            String workspaceName,
                            String entityId,
                            EntityExpandParameters parameters)

Expands an entity.

Parameters:

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

workspaceName - The name of the workspace.

entityId - entity ID.

parameters - The parameters required to execute an expand operation on the given entity.

Returns:

the entity expansion result operation 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.

expandWithResponse

com.azure.core.http.rest.Response<EntityExpandResponse> expandWithResponse(String resourceGroupName,
                                                                           String workspaceName,
                                                                           String entityId,
                                                                           EntityExpandParameters parameters,
                                                                           com.azure.core.util.Context context)

Expands an entity.

Parameters:

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

workspaceName - The name of the workspace.

entityId - entity ID.

parameters - The parameters required to execute an expand operation on the given entity.

context - The context to associate with this operation.

Returns:

the entity expansion result operation response 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.

queries

GetQueriesResponse queries(String resourceGroupName,
                           String workspaceName,
                           String entityId,
                           EntityItemQueryKind kind)

Get Insights and Activities for an entity.

Parameters:

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

workspaceName - The name of the workspace.

entityId - entity ID.

kind - The Kind parameter for queries.

Returns:

insights and Activities for an entity.

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.

queriesWithResponse

com.azure.core.http.rest.Response<GetQueriesResponse> queriesWithResponse(String resourceGroupName,
                                                                          String workspaceName,
                                                                          String entityId,
                                                                          EntityItemQueryKind kind,
                                                                          com.azure.core.util.Context context)

Get Insights and Activities for an entity.

Parameters:

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

workspaceName - The name of the workspace.

entityId - entity ID.

kind - The Kind parameter for queries.

context - The context to associate with this operation.

Returns:

insights and Activities for an entity 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.

getInsights

EntityGetInsightsResponse getInsights(String resourceGroupName,
                                      String workspaceName,
                                      String entityId,
                                      EntityGetInsightsParameters parameters)

Execute Insights for an entity.

Parameters:

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

workspaceName - The name of the workspace.

entityId - entity ID.

parameters - The parameters required to execute insights on the given entity.

Returns:

the Get Insights result operation 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.

getInsightsWithResponse

com.azure.core.http.rest.Response<EntityGetInsightsResponse> getInsightsWithResponse(String resourceGroupName,
                                                                                     String workspaceName,
                                                                                     String entityId,
                                                                                     EntityGetInsightsParameters parameters,
                                                                                     com.azure.core.util.Context context)

Execute Insights for an entity.

Parameters:

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

workspaceName - The name of the workspace.

entityId - entity ID.

parameters - The parameters required to execute insights on the given entity.

context - The context to associate with this operation.

Returns:

the Get Insights result operation response 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.