Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace LogAnalyticsEntity

Description of a log analytics entity.

Properties

Optional areLogsCollected

areLogsCollected: undefined | false | true

The Boolean flag to indicate if logs are collected for an entity for log analytics usage.

Optional cloudResourceId

cloudResourceId: undefined | string

The OCID of the Cloud resource which this entity is a representation of. This may be blank when the entity represents a non-cloud resource that the customer may have on their premises.

compartmentId

compartmentId: string

Optional creationSource

creationSource: model.CreationSource

Optional definedTags

definedTags: undefined | object

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {@code {"foo-namespace": {"bar-key": "value"}}}

entityTypeInternalName

entityTypeInternalName: string

Internal name for the log analytics entity type.

entityTypeName

entityTypeName: string

Log analytics entity type name.

Optional freeformTags

freeformTags: undefined | object

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {@code {"bar-key": "value"}}

Optional hostname

hostname: undefined | string

The hostname where the entity represented here is actually present. This would be the output one would get if they run {@code echo $HOSTNAME} on Linux or an equivalent OS command. This may be different from management agents host since logs may be collected remotely.

id

id: string

The log analytics entity OCID. This ID is a reference used by log analytics features and it represents a resource that is provisioned and managed by the customer on their premises or on the cloud.

lifecycleDetails

lifecycleDetails: string

lifecycleDetails has additional information regarding substeps such as management agent plugin deployment.

lifecycleState

lifecycleState: EntityLifecycleStates

The current state of the log analytics entity.

Optional managementAgentCompartmentId

managementAgentCompartmentId: undefined | string

Management agent (management-agents resource kind) compartment OCID

Optional managementAgentDisplayName

managementAgentDisplayName: undefined | string

Management agent (management-agents resource kind) display name

Optional managementAgentId

managementAgentId: undefined | string

The OCID of the Management Agent.

Optional metadata

metadata: model.LogAnalyticsMetadataSummary

name

name: string

Log analytics entity name.

Optional properties

properties: undefined | object

The name/value pairs for parameter values to be used in file patterns specified in log sources.

Optional sourceId

sourceId: undefined | string

This indicates the type of source. It is primarily for Enterprise Manager Repository ID.

timeCreated

timeCreated: Date

The date and time the resource was created, in the format defined by RFC3339.

Optional timeLastDiscovered

timeLastDiscovered: Date

The date and time the resource was last discovered, in the format defined by RFC3339.

timeUpdated

timeUpdated: Date

The date and time the resource was last updated, in the format defined by RFC3339.

Optional timezoneRegion

timezoneRegion: undefined | string

The timezone region of the log analytics entity.

Functions

getDeserializedJsonObj

getJsonObj