MailboxEntity interface

Package:

@azure/arm-securityinsight

Represents a mailbox entity.

Extends

Entity

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.
displayName	The mailbox's display name NOTE: This property will not be serialized. It can only be populated by the server.
externalDirectoryObjectId	The AzureAD identifier of mailbox. Similar to AadUserId in account entity but this property is specific to mailbox object on office side 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.
kind	Polymorphic discriminator, which specifies the different types this object can be
mailboxPrimaryAddress	The mailbox's primary address NOTE: This property will not be serialized. It can only be populated by the server.
upn	The mailbox's UPN 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>}

displayName

The mailbox's display name NOTE: This property will not be serialized. It can only be populated by the server.

displayName?: string

Property Value

string

externalDirectoryObjectId

The AzureAD identifier of mailbox. Similar to AadUserId in account entity but this property is specific to mailbox object on office side NOTE: This property will not be serialized. It can only be populated by the server.

externalDirectoryObjectId?: string

Property Value

string

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

kind

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

kind: "Mailbox"

Property Value

"Mailbox"

mailboxPrimaryAddress

The mailbox's primary address NOTE: This property will not be serialized. It can only be populated by the server.

mailboxPrimaryAddress?: string

Property Value

string

upn

The mailbox's UPN NOTE: This property will not be serialized. It can only be populated by the server.

upn?: 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

SystemData

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