Oracle Cloud Infrastructure v0.13.0, Mar 28 23

oci.LogAnalytics.getLogAnalyticsEntityTopology

This data source provides details about a specific Log Analytics Entity Topology resource in Oracle Cloud Infrastructure Log Analytics service.

Return a log analytics entity topology collection that contains a set of log analytics entities and a set of relationships between those, for the input source entity.

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var testLogAnalyticsEntityTopology = Oci.LogAnalytics.GetLogAnalyticsEntityTopology.Invoke(new()
    {
        LogAnalyticsEntityId = oci_log_analytics_log_analytics_entity.Test_log_analytics_entity.Id,
        Namespace = @var.Log_analytics_entity_topology_namespace,
        State = @var.Log_analytics_entity_topology_state,
    });

});

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := LogAnalytics.GetLogAnalyticsEntityTopology(ctx, &loganalytics.GetLogAnalyticsEntityTopologyArgs{
			LogAnalyticsEntityId: oci_log_analytics_log_analytics_entity.Test_log_analytics_entity.Id,
			Namespace:            _var.Log_analytics_entity_topology_namespace,
			State:                pulumi.StringRef(_var.Log_analytics_entity_topology_state),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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.GetLogAnalyticsEntityTopologyArgs;
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 testLogAnalyticsEntityTopology = LogAnalyticsFunctions.getLogAnalyticsEntityTopology(GetLogAnalyticsEntityTopologyArgs.builder()
            .logAnalyticsEntityId(oci_log_analytics_log_analytics_entity.test_log_analytics_entity().id())
            .namespace(var_.log_analytics_entity_topology_namespace())
            .state(var_.log_analytics_entity_topology_state())
            .build());

    }
}

import pulumi
import pulumi_oci as oci

test_log_analytics_entity_topology = oci.LogAnalytics.get_log_analytics_entity_topology(log_analytics_entity_id=oci_log_analytics_log_analytics_entity["test_log_analytics_entity"]["id"],
    namespace=var["log_analytics_entity_topology_namespace"],
    state=var["log_analytics_entity_topology_state"])

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

const testLogAnalyticsEntityTopology = oci.LogAnalytics.getLogAnalyticsEntityTopology({
    logAnalyticsEntityId: oci_log_analytics_log_analytics_entity.test_log_analytics_entity.id,
    namespace: _var.log_analytics_entity_topology_namespace,
    state: _var.log_analytics_entity_topology_state,
});

variables:
  testLogAnalyticsEntityTopology:
    fn::invoke:
      Function: oci:LogAnalytics:getLogAnalyticsEntityTopology
      Arguments:
        logAnalyticsEntityId: ${oci_log_analytics_log_analytics_entity.test_log_analytics_entity.id}
        namespace: ${var.log_analytics_entity_topology_namespace}
        state: ${var.log_analytics_entity_topology_state}

Using getLogAnalyticsEntityTopology

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 getLogAnalyticsEntityTopology(args: GetLogAnalyticsEntityTopologyArgs, opts?: InvokeOptions): Promise<GetLogAnalyticsEntityTopologyResult>
function getLogAnalyticsEntityTopologyOutput(args: GetLogAnalyticsEntityTopologyOutputArgs, opts?: InvokeOptions): Output<GetLogAnalyticsEntityTopologyResult>

def get_log_analytics_entity_topology(log_analytics_entity_id: Optional[str] = None,
                                      namespace: Optional[str] = None,
                                      state: Optional[str] = None,
                                      opts: Optional[InvokeOptions] = None) -> GetLogAnalyticsEntityTopologyResult
def get_log_analytics_entity_topology_output(log_analytics_entity_id: Optional[pulumi.Input[str]] = None,
                                      namespace: Optional[pulumi.Input[str]] = None,
                                      state: Optional[pulumi.Input[str]] = None,
                                      opts: Optional[InvokeOptions] = None) -> Output[GetLogAnalyticsEntityTopologyResult]

func GetLogAnalyticsEntityTopology(ctx *Context, args *GetLogAnalyticsEntityTopologyArgs, opts ...InvokeOption) (*GetLogAnalyticsEntityTopologyResult, error)
func GetLogAnalyticsEntityTopologyOutput(ctx *Context, args *GetLogAnalyticsEntityTopologyOutputArgs, opts ...InvokeOption) GetLogAnalyticsEntityTopologyResultOutput

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

public static class GetLogAnalyticsEntityTopology 
{
    public static Task<GetLogAnalyticsEntityTopologyResult> InvokeAsync(GetLogAnalyticsEntityTopologyArgs args, InvokeOptions? opts = null)
    public static Output<GetLogAnalyticsEntityTopologyResult> Invoke(GetLogAnalyticsEntityTopologyInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetLogAnalyticsEntityTopologyResult> getLogAnalyticsEntityTopology(GetLogAnalyticsEntityTopologyArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: oci:LogAnalytics/getLogAnalyticsEntityTopology:getLogAnalyticsEntityTopology
  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.
State string: A filter to return only those log analytics entities with the specified lifecycle state. The state value is case-insensitive.

LogAnalyticsEntityId string: The log analytics entity OCID.
Namespace string: The Logging Analytics namespace used for the request.
State string: A filter to return only those log analytics entities with the specified lifecycle state. The state value is case-insensitive.

logAnalyticsEntityId String: The log analytics entity OCID.
namespace String: The Logging Analytics namespace used for the request.
state String: A filter to return only those log analytics entities with the specified lifecycle state. The state value is case-insensitive.

logAnalyticsEntityId string: The log analytics entity OCID.
namespace string: The Logging Analytics namespace used for the request.
state string: A filter to return only those log analytics entities with the specified lifecycle state. The state value is case-insensitive.

log_analytics_entity_id str: The log analytics entity OCID.
namespace str: The Logging Analytics namespace used for the request.
state str: A filter to return only those log analytics entities with the specified lifecycle state. The state value is case-insensitive.

logAnalyticsEntityId String: The log analytics entity OCID.
namespace String: The Logging Analytics namespace used for the request.
state String: A filter to return only those log analytics entities with the specified lifecycle state. The state value is case-insensitive.

getLogAnalyticsEntityTopology Result

The following output properties are available:

Id string: The provider-assigned unique ID for this managed resource.
Items List<GetLogAnalyticsEntityTopologyItem>: Array of log analytics entity summary.
LogAnalyticsEntityId string
Namespace string
State string: The current state of the log analytics entity.

Id string: The provider-assigned unique ID for this managed resource.
Items []GetLogAnalyticsEntityTopologyItem: Array of log analytics entity summary.
LogAnalyticsEntityId string
Namespace string
State string: The current state of the log analytics entity.

id String: The provider-assigned unique ID for this managed resource.
items List<GetEntityTopologyItem>: Array of log analytics entity summary.
logAnalyticsEntityId String
namespace String
state String: The current state of the log analytics entity.

id string: The provider-assigned unique ID for this managed resource.
items GetLogAnalyticsEntityTopologyItem[]: Array of log analytics entity summary.
logAnalyticsEntityId string
namespace string
state string: The current state of the log analytics entity.

id str: The provider-assigned unique ID for this managed resource.
items GetLogAnalyticsEntityTopologyItem]: Array of log analytics entity summary.
log_analytics_entity_id str
namespace str
state str: The current state of the log analytics entity.

id String: The provider-assigned unique ID for this managed resource.
items List<Property Map>: Array of log analytics entity summary.
logAnalyticsEntityId String
namespace String
state String: The current state of the log analytics entity.

Supporting Types

GetLogAnalyticsEntityTopologyItem

Links List<GetLogAnalyticsEntityTopologyItemLink>: Collection of log analytics entity relationship links.
Nodes List<GetLogAnalyticsEntityTopologyItemNode>: Collection of log analytics entities.

Links []GetLogAnalyticsEntityTopologyItemLink: Collection of log analytics entity relationship links.
Nodes []GetLogAnalyticsEntityTopologyItemNode: Collection of log analytics entities.

links List<GetEntityTopologyItemLink>: Collection of log analytics entity relationship links.
nodes List<GetEntityTopologyItemNode>: Collection of log analytics entities.

links GetLogAnalyticsEntityTopologyItemLink[]: Collection of log analytics entity relationship links.
nodes GetLogAnalyticsEntityTopologyItemNode[]: Collection of log analytics entities.

links GetLogAnalyticsEntityTopologyItemLink]: Collection of log analytics entity relationship links.
nodes GetLogAnalyticsEntityTopologyItemNode]: Collection of log analytics entities.

links List<Property Map>: Collection of log analytics entity relationship links.
nodes List<Property Map>: Collection of log analytics entities.

GetLogAnalyticsEntityTopologyItemLink

Items List<GetLogAnalyticsEntityTopologyItemLinkItem>: Array of log analytics entity summary.

Items []GetLogAnalyticsEntityTopologyItemLinkItem: Array of log analytics entity summary.

items List<GetEntityTopologyItemLinkItem>: Array of log analytics entity summary.

items GetLogAnalyticsEntityTopologyItemLinkItem[]: Array of log analytics entity summary.

items GetLogAnalyticsEntityTopologyItemLinkItem]: Array of log analytics entity summary.

items List<Property Map>: Array of log analytics entity summary.

GetLogAnalyticsEntityTopologyItemLinkItem

DestinationEntityId 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.
SourceEntityId 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.

DestinationEntityId 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.
SourceEntityId 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.

destinationEntityId 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.
sourceEntityId 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.

destinationEntityId 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.
sourceEntityId 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.

destination_entity_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.
source_entity_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.

destinationEntityId 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.
sourceEntityId 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.

GetLogAnalyticsEntityTopologyItemNode

Items List<GetLogAnalyticsEntityTopologyItemNodeItem>: Array of log analytics entity summary.

Items []GetLogAnalyticsEntityTopologyItemNodeItem: Array of log analytics entity summary.

items List<GetEntityTopologyItemNodeItem>: Array of log analytics entity summary.

items GetLogAnalyticsEntityTopologyItemNodeItem[]: Array of log analytics entity summary.

items GetLogAnalyticsEntityTopologyItemNodeItem]: Array of log analytics entity summary.

items List<Property Map>: Array of log analytics entity summary.

GetLogAnalyticsEntityTopologyItemNodeItem

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, object>: 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, object>: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
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.
ManagementAgentId string: The OCID of the Management Agent.
Name string: Log analytics entity name.
SourceId string: This indicates the type of source. It is primarily for Enterprise Manager Repository ID.
State string: A filter to return only those log analytics entities with the specified lifecycle state. The state value is case-insensitive.
TimeCreated string: The date and time the resource was created, 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]interface{}: 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]interface{}: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
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.
ManagementAgentId string: The OCID of the Management Agent.
Name string: Log analytics entity name.
SourceId string: This indicates the type of source. It is primarily for Enterprise Manager Repository ID.
State string: A filter to return only those log analytics entities with the specified lifecycle state. The state value is case-insensitive.
TimeCreated string: The date and time the resource was created, 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,Object>: 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,Object>: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
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.
managementAgentId String: The OCID of the Management Agent.
name String: Log analytics entity name.
sourceId String: This indicates the type of source. It is primarily for Enterprise Manager Repository ID.
state String: A filter to return only those log analytics entities with the specified lifecycle state. The state value is case-insensitive.
timeCreated String: The date and time the resource was created, 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]: any}: 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]: any}: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
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.
managementAgentId string: The OCID of the Management Agent.
name string: Log analytics entity name.
sourceId string: This indicates the type of source. It is primarily for Enterprise Manager Repository ID.
state string: A filter to return only those log analytics entities with the specified lifecycle state. The state value is case-insensitive.
timeCreated string: The date and time the resource was created, 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, Any]: 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, Any]: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
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.
management_agent_id str: The OCID of the Management Agent.
name str: Log analytics entity name.
source_id str: This indicates the type of source. It is primarily for Enterprise Manager Repository ID.
state str: A filter to return only those log analytics entities with the specified lifecycle state. The state value is case-insensitive.
time_created str: The date and time the resource was created, 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<Any>: 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<Any>: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
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.
managementAgentId String: The OCID of the Management Agent.
name String: Log analytics entity name.
sourceId String: This indicates the type of source. It is primarily for Enterprise Manager Repository ID.
state String: A filter to return only those log analytics entities with the specified lifecycle state. The state value is case-insensitive.
timeCreated String: The date and time the resource was created, 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.

Package Details

Repository: oci pulumi/pulumi-oci
License: Apache-2.0
Notes: This Pulumi package is based on the oci Terraform Provider.