AccountEntity interface
Represents an account entity.
- Extends
Properties
aad |
The Azure Active Directory tenant id. NOTE: This property will not be serialized. It can only be populated by the server. |
aad |
The Azure Active Directory user id. NOTE: This property will not be serialized. It can only be populated by the server. |
account |
The name of the account. This field should hold only the name without any domain added to it, i.e. administrator. NOTE: This property will not be serialized. It can only be populated by the server. |
additional |
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. |
display |
The display name of the account. NOTE: This property will not be serialized. It can only be populated by the server. |
dns |
The fully qualified domain DNS name. NOTE: This property will not be serialized. It can only be populated by the server. |
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. NOTE: This property will not be serialized. It can only be populated by the server. |
host |
The Host entity id that contains the account in case it is a local account (not domain joined) NOTE: This property will not be serialized. It can only be populated by the server. |
is |
Determines whether this is a domain account. 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 |
nt |
The NetBIOS domain name as it appears in the alert format domain/username. Examples: NT AUTHORITY. NOTE: This property will not be serialized. It can only be populated by the server. |
object |
The objectGUID attribute is a single-value attribute that is the unique identifier for the object, assigned by active directory. NOTE: This property will not be serialized. It can only be populated by the server. |
puid | The Azure Active Directory Passport User ID. NOTE: This property will not be serialized. It can only be populated by the server. |
sid | The account security identifier, e.g. S-1-5-18. NOTE: This property will not be serialized. It can only be populated by the server. |
upn |
The user principal name suffix for the account, in some cases it is also the domain name. Examples: contoso.com. 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. |
system |
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
aadTenantId
The Azure Active Directory tenant id. NOTE: This property will not be serialized. It can only be populated by the server.
aadTenantId?: string
Property Value
string
aadUserId
The Azure Active Directory user id. NOTE: This property will not be serialized. It can only be populated by the server.
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. NOTE: This property will not be serialized. It can only be populated by the server.
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. 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 display name of the account. NOTE: This property will not be serialized. It can only be populated by the server.
displayName?: string
Property Value
string
dnsDomain
The fully qualified domain DNS name. NOTE: This property will not be serialized. It can only be populated by the server.
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. NOTE: This property will not be serialized. It can only be populated by the server.
friendlyName?: string
Property Value
string
hostEntityId
The Host entity id that contains the account in case it is a local account (not domain joined) NOTE: This property will not be serialized. It can only be populated by the server.
hostEntityId?: string
Property Value
string
isDomainJoined
Determines whether this is a domain account. NOTE: This property will not be serialized. It can only be populated by the server.
isDomainJoined?: boolean
Property Value
boolean
kind
Polymorphic discriminator, which specifies the different types this object can be
kind: "Account"
Property Value
"Account"
ntDomain
The NetBIOS domain name as it appears in the alert format domain/username. Examples: NT AUTHORITY. NOTE: This property will not be serialized. It can only be populated by the server.
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. NOTE: This property will not be serialized. It can only be populated by the server.
objectGuid?: string
Property Value
string
puid
The Azure Active Directory Passport User ID. NOTE: This property will not be serialized. It can only be populated by the server.
puid?: string
Property Value
string
sid
The account security identifier, e.g. S-1-5-18. NOTE: This property will not be serialized. It can only be populated by the server.
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. NOTE: This property will not be serialized. It can only be populated by the server.
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} 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
Azure SDK for JavaScript