FileEntity interface
Represents a file entity.
- Extends
Properties
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. |
directory | The full path to the file. NOTE: This property will not be serialized. It can only be populated by the server. |
file |
The file hash entity identifiers associated with this file NOTE: This property will not be serialized. It can only be populated by the server. |
file |
The file name without path (some alerts might not include path). 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 which the file belongs to 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 |
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
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>}
directory
The full path to the file. NOTE: This property will not be serialized. It can only be populated by the server.
directory?: string
Property Value
string
fileHashEntityIds
The file hash entity identifiers associated with this file NOTE: This property will not be serialized. It can only be populated by the server.
fileHashEntityIds?: string[]
Property Value
string[]
fileName
The file name without path (some alerts might not include path). NOTE: This property will not be serialized. It can only be populated by the server.
fileName?: 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 which the file belongs to NOTE: This property will not be serialized. It can only be populated by the server.
hostEntityId?: string
Property Value
string
kind
Polymorphic discriminator, which specifies the different types this object can be
kind: "File"
Property Value
"File"
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