Incident interface

Package:

@azure/arm-securityinsight

Represents an incident in Azure Security Insights.

Extends

ResourceWithEtag

Properties

additionalData	Additional data on the incident NOTE: This property will not be serialized. It can only be populated by the server.
classification	The reason the incident was closed
classificationComment	Describes the reason the incident was closed
classificationReason	The classification reason the incident was closed with
createdTimeUtc	The time the incident was created NOTE: This property will not be serialized. It can only be populated by the server.
description	The description of the incident
firstActivityTimeUtc	The time of the first activity in the incident
incidentNumber	A sequential number NOTE: This property will not be serialized. It can only be populated by the server.
incidentUrl	The deep-link url to the incident in Azure portal NOTE: This property will not be serialized. It can only be populated by the server.
labels	List of labels relevant to this incident
lastActivityTimeUtc	The time of the last activity in the incident
lastModifiedTimeUtc	The last time the incident was updated NOTE: This property will not be serialized. It can only be populated by the server.
owner	Describes a user that the incident is assigned to
providerIncidentId	The incident ID assigned by the incident provider
providerName	The name of the source provider that generated the incident
relatedAnalyticRuleIds	List of resource ids of Analytic rules related to the incident NOTE: This property will not be serialized. It can only be populated by the server.
severity	The severity of the incident
status	The status of the incident
teamInformation	Describes a team for the incident
title	The title of the incident

Inherited Properties

etag	Etag of the azure resource
id	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.
name	The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.
type	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

additionalData

Additional data on the incident NOTE: This property will not be serialized. It can only be populated by the server.

additionalData?: IncidentAdditionalData

Property Value

IncidentAdditionalData

classification

The reason the incident was closed

classification?: string

Property Value

string

classificationComment

Describes the reason the incident was closed

classificationComment?: string

Property Value

string

classificationReason

The classification reason the incident was closed with

classificationReason?: string

Property Value

string

createdTimeUtc

The time the incident was created NOTE: This property will not be serialized. It can only be populated by the server.

createdTimeUtc?: Date

Property Value

Date

description

The description of the incident

description?: string

Property Value

string

firstActivityTimeUtc

The time of the first activity in the incident

firstActivityTimeUtc?: Date

Property Value

Date

incidentNumber

A sequential number NOTE: This property will not be serialized. It can only be populated by the server.

incidentNumber?: number

Property Value

number

incidentUrl

The deep-link url to the incident in Azure portal NOTE: This property will not be serialized. It can only be populated by the server.

incidentUrl?: string

Property Value

string

labels

List of labels relevant to this incident

labels?: IncidentLabel[]

Property Value

IncidentLabel[]

lastActivityTimeUtc

The time of the last activity in the incident

lastActivityTimeUtc?: Date

Property Value

Date

lastModifiedTimeUtc

The last time the incident was updated NOTE: This property will not be serialized. It can only be populated by the server.

lastModifiedTimeUtc?: Date

Property Value

Date

owner

Describes a user that the incident is assigned to

owner?: IncidentOwnerInfo

Property Value

IncidentOwnerInfo

providerIncidentId

The incident ID assigned by the incident provider

providerIncidentId?: string

Property Value

string

providerName

The name of the source provider that generated the incident

providerName?: string

Property Value

string

relatedAnalyticRuleIds

List of resource ids of Analytic rules related to the incident NOTE: This property will not be serialized. It can only be populated by the server.

relatedAnalyticRuleIds?: string[]

Property Value

string[]

severity

The severity of the incident

severity?: string

Property Value

string

status

The status of the incident

status?: string

Property Value

string

teamInformation

Describes a team for the incident

teamInformation?: TeamInformation

Property Value

TeamInformation

title

The title of the incident

title?: string

Property Value

string

Inherited Property Details

etag

Etag of the azure resource

etag?: string

Property Value

string

Inherited From ResourceWithEtag.etag

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From ResourceWithEtag.id

name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From ResourceWithEtag.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

SystemData

Inherited From ResourceWithEtag.systemData

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From ResourceWithEtag.type