Interface Incident
-
public interface Incident
An immutable client-side representation of Incident.
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static interface
Incident.Definition
The entirety of the Incident definition.static interface
Incident.DefinitionStages
The Incident definition stages.static interface
Incident.Update
The template for Incident update.static interface
Incident.UpdateStages
The Incident update stages.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description IncidentAdditionalData
additionalData()
Gets the additionalData property: Additional data on the incident.IncidentClassification
classification()
Gets the classification property: The reason the incident was closed.String
classificationComment()
Gets the classificationComment property: Describes the reason the incident was closed.IncidentClassificationReason
classificationReason()
Gets the classificationReason property: The classification reason the incident was closed with.OffsetDateTime
createdTimeUtc()
Gets the createdTimeUtc property: The time the incident was created.TeamInformation
createTeam(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(TeamProperties teamProperties, com.azure.core.util.Context context)
Creates a Microsoft team to investigate the incident by sharing information and insights between participants.String
description()
Gets the description property: The description of the incident.String
etag()
Gets the etag property: Etag of the azure resource.OffsetDateTime
firstActivityTimeUtc()
Gets the firstActivityTimeUtc property: The time of the first activity in the incident.String
id()
Gets the id property: Fully qualified resource Id for the resource.Integer
incidentNumber()
Gets the incidentNumber property: A sequential number.String
incidentUrl()
Gets the incidentUrl property: The deep-link url to the incident in Azure portal.IncidentInner
innerModel()
Gets the inner com.azure.resourcemanager.securityinsights.fluent.models.IncidentInner object.List<IncidentLabel>
labels()
Gets the labels property: List of labels relevant to this incident.OffsetDateTime
lastActivityTimeUtc()
Gets the lastActivityTimeUtc property: The time of the last activity in the incident.OffsetDateTime
lastModifiedTimeUtc()
Gets the lastModifiedTimeUtc property: The last time the incident was updated.IncidentAlertList
listAlerts()
Gets all incident alerts.com.azure.core.http.rest.Response<IncidentAlertList>
listAlertsWithResponse(com.azure.core.util.Context context)
Gets all incident alerts.IncidentBookmarkList
listBookmarks()
Gets all incident bookmarks.com.azure.core.http.rest.Response<IncidentBookmarkList>
listBookmarksWithResponse(com.azure.core.util.Context context)
Gets all incident bookmarks.IncidentEntitiesResponse
listEntities()
Gets all incident related entities.com.azure.core.http.rest.Response<IncidentEntitiesResponse>
listEntitiesWithResponse(com.azure.core.util.Context context)
Gets all incident related entities.String
name()
Gets the name property: The name of the resource.IncidentOwnerInfo
owner()
Gets the owner property: Describes a user that the incident is assigned to.String
providerIncidentId()
Gets the providerIncidentId property: The incident ID assigned by the incident provider.String
providerName()
Gets the providerName property: The name of the source provider that generated the incident.Incident
refresh()
Refreshes the resource to sync with Azure.Incident
refresh(com.azure.core.util.Context context)
Refreshes the resource to sync with Azure.List<String>
relatedAnalyticRuleIds()
Gets the relatedAnalyticRuleIds property: List of resource ids of Analytic rules related to the incident.String
resourceGroupName()
Gets the name of the resource group.IncidentSeverity
severity()
Gets the severity property: The severity of the incident.IncidentStatus
status()
Gets the status property: The status of the incident.com.azure.core.management.SystemData
systemData()
Gets the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.TeamInformation
teamInformation()
Gets the teamInformation property: Describes a team for the incident.String
title()
Gets the title property: The title of the incident.String
type()
Gets the type property: The type of the resource.Incident.Update
update()
Begins update for the Incident resource.
-
-
-
Method Detail
-
id
String id()
Gets the id property: Fully qualified resource Id for the resource.- Returns:
- the id value.
-
name
String name()
Gets the name property: The name of the resource.- Returns:
- the name value.
-
type
String type()
Gets the type property: The type of the resource.- Returns:
- the type value.
-
etag
String etag()
Gets the etag property: Etag of the azure resource.- Returns:
- the etag value.
-
systemData
com.azure.core.management.SystemData systemData()
Gets the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.- Returns:
- the systemData value.
-
additionalData
IncidentAdditionalData additionalData()
Gets the additionalData property: Additional data on the incident.- Returns:
- the additionalData value.
-
classification
IncidentClassification classification()
Gets the classification property: The reason the incident was closed.- Returns:
- the classification value.
-
classificationComment
String classificationComment()
Gets the classificationComment property: Describes the reason the incident was closed.- Returns:
- the classificationComment value.
-
classificationReason
IncidentClassificationReason classificationReason()
Gets the classificationReason property: The classification reason the incident was closed with.- Returns:
- the classificationReason value.
-
createdTimeUtc
OffsetDateTime createdTimeUtc()
Gets the createdTimeUtc property: The time the incident was created.- Returns:
- the createdTimeUtc value.
-
description
String description()
Gets the description property: The description of the incident.- Returns:
- the description value.
-
firstActivityTimeUtc
OffsetDateTime firstActivityTimeUtc()
Gets the firstActivityTimeUtc property: The time of the first activity in the incident.- Returns:
- the firstActivityTimeUtc value.
-
incidentUrl
String incidentUrl()
Gets the incidentUrl property: The deep-link url to the incident in Azure portal.- Returns:
- the incidentUrl value.
-
incidentNumber
Integer incidentNumber()
Gets the incidentNumber property: A sequential number.- Returns:
- the incidentNumber value.
-
labels
List<IncidentLabel> labels()
Gets the labels property: List of labels relevant to this incident.- Returns:
- the labels value.
-
providerName
String providerName()
Gets the providerName property: The name of the source provider that generated the incident.- Returns:
- the providerName value.
-
providerIncidentId
String providerIncidentId()
Gets the providerIncidentId property: The incident ID assigned by the incident provider.- Returns:
- the providerIncidentId value.
-
lastActivityTimeUtc
OffsetDateTime lastActivityTimeUtc()
Gets the lastActivityTimeUtc property: The time of the last activity in the incident.- Returns:
- the lastActivityTimeUtc value.
-
lastModifiedTimeUtc
OffsetDateTime lastModifiedTimeUtc()
Gets the lastModifiedTimeUtc property: The last time the incident was updated.- Returns:
- the lastModifiedTimeUtc value.
-
owner
IncidentOwnerInfo owner()
Gets the owner property: Describes a user that the incident is assigned to.- Returns:
- the owner value.
-
relatedAnalyticRuleIds
List<String> relatedAnalyticRuleIds()
Gets the relatedAnalyticRuleIds property: List of resource ids of Analytic rules related to the incident.- Returns:
- the relatedAnalyticRuleIds value.
-
severity
IncidentSeverity severity()
Gets the severity property: The severity of the incident.- Returns:
- the severity value.
-
status
IncidentStatus status()
Gets the status property: The status of the incident.- Returns:
- the status value.
-
teamInformation
TeamInformation teamInformation()
Gets the teamInformation property: Describes a team for the incident.- Returns:
- the teamInformation value.
-
title
String title()
Gets the title property: The title of the incident.- Returns:
- the title value.
-
resourceGroupName
String resourceGroupName()
Gets the name of the resource group.- Returns:
- the name of the resource group.
-
innerModel
IncidentInner innerModel()
Gets the inner com.azure.resourcemanager.securityinsights.fluent.models.IncidentInner object.- Returns:
- the inner object.
-
update
Incident.Update update()
Begins update for the Incident resource.- Returns:
- the stage of resource update.
-
refresh
Incident refresh()
Refreshes the resource to sync with Azure.- Returns:
- the refreshed resource.
-
refresh
Incident refresh(com.azure.core.util.Context context)
Refreshes the resource to sync with Azure.- Parameters:
context
- The context to associate with this operation.- Returns:
- the refreshed resource.
-
createTeam
TeamInformation createTeam(TeamProperties teamProperties)
Creates a Microsoft team to investigate the incident by sharing information and insights between participants.- Parameters:
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(TeamProperties teamProperties, com.azure.core.util.Context context)
Creates a Microsoft team to investigate the incident by sharing information and insights between participants.- Parameters:
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()
Gets all incident alerts.- Returns:
- all incident alerts.
- Throws:
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(com.azure.core.util.Context context)
Gets all incident alerts.- Parameters:
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()
Gets all incident bookmarks.- Returns:
- all incident bookmarks.
- Throws:
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(com.azure.core.util.Context context)
Gets all incident bookmarks.- Parameters:
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()
Gets all incident related entities.- Returns:
- all incident related entities.
- Throws:
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(com.azure.core.util.Context context)
Gets all incident related entities.- Parameters:
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.
-
-