AccountEntity interface
Represents an account entity.
- Extends
Properties
| aad |
The Azure Active Directory tenant id. |
| aad |
The Azure Active Directory user id. |
| account |
The name of the account. This field should hold only the name without any domain added to it, i.e. administrator. |
| additional |
A bag of custom fields that should be part of the entity and will be presented to the user. |
| display |
The display name of the account. |
| dns |
The fully qualified domain DNS name. |
| friendly |
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. |
| host |
The Host entity id that contains the account in case it is a local account (not domain joined) |
| is |
Determines whether this is a domain account. |
| kind | The kind of the entity. |
| nt |
The NetBIOS domain name as it appears in the alert format domain/username. Examples: NT AUTHORITY. |
| object |
The objectGUID attribute is a single-value attribute that is the unique identifier for the object, assigned by active directory. |
| puid | The Azure Active Directory Passport User ID. |
| sid | The account security identifier, e.g. S-1-5-18. |
| upn |
The user principal name suffix for the account, in some cases it is also the domain name. Examples: contoso.com. |
Inherited Properties
| id | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
| name | The name of the resource |
| system |
Azure Resource Manager metadata containing createdBy and modifiedBy information. |
| type | The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" |
Property Details
aadTenantId
The Azure Active Directory tenant id.
aadTenantId?: string
Property Value
string
aadUserId
The Azure Active Directory user id.
aadUserId?: string
Property Value
string
accountName
The name of the account. This field should hold only the name without any domain added to it, i.e. administrator.
accountName?: string
Property Value
string
additionalData
A bag of custom fields that should be part of the entity and will be presented to the user.
additionalData?: Record<string, any>
Property Value
Record<string, any>
displayName
The display name of the account.
displayName?: string
Property Value
string
dnsDomain
The fully qualified domain DNS name.
dnsDomain?: 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.
friendlyName?: string
Property Value
string
hostEntityId
The Host entity id that contains the account in case it is a local account (not domain joined)
hostEntityId?: string
Property Value
string
isDomainJoined
Determines whether this is a domain account.
isDomainJoined?: boolean
Property Value
boolean
kind
The kind of the entity.
kind: "Account"
Property Value
"Account"
ntDomain
The NetBIOS domain name as it appears in the alert format domain/username. Examples: NT AUTHORITY.
ntDomain?: string
Property Value
string
objectGuid
The objectGUID attribute is a single-value attribute that is the unique identifier for the object, assigned by active directory.
objectGuid?: string
Property Value
string
puid
The Azure Active Directory Passport User ID.
puid?: string
Property Value
string
sid
The account security identifier, e.g. S-1-5-18.
sid?: string
Property Value
string
upnSuffix
The user principal name suffix for the account, in some cases it is also the domain name. Examples: contoso.com.
upnSuffix?: string
Property Value
string
Inherited Property Details
id
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
id?: string
Property Value
string
Inherited From Entity.id
name
systemData
Azure Resource Manager metadata containing createdBy and modifiedBy information.
systemData?: SystemData
Property Value
Inherited From Entity.systemData
type
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
type?: string
Property Value
string
Inherited From Entity.type