MailClusterEntity interface

Represents a mail cluster entity.

Extends

Properties

additionalData

A bag of custom fields that should be part of the entity and will be presented to the user. NOTE: This property will not be serialized. It can only be populated by the server.

clusterGroup

The cluster group NOTE: This property will not be serialized. It can only be populated by the server.

clusterQueryEndTime

The cluster query end time NOTE: This property will not be serialized. It can only be populated by the server.

clusterQueryStartTime

The cluster query start time NOTE: This property will not be serialized. It can only be populated by the server.

clusterSourceIdentifier

The id of the cluster source NOTE: This property will not be serialized. It can only be populated by the server.

clusterSourceType

The type of the cluster source NOTE: This property will not be serialized. It can only be populated by the server.

countByDeliveryStatus

Count of mail messages by DeliveryStatus string representation NOTE: This property will not be serialized. It can only be populated by the server.

countByProtectionStatus

Count of mail messages by ProtectionStatus string representation NOTE: This property will not be serialized. It can only be populated by the server.

countByThreatType

Count of mail messages by ThreatType string representation NOTE: This property will not be serialized. It can only be populated by the server.

friendlyName

The graph item display name which is a short humanly readable description of the graph item instance. This property is optional and might be system generated. NOTE: This property will not be serialized. It can only be populated by the server.

isVolumeAnomaly

Is this a volume anomaly mail cluster NOTE: This property will not be serialized. It can only be populated by the server.

kind

Polymorphic discriminator, which specifies the different types this object can be

mailCount

The number of mail messages that are part of the mail cluster NOTE: This property will not be serialized. It can only be populated by the server.

networkMessageIds

The mail message IDs that are part of the mail cluster NOTE: This property will not be serialized. It can only be populated by the server.

query

The query that was used to identify the messages of the mail cluster NOTE: This property will not be serialized. It can only be populated by the server.

queryTime

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

source

The source of the mail cluster (default is 'O365 ATP') NOTE: This property will not be serialized. It can only be populated by the server.

threats

The threats of mail messages that are part of the mail cluster NOTE: This property will not be serialized. It can only be populated by the server.

Inherited Properties

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

A bag of custom fields that should be part of the entity and will be presented to the user. NOTE: This property will not be serialized. It can only be populated by the server.

additionalData?: {[propertyName: string]: Record<string, unknown>}

Property Value

{[propertyName: string]: Record<string, unknown>}

clusterGroup

The cluster group NOTE: This property will not be serialized. It can only be populated by the server.

clusterGroup?: string

Property Value

string

clusterQueryEndTime

The cluster query end time NOTE: This property will not be serialized. It can only be populated by the server.

clusterQueryEndTime?: Date

Property Value

Date

clusterQueryStartTime

The cluster query start time NOTE: This property will not be serialized. It can only be populated by the server.

clusterQueryStartTime?: Date

Property Value

Date

clusterSourceIdentifier

The id of the cluster source NOTE: This property will not be serialized. It can only be populated by the server.

clusterSourceIdentifier?: string

Property Value

string

clusterSourceType

The type of the cluster source NOTE: This property will not be serialized. It can only be populated by the server.

clusterSourceType?: string

Property Value

string

countByDeliveryStatus

Count of mail messages by DeliveryStatus string representation NOTE: This property will not be serialized. It can only be populated by the server.

countByDeliveryStatus?: Record<string, unknown>

Property Value

Record<string, unknown>

countByProtectionStatus

Count of mail messages by ProtectionStatus string representation NOTE: This property will not be serialized. It can only be populated by the server.

countByProtectionStatus?: Record<string, unknown>

Property Value

Record<string, unknown>

countByThreatType

Count of mail messages by ThreatType string representation NOTE: This property will not be serialized. It can only be populated by the server.

countByThreatType?: Record<string, unknown>

Property Value

Record<string, unknown>

friendlyName

The graph item display name which is a short humanly readable description of the graph item instance. This property is optional and might be system generated. NOTE: This property will not be serialized. It can only be populated by the server.

friendlyName?: string

Property Value

string

isVolumeAnomaly

Is this a volume anomaly mail cluster NOTE: This property will not be serialized. It can only be populated by the server.

isVolumeAnomaly?: boolean

Property Value

boolean

kind

Polymorphic discriminator, which specifies the different types this object can be

kind: "MailCluster"

Property Value

"MailCluster"

mailCount

The number of mail messages that are part of the mail cluster NOTE: This property will not be serialized. It can only be populated by the server.

mailCount?: number

Property Value

number

networkMessageIds

The mail message IDs that are part of the mail cluster NOTE: This property will not be serialized. It can only be populated by the server.

networkMessageIds?: string[]

Property Value

string[]

query

The query that was used to identify the messages of the mail cluster NOTE: This property will not be serialized. It can only be populated by the server.

query?: string

Property Value

string

queryTime

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

queryTime?: Date

Property Value

Date

source

The source of the mail cluster (default is 'O365 ATP') NOTE: This property will not be serialized. It can only be populated by the server.

source?: string

Property Value

string

threats

The threats of mail messages that are part of the mail cluster NOTE: This property will not be serialized. It can only be populated by the server.

threats?: string[]

Property Value

string[]

Inherited Property Details

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

Inherited From Entity.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 Entity.type