Package com.azure.resourcemanager.securityinsights.models

Interface Incidents

public interface Incidents

Resource collection API of Incidents.

Method Summary

Modifier and Type	Method	Description
TeamInformation	createTeam(String resourceGroupName, String workspaceName, String incidentId, TeamProperties teamProperties)	Creates a Microsoft team to investigate the incident by sharing information and insights between participants.
com.azure.core.http.rest.Response<TeamInformation>	createTeamWithResponse(String resourceGroupName, String workspaceName, String incidentId, TeamProperties teamProperties, com.azure.core.util.Context context)	Creates a Microsoft team to investigate the incident by sharing information and insights between participants.
Incident.DefinitionStages.Blank	define(String name)	Begins definition for a new Incident resource.
void	delete(String resourceGroupName, String workspaceName, String incidentId)	Delete the incident.
void	deleteById(String id)	Delete the incident.
com.azure.core.http.rest.Response<Void>	deleteByIdWithResponse(String id, com.azure.core.util.Context context)	Delete the incident.
com.azure.core.http.rest.Response<Void>	deleteWithResponse(String resourceGroupName, String workspaceName, String incidentId, com.azure.core.util.Context context)	Delete the incident.
Incident	get(String resourceGroupName, String workspaceName, String incidentId)	Gets an incident.
Incident	getById(String id)	Gets an incident.
com.azure.core.http.rest.Response<Incident>	getByIdWithResponse(String id, com.azure.core.util.Context context)	Gets an incident.
com.azure.core.http.rest.Response<Incident>	getWithResponse(String resourceGroupName, String workspaceName, String incidentId, com.azure.core.util.Context context)	Gets an incident.
com.azure.core.http.rest.PagedIterable<Incident>	list(String resourceGroupName, String workspaceName)	Gets all incidents.
com.azure.core.http.rest.PagedIterable<Incident>	list(String resourceGroupName, String workspaceName, String filter, String orderby, Integer top, String skipToken, com.azure.core.util.Context context)	Gets all incidents.
IncidentAlertList	listAlerts(String resourceGroupName, String workspaceName, String incidentId)	Gets all incident alerts.
com.azure.core.http.rest.Response<IncidentAlertList>	listAlertsWithResponse(String resourceGroupName, String workspaceName, String incidentId, com.azure.core.util.Context context)	Gets all incident alerts.
IncidentBookmarkList	listBookmarks(String resourceGroupName, String workspaceName, String incidentId)	Gets all incident bookmarks.
com.azure.core.http.rest.Response<IncidentBookmarkList>	listBookmarksWithResponse(String resourceGroupName, String workspaceName, String incidentId, com.azure.core.util.Context context)	Gets all incident bookmarks.
IncidentEntitiesResponse	listEntities(String resourceGroupName, String workspaceName, String incidentId)	Gets all incident related entities.
com.azure.core.http.rest.Response<IncidentEntitiesResponse>	listEntitiesWithResponse(String resourceGroupName, String workspaceName, String incidentId, com.azure.core.util.Context context)	Gets all incident related entities.
Object	runPlaybook(String resourceGroupName, String workspaceName, String incidentIdentifier)	Triggers playbook on a specific incident.
com.azure.core.http.rest.Response<Object>	runPlaybookWithResponse(String resourceGroupName, String workspaceName, String incidentIdentifier, ManualTriggerRequestBody requestBody, com.azure.core.util.Context context)	Triggers playbook on a specific incident.

Method Detail

runPlaybook

Object runPlaybook(String resourceGroupName,
                   String workspaceName,
                   String incidentIdentifier)

Triggers playbook on a specific incident.

Parameters:

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

workspaceName - The name of the workspace.

incidentIdentifier - The incidentIdentifier parameter.

Returns:

any object.

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.

runPlaybookWithResponse

com.azure.core.http.rest.Response<Object> runPlaybookWithResponse(String resourceGroupName,
                                                                  String workspaceName,
                                                                  String incidentIdentifier,
                                                                  ManualTriggerRequestBody requestBody,
                                                                  com.azure.core.util.Context context)

Triggers playbook on a specific incident.

Parameters:

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

workspaceName - The name of the workspace.

incidentIdentifier - The incidentIdentifier parameter.

requestBody - The requestBody parameter.

context - The context to associate with this operation.

Returns:

any object 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.

list

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

Gets all incidents.

Parameters:

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

workspaceName - The name of the workspace.

Returns:

all incidents 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<Incident> list(String resourceGroupName,
                                                      String workspaceName,
                                                      String filter,
                                                      String orderby,
                                                      Integer top,
                                                      String skipToken,
                                                      com.azure.core.util.Context context)

Gets all incidents.

Parameters:

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

workspaceName - The name of the workspace.

filter - Filters the results, based on a Boolean condition. Optional.

orderby - Sorts the results. Optional.

top - Returns only the first n results. Optional.

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

Incident get(String resourceGroupName,
             String workspaceName,
             String incidentId)

Gets an incident.

Parameters:

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

workspaceName - The name of the workspace.

incidentId - Incident ID.

Returns:

an incident.

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

Gets an incident.

Parameters:

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

workspaceName - The name of the workspace.

incidentId - Incident ID.

context - The context to associate with this operation.

Returns:

an incident 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 incidentId)

Delete the incident.

Parameters:

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

workspaceName - The name of the workspace.

incidentId - Incident ID.

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 incidentId,
                                                           com.azure.core.util.Context context)

Delete the incident.

Parameters:

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

workspaceName - The name of the workspace.

incidentId - Incident ID.

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.

createTeam

TeamInformation createTeam(String resourceGroupName,
                           String workspaceName,
                           String incidentId,
                           TeamProperties teamProperties)

Creates a Microsoft team to investigate the incident by sharing information and insights between participants.

Parameters:

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

workspaceName - The name of the workspace.

incidentId - Incident ID.

teamProperties - Team properties.

Returns:

describes team information.

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.

createTeamWithResponse

com.azure.core.http.rest.Response<TeamInformation> createTeamWithResponse(String resourceGroupName,
                                                                          String workspaceName,
                                                                          String incidentId,
                                                                          TeamProperties teamProperties,
                                                                          com.azure.core.util.Context context)

Creates a Microsoft team to investigate the incident by sharing information and insights between participants.

Parameters:

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

workspaceName - The name of the workspace.

incidentId - Incident ID.

teamProperties - Team properties.

context - The context to associate with this operation.

Returns:

describes team information 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.

listAlerts

IncidentAlertList listAlerts(String resourceGroupName,
                             String workspaceName,
                             String incidentId)

Gets all incident alerts.

Parameters:

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

workspaceName - The name of the workspace.

incidentId - Incident ID.

Returns:

all incident alerts.

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.

listAlertsWithResponse

com.azure.core.http.rest.Response<IncidentAlertList> listAlertsWithResponse(String resourceGroupName,
                                                                            String workspaceName,
                                                                            String incidentId,
                                                                            com.azure.core.util.Context context)

Gets all incident alerts.

Parameters:

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

workspaceName - The name of the workspace.

incidentId - Incident ID.

context - The context to associate with this operation.

Returns:

all incident alerts 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.

listBookmarks

IncidentBookmarkList listBookmarks(String resourceGroupName,
                                   String workspaceName,
                                   String incidentId)

Gets all incident bookmarks.

Parameters:

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

workspaceName - The name of the workspace.

incidentId - Incident ID.

Returns:

all incident bookmarks.

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.

listBookmarksWithResponse

com.azure.core.http.rest.Response<IncidentBookmarkList> listBookmarksWithResponse(String resourceGroupName,
                                                                                  String workspaceName,
                                                                                  String incidentId,
                                                                                  com.azure.core.util.Context context)

Gets all incident bookmarks.

Parameters:

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

workspaceName - The name of the workspace.

incidentId - Incident ID.

context - The context to associate with this operation.

Returns:

all incident bookmarks 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.

listEntities

IncidentEntitiesResponse listEntities(String resourceGroupName,
                                      String workspaceName,
                                      String incidentId)

Gets all incident related entities.

Parameters:

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

workspaceName - The name of the workspace.

incidentId - Incident ID.

Returns:

all incident related entities.

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.

listEntitiesWithResponse

com.azure.core.http.rest.Response<IncidentEntitiesResponse> listEntitiesWithResponse(String resourceGroupName,
                                                                                     String workspaceName,
                                                                                     String incidentId,
                                                                                     com.azure.core.util.Context context)

Gets all incident related entities.

Parameters:

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

workspaceName - The name of the workspace.

incidentId - Incident ID.

context - The context to associate with this operation.

Returns:

all incident related entities 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.

getById

Incident getById(String id)

Gets an incident.

Parameters:

id - the resource ID.

Returns:

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

getByIdWithResponse

com.azure.core.http.rest.Response<Incident> getByIdWithResponse(String id,
                                                                com.azure.core.util.Context context)

Gets an incident.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Returns:

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

deleteById

void deleteById(String id)

Delete the incident.

Parameters:

id - the resource ID.

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.

deleteByIdWithResponse

com.azure.core.http.rest.Response<Void> deleteByIdWithResponse(String id,
                                                               com.azure.core.util.Context context)

Delete the incident.

Parameters:

id - the resource ID.

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.

define

Incident.DefinitionStages.Blank define(String name)

Begins definition for a new Incident resource.

Parameters:

name - resource name.

Returns:

the first stage of the new Incident definition.