Class LogAnalyticsEntity

Description of a log analytics entity.

Inheritance

object

LogAnalyticsEntity

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.LoganalyticsService.Models

Assembly: OCI.DotNetSDK.Loganalytics.dll

Syntax

public class LogAnalyticsEntity

Properties

AreLogsCollected

Declaration

[JsonProperty(PropertyName = "areLogsCollected")]
public bool? AreLogsCollected { get; set; }

Property Value

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

AssociatedSourcesCount

Declaration

[JsonProperty(PropertyName = "associatedSourcesCount")]
public int? AssociatedSourcesCount { get; set; }

Property Value

Type	Description
int?	The count of associated log sources for a given log analytics entity.

CloudResourceId

Declaration

[JsonProperty(PropertyName = "cloudResourceId")]
public string CloudResourceId { get; set; }

Property Value

Type	Description
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

Declaration

[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }

Property Value

Type	Description
string	Compartment Identifier [OCID] (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm).

Remarks

Required

CreationSource

Declaration

[JsonProperty(PropertyName = "creationSource")]
public CreationSource CreationSource { get; set; }

Property Value

Type	Description
CreationSource

DefinedTags

Declaration

[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }

Property Value

Type	Description
Dictionary<string, Dictionary<string, object>>	Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}}

EntityTypeInternalName

Declaration

[Required(ErrorMessage = "EntityTypeInternalName is required.")]
[JsonProperty(PropertyName = "entityTypeInternalName")]
public string EntityTypeInternalName { get; set; }

Property Value

Type	Description
string	Internal name for the log analytics entity type.

Remarks

Required

EntityTypeName

Declaration

[Required(ErrorMessage = "EntityTypeName is required.")]
[JsonProperty(PropertyName = "entityTypeName")]
public string EntityTypeName { get; set; }

Property Value

Type	Description
string	Log analytics entity type name.

Remarks

Required

FreeformTags

Declaration

[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }

Property Value

Type	Description
Dictionary<string, string>	Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

Hostname

Declaration

[JsonProperty(PropertyName = "hostname")]
public string Hostname { get; set; }

Property Value

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

Id

Declaration

[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }

Property Value

Type	Description
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.

Remarks

Required

LifecycleDetails

Declaration

[Required(ErrorMessage = "LifecycleDetails is required.")]
[JsonProperty(PropertyName = "lifecycleDetails")]
public string LifecycleDetails { get; set; }

Property Value

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

Remarks

Required

LifecycleState

Declaration

[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public EntityLifecycleStates? LifecycleState { get; set; }

Property Value

Type	Description
EntityLifecycleStates?	The current state of the log analytics entity.

Remarks

Required

ManagementAgentCompartmentId

Declaration

[JsonProperty(PropertyName = "managementAgentCompartmentId")]
public string ManagementAgentCompartmentId { get; set; }

Property Value

Type	Description
string	Management agent (management-agents resource kind) compartment OCID

ManagementAgentDisplayName

Declaration

[JsonProperty(PropertyName = "managementAgentDisplayName")]
public string ManagementAgentDisplayName { get; set; }

Property Value

Type	Description
string	Management agent (management-agents resource kind) display name

ManagementAgentId

Declaration

[JsonProperty(PropertyName = "managementAgentId")]
public string ManagementAgentId { get; set; }

Property Value

Type	Description
string	The OCID of the Management Agent.

Metadata

Declaration

[JsonProperty(PropertyName = "metadata")]
public LogAnalyticsMetadataSummary Metadata { get; set; }

Property Value

Type	Description
LogAnalyticsMetadataSummary

Name

Declaration

[Required(ErrorMessage = "Name is required.")]
[JsonProperty(PropertyName = "name")]
public string Name { get; set; }

Property Value

Type	Description
string	Log analytics entity name.

Remarks

Required

Properties

Declaration

[JsonProperty(PropertyName = "properties")]
public Dictionary<string, string> Properties { get; set; }

Property Value

Type	Description
Dictionary<string, string>	The name/value pairs for parameter values to be used in file patterns specified in log sources.

SourceId

Declaration

[JsonProperty(PropertyName = "sourceId")]
public string SourceId { get; set; }

Property Value

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

TimeCreated

Declaration

[Required(ErrorMessage = "TimeCreated is required.")]
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }

Property Value

Type	Description
DateTime?	The date and time the resource was created, in the format defined by RFC3339.

Remarks

Required

TimeLastDiscovered

Declaration

[JsonProperty(PropertyName = "timeLastDiscovered")]
public DateTime? TimeLastDiscovered { get; set; }

Property Value

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

TimeUpdated

Declaration

[Required(ErrorMessage = "TimeUpdated is required.")]
[JsonProperty(PropertyName = "timeUpdated")]
public DateTime? TimeUpdated { get; set; }

Property Value

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

Remarks

Required

TimezoneRegion

Declaration

[JsonProperty(PropertyName = "timezoneRegion")]
public string TimezoneRegion { get; set; }

Property Value

Type	Description
string	The timezone region of the log analytics entity.