Oracle Cloud Infrastructure v2.31.0, Apr 17 25

Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi

oci.LogAnalytics.getLogAnalyticsEntity

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testLogAnalyticsEntity = oci.LogAnalytics.getLogAnalyticsEntity({
    logAnalyticsEntityId: testLogAnalyticsEntityOciLogAnalyticsLogAnalyticsEntity.id,
    namespace: logAnalyticsEntityNamespace,
});

import pulumi
import pulumi_oci as oci

test_log_analytics_entity = oci.LogAnalytics.get_log_analytics_entity(log_analytics_entity_id=test_log_analytics_entity_oci_log_analytics_log_analytics_entity["id"],
    namespace=log_analytics_entity_namespace)

package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/loganalytics"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := loganalytics.GetLogAnalyticsEntity(ctx, &loganalytics.GetLogAnalyticsEntityArgs{
			LogAnalyticsEntityId: testLogAnalyticsEntityOciLogAnalyticsLogAnalyticsEntity.Id,
			Namespace:            logAnalyticsEntityNamespace,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testLogAnalyticsEntity = Oci.LogAnalytics.GetLogAnalyticsEntity.Invoke(new()
    {
        LogAnalyticsEntityId = testLogAnalyticsEntityOciLogAnalyticsLogAnalyticsEntity.Id,
        Namespace = logAnalyticsEntityNamespace,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.LogAnalytics.LogAnalyticsFunctions;
import com.pulumi.oci.LogAnalytics.inputs.GetLogAnalyticsEntityArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var testLogAnalyticsEntity = LogAnalyticsFunctions.getLogAnalyticsEntity(GetLogAnalyticsEntityArgs.builder()
            .logAnalyticsEntityId(testLogAnalyticsEntityOciLogAnalyticsLogAnalyticsEntity.id())
            .namespace(logAnalyticsEntityNamespace)
            .build());

    }
}

variables:
  testLogAnalyticsEntity:
    fn::invoke:
      function: oci:LogAnalytics:getLogAnalyticsEntity
      arguments:
        logAnalyticsEntityId: ${testLogAnalyticsEntityOciLogAnalyticsLogAnalyticsEntity.id}
        namespace: ${logAnalyticsEntityNamespace}

Using getLogAnalyticsEntity

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getLogAnalyticsEntity(args: GetLogAnalyticsEntityArgs, opts?: InvokeOptions): Promise<GetLogAnalyticsEntityResult>
function getLogAnalyticsEntityOutput(args: GetLogAnalyticsEntityOutputArgs, opts?: InvokeOptions): Output<GetLogAnalyticsEntityResult>

def get_log_analytics_entity(log_analytics_entity_id: Optional[str] = None,
                             namespace: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetLogAnalyticsEntityResult
def get_log_analytics_entity_output(log_analytics_entity_id: Optional[pulumi.Input[str]] = None,
                             namespace: Optional[pulumi.Input[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetLogAnalyticsEntityResult]

func GetLogAnalyticsEntity(ctx *Context, args *GetLogAnalyticsEntityArgs, opts ...InvokeOption) (*GetLogAnalyticsEntityResult, error)
func GetLogAnalyticsEntityOutput(ctx *Context, args *GetLogAnalyticsEntityOutputArgs, opts ...InvokeOption) GetLogAnalyticsEntityResultOutput

> Note: This function is named GetLogAnalyticsEntity in the Go SDK.

public static class GetLogAnalyticsEntity 
{
    public static Task<GetLogAnalyticsEntityResult> InvokeAsync(GetLogAnalyticsEntityArgs args, InvokeOptions? opts = null)
    public static Output<GetLogAnalyticsEntityResult> Invoke(GetLogAnalyticsEntityInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetLogAnalyticsEntityResult> getLogAnalyticsEntity(GetLogAnalyticsEntityArgs args, InvokeOptions options)
public static Output<GetLogAnalyticsEntityResult> getLogAnalyticsEntity(GetLogAnalyticsEntityArgs args, InvokeOptions options)

fn::invoke:
  function: oci:LogAnalytics/getLogAnalyticsEntity:getLogAnalyticsEntity
  arguments:
    # arguments dictionary

The following arguments are supported:

LogAnalyticsEntityId string: The log analytics entity OCID.
Namespace string: The Logging Analytics namespace used for the request.

LogAnalyticsEntityId string: The log analytics entity OCID.
Namespace string: The Logging Analytics namespace used for the request.

logAnalyticsEntityId String: The log analytics entity OCID.
namespace String: The Logging Analytics namespace used for the request.

logAnalyticsEntityId string: The log analytics entity OCID.
namespace string: The Logging Analytics namespace used for the request.

log_analytics_entity_id str: The log analytics entity OCID.
namespace str: The Logging Analytics namespace used for the request.

logAnalyticsEntityId String: The log analytics entity OCID.
namespace String: The Logging Analytics namespace used for the request.

getLogAnalyticsEntity Result

The following output properties are available:

AreLogsCollected bool: The Boolean flag to indicate if logs are collected for an entity for log analytics usage.
CloudResourceId 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 string: Compartment Identifier [OCID] (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm).
DefinedTags Dictionary<string, string>: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
EntityTypeInternalName string: Internal name for the log analytics entity type.
EntityTypeName string: Log analytics entity type name.
FreeformTags 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 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 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 string: lifecycleDetails has additional information regarding substeps such as management agent plugin deployment.
LogAnalyticsEntityId string
ManagementAgentCompartmentId string: Management agent (management-agents resource kind) compartment OCID
ManagementAgentDisplayName string: Management agent (management-agents resource kind) display name
ManagementAgentId string: The OCID of the Management Agent.
Metadatas List<GetLogAnalyticsEntityMetadata>: Details of entity metadata information.
Name string: Log analytics entity name.
Namespace string
Properties Dictionary<string, string>: The name/value pairs for parameter values to be used in file patterns specified in log sources.
SourceId string: This indicates the type of source. It is primarily for Enterprise Manager Repository ID.
State string: The current state of the log analytics entity.
TimeCreated string: The date and time the resource was created, in the format defined by RFC3339.
TimeLastDiscovered string: The date and time the resource was last discovered, in the format defined by RFC3339.
TimeUpdated string: The date and time the resource was last updated, in the format defined by RFC3339.
TimezoneRegion string: The timezone region of the log analytics entity.

AreLogsCollected bool: The Boolean flag to indicate if logs are collected for an entity for log analytics usage.
CloudResourceId 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 string: Compartment Identifier [OCID] (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm).
DefinedTags map[string]string: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
EntityTypeInternalName string: Internal name for the log analytics entity type.
EntityTypeName string: Log analytics entity type name.
FreeformTags map[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 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 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 string: lifecycleDetails has additional information regarding substeps such as management agent plugin deployment.
LogAnalyticsEntityId string
ManagementAgentCompartmentId string: Management agent (management-agents resource kind) compartment OCID
ManagementAgentDisplayName string: Management agent (management-agents resource kind) display name
ManagementAgentId string: The OCID of the Management Agent.
Metadatas []GetLogAnalyticsEntityMetadata: Details of entity metadata information.
Name string: Log analytics entity name.
Namespace string
Properties map[string]string: The name/value pairs for parameter values to be used in file patterns specified in log sources.
SourceId string: This indicates the type of source. It is primarily for Enterprise Manager Repository ID.
State string: The current state of the log analytics entity.
TimeCreated string: The date and time the resource was created, in the format defined by RFC3339.
TimeLastDiscovered string: The date and time the resource was last discovered, in the format defined by RFC3339.
TimeUpdated string: The date and time the resource was last updated, in the format defined by RFC3339.
TimezoneRegion string: The timezone region of the log analytics entity.

areLogsCollected Boolean: The Boolean flag to indicate if logs are collected for an entity for log analytics usage.
cloudResourceId 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 String: Compartment Identifier [OCID] (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm).
definedTags Map<String,String>: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
entityTypeInternalName String: Internal name for the log analytics entity type.
entityTypeName String: Log analytics entity type name.
freeformTags Map<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 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 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 String: lifecycleDetails has additional information regarding substeps such as management agent plugin deployment.
logAnalyticsEntityId String
managementAgentCompartmentId String: Management agent (management-agents resource kind) compartment OCID
managementAgentDisplayName String: Management agent (management-agents resource kind) display name
managementAgentId String: The OCID of the Management Agent.
metadatas List<GetEntityMetadata>: Details of entity metadata information.
name String: Log analytics entity name.
namespace String
properties Map<String,String>: The name/value pairs for parameter values to be used in file patterns specified in log sources.
sourceId String: This indicates the type of source. It is primarily for Enterprise Manager Repository ID.
state String: The current state of the log analytics entity.
timeCreated String: The date and time the resource was created, in the format defined by RFC3339.
timeLastDiscovered String: The date and time the resource was last discovered, in the format defined by RFC3339.
timeUpdated String: The date and time the resource was last updated, in the format defined by RFC3339.
timezoneRegion String: The timezone region of the log analytics entity.

areLogsCollected boolean: The Boolean flag to indicate if logs are collected for an entity for log analytics usage.
cloudResourceId 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 string: Compartment Identifier [OCID] (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm).
definedTags {[key: string]: string}: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
entityTypeInternalName string: Internal name for the log analytics entity type.
entityTypeName string: Log analytics entity type name.
freeformTags {[key: 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 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 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 string: lifecycleDetails has additional information regarding substeps such as management agent plugin deployment.
logAnalyticsEntityId string
managementAgentCompartmentId string: Management agent (management-agents resource kind) compartment OCID
managementAgentDisplayName string: Management agent (management-agents resource kind) display name
managementAgentId string: The OCID of the Management Agent.
metadatas GetLogAnalyticsEntityMetadata[]: Details of entity metadata information.
name string: Log analytics entity name.
namespace string
properties {[key: string]: string}: The name/value pairs for parameter values to be used in file patterns specified in log sources.
sourceId string: This indicates the type of source. It is primarily for Enterprise Manager Repository ID.
state string: The current state of the log analytics entity.
timeCreated string: The date and time the resource was created, in the format defined by RFC3339.
timeLastDiscovered string: The date and time the resource was last discovered, in the format defined by RFC3339.
timeUpdated string: The date and time the resource was last updated, in the format defined by RFC3339.
timezoneRegion string: The timezone region of the log analytics entity.

are_logs_collected bool: The Boolean flag to indicate if logs are collected for an entity for log analytics usage.
cloud_resource_id str: 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.
compartment_id str: Compartment Identifier [OCID] (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm).
defined_tags Mapping[str, str]: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
entity_type_internal_name str: Internal name for the log analytics entity type.
entity_type_name str: Log analytics entity type name.
freeform_tags Mapping[str, str]: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
hostname str: 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 str: 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.
lifecycle_details str: lifecycleDetails has additional information regarding substeps such as management agent plugin deployment.
log_analytics_entity_id str
management_agent_compartment_id str: Management agent (management-agents resource kind) compartment OCID
management_agent_display_name str: Management agent (management-agents resource kind) display name
management_agent_id str: The OCID of the Management Agent.
metadatas Sequence[loganalytics.GetLogAnalyticsEntityMetadata]: Details of entity metadata information.
name str: Log analytics entity name.
namespace str
properties Mapping[str, str]: The name/value pairs for parameter values to be used in file patterns specified in log sources.
source_id str: This indicates the type of source. It is primarily for Enterprise Manager Repository ID.
state str: The current state of the log analytics entity.
time_created str: The date and time the resource was created, in the format defined by RFC3339.
time_last_discovered str: The date and time the resource was last discovered, in the format defined by RFC3339.
time_updated str: The date and time the resource was last updated, in the format defined by RFC3339.
timezone_region str: The timezone region of the log analytics entity.

areLogsCollected Boolean: The Boolean flag to indicate if logs are collected for an entity for log analytics usage.
cloudResourceId 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 String: Compartment Identifier [OCID] (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm).
definedTags Map<String>: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
entityTypeInternalName String: Internal name for the log analytics entity type.
entityTypeName String: Log analytics entity type name.
freeformTags Map<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 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 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 String: lifecycleDetails has additional information regarding substeps such as management agent plugin deployment.
logAnalyticsEntityId String
managementAgentCompartmentId String: Management agent (management-agents resource kind) compartment OCID
managementAgentDisplayName String: Management agent (management-agents resource kind) display name
managementAgentId String: The OCID of the Management Agent.
metadatas List<Property Map>: Details of entity metadata information.
name String: Log analytics entity name.
namespace String
properties Map<String>: The name/value pairs for parameter values to be used in file patterns specified in log sources.
sourceId String: This indicates the type of source. It is primarily for Enterprise Manager Repository ID.
state String: The current state of the log analytics entity.
timeCreated String: The date and time the resource was created, in the format defined by RFC3339.
timeLastDiscovered String: The date and time the resource was last discovered, in the format defined by RFC3339.
timeUpdated String: The date and time the resource was last updated, in the format defined by RFC3339.
timezoneRegion String: The timezone region of the log analytics entity.