oci.LogAnalytics.LogAnalyticsEntity
Explore with Pulumi AI
This resource provides the Log Analytics Entity resource in Oracle Cloud Infrastructure Log Analytics service.
Create a new log analytics entity.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testLogAnalyticsEntity = new oci.loganalytics.LogAnalyticsEntity("test_log_analytics_entity", {
    compartmentId: compartmentId,
    entityTypeName: logAnalyticsEntityEntityTypeName,
    name: logAnalyticsEntityName,
    namespace: logAnalyticsEntityNamespace,
    cloudResourceId: testCloudResource.id,
    definedTags: {
        "foo-namespace.bar-key": "value",
    },
    freeformTags: {
        "bar-key": "value",
    },
    hostname: logAnalyticsEntityHostname,
    managementAgentId: testManagementAgent.id,
    metadata: {
        items: [{
            name: logAnalyticsEntityMetadataItemsName,
            type: logAnalyticsEntityMetadataItemsType,
            value: logAnalyticsEntityMetadataItemsValue,
        }],
    },
    properties: logAnalyticsEntityProperties,
    sourceId: testSource.id,
    timeLastDiscovered: logAnalyticsEntityTimeLastDiscovered,
    timezoneRegion: logAnalyticsEntityTimezoneRegion,
});
import pulumi
import pulumi_oci as oci
test_log_analytics_entity = oci.log_analytics.LogAnalyticsEntity("test_log_analytics_entity",
    compartment_id=compartment_id,
    entity_type_name=log_analytics_entity_entity_type_name,
    name=log_analytics_entity_name,
    namespace=log_analytics_entity_namespace,
    cloud_resource_id=test_cloud_resource["id"],
    defined_tags={
        "foo-namespace.bar-key": "value",
    },
    freeform_tags={
        "bar-key": "value",
    },
    hostname=log_analytics_entity_hostname,
    management_agent_id=test_management_agent["id"],
    metadata={
        "items": [{
            "name": log_analytics_entity_metadata_items_name,
            "type": log_analytics_entity_metadata_items_type,
            "value": log_analytics_entity_metadata_items_value,
        }],
    },
    properties=log_analytics_entity_properties,
    source_id=test_source["id"],
    time_last_discovered=log_analytics_entity_time_last_discovered,
    timezone_region=log_analytics_entity_timezone_region)
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.NewLogAnalyticsEntity(ctx, "test_log_analytics_entity", &loganalytics.LogAnalyticsEntityArgs{
			CompartmentId:   pulumi.Any(compartmentId),
			EntityTypeName:  pulumi.Any(logAnalyticsEntityEntityTypeName),
			Name:            pulumi.Any(logAnalyticsEntityName),
			Namespace:       pulumi.Any(logAnalyticsEntityNamespace),
			CloudResourceId: pulumi.Any(testCloudResource.Id),
			DefinedTags: pulumi.StringMap{
				"foo-namespace.bar-key": pulumi.String("value"),
			},
			FreeformTags: pulumi.StringMap{
				"bar-key": pulumi.String("value"),
			},
			Hostname:          pulumi.Any(logAnalyticsEntityHostname),
			ManagementAgentId: pulumi.Any(testManagementAgent.Id),
			Metadata: &loganalytics.LogAnalyticsEntityMetadataArgs{
				Items: loganalytics.LogAnalyticsEntityMetadataItemArray{
					&loganalytics.LogAnalyticsEntityMetadataItemArgs{
						Name:  pulumi.Any(logAnalyticsEntityMetadataItemsName),
						Type:  pulumi.Any(logAnalyticsEntityMetadataItemsType),
						Value: pulumi.Any(logAnalyticsEntityMetadataItemsValue),
					},
				},
			},
			Properties:         pulumi.Any(logAnalyticsEntityProperties),
			SourceId:           pulumi.Any(testSource.Id),
			TimeLastDiscovered: pulumi.Any(logAnalyticsEntityTimeLastDiscovered),
			TimezoneRegion:     pulumi.Any(logAnalyticsEntityTimezoneRegion),
		})
		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 = new Oci.LogAnalytics.LogAnalyticsEntity("test_log_analytics_entity", new()
    {
        CompartmentId = compartmentId,
        EntityTypeName = logAnalyticsEntityEntityTypeName,
        Name = logAnalyticsEntityName,
        Namespace = logAnalyticsEntityNamespace,
        CloudResourceId = testCloudResource.Id,
        DefinedTags = 
        {
            { "foo-namespace.bar-key", "value" },
        },
        FreeformTags = 
        {
            { "bar-key", "value" },
        },
        Hostname = logAnalyticsEntityHostname,
        ManagementAgentId = testManagementAgent.Id,
        Metadata = new Oci.LogAnalytics.Inputs.LogAnalyticsEntityMetadataArgs
        {
            Items = new[]
            {
                new Oci.LogAnalytics.Inputs.LogAnalyticsEntityMetadataItemArgs
                {
                    Name = logAnalyticsEntityMetadataItemsName,
                    Type = logAnalyticsEntityMetadataItemsType,
                    Value = logAnalyticsEntityMetadataItemsValue,
                },
            },
        },
        Properties = logAnalyticsEntityProperties,
        SourceId = testSource.Id,
        TimeLastDiscovered = logAnalyticsEntityTimeLastDiscovered,
        TimezoneRegion = logAnalyticsEntityTimezoneRegion,
    });
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.LogAnalytics.LogAnalyticsEntity;
import com.pulumi.oci.LogAnalytics.LogAnalyticsEntityArgs;
import com.pulumi.oci.LogAnalytics.inputs.LogAnalyticsEntityMetadataArgs;
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) {
        var testLogAnalyticsEntity = new LogAnalyticsEntity("testLogAnalyticsEntity", LogAnalyticsEntityArgs.builder()
            .compartmentId(compartmentId)
            .entityTypeName(logAnalyticsEntityEntityTypeName)
            .name(logAnalyticsEntityName)
            .namespace(logAnalyticsEntityNamespace)
            .cloudResourceId(testCloudResource.id())
            .definedTags(Map.of("foo-namespace.bar-key", "value"))
            .freeformTags(Map.of("bar-key", "value"))
            .hostname(logAnalyticsEntityHostname)
            .managementAgentId(testManagementAgent.id())
            .metadata(LogAnalyticsEntityMetadataArgs.builder()
                .items(LogAnalyticsEntityMetadataItemArgs.builder()
                    .name(logAnalyticsEntityMetadataItemsName)
                    .type(logAnalyticsEntityMetadataItemsType)
                    .value(logAnalyticsEntityMetadataItemsValue)
                    .build())
                .build())
            .properties(logAnalyticsEntityProperties)
            .sourceId(testSource.id())
            .timeLastDiscovered(logAnalyticsEntityTimeLastDiscovered)
            .timezoneRegion(logAnalyticsEntityTimezoneRegion)
            .build());
    }
}
resources:
  testLogAnalyticsEntity:
    type: oci:LogAnalytics:LogAnalyticsEntity
    name: test_log_analytics_entity
    properties:
      compartmentId: ${compartmentId}
      entityTypeName: ${logAnalyticsEntityEntityTypeName}
      name: ${logAnalyticsEntityName}
      namespace: ${logAnalyticsEntityNamespace}
      cloudResourceId: ${testCloudResource.id}
      definedTags:
        foo-namespace.bar-key: value
      freeformTags:
        bar-key: value
      hostname: ${logAnalyticsEntityHostname}
      managementAgentId: ${testManagementAgent.id}
      metadata:
        items:
          - name: ${logAnalyticsEntityMetadataItemsName}
            type: ${logAnalyticsEntityMetadataItemsType}
            value: ${logAnalyticsEntityMetadataItemsValue}
      properties: ${logAnalyticsEntityProperties}
      sourceId: ${testSource.id}
      timeLastDiscovered: ${logAnalyticsEntityTimeLastDiscovered}
      timezoneRegion: ${logAnalyticsEntityTimezoneRegion}
Create LogAnalyticsEntity Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new LogAnalyticsEntity(name: string, args: LogAnalyticsEntityArgs, opts?: CustomResourceOptions);@overload
def LogAnalyticsEntity(resource_name: str,
                       args: LogAnalyticsEntityArgs,
                       opts: Optional[ResourceOptions] = None)
@overload
def LogAnalyticsEntity(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       namespace: Optional[str] = None,
                       entity_type_name: Optional[str] = None,
                       compartment_id: Optional[str] = None,
                       time_last_discovered: Optional[str] = None,
                       freeform_tags: Optional[Mapping[str, str]] = None,
                       hostname: Optional[str] = None,
                       name: Optional[str] = None,
                       management_agent_id: Optional[str] = None,
                       defined_tags: Optional[Mapping[str, str]] = None,
                       cloud_resource_id: Optional[str] = None,
                       properties: Optional[Mapping[str, str]] = None,
                       source_id: Optional[str] = None,
                       metadata: Optional[_loganalytics.LogAnalyticsEntityMetadataArgs] = None,
                       timezone_region: Optional[str] = None)func NewLogAnalyticsEntity(ctx *Context, name string, args LogAnalyticsEntityArgs, opts ...ResourceOption) (*LogAnalyticsEntity, error)public LogAnalyticsEntity(string name, LogAnalyticsEntityArgs args, CustomResourceOptions? opts = null)
public LogAnalyticsEntity(String name, LogAnalyticsEntityArgs args)
public LogAnalyticsEntity(String name, LogAnalyticsEntityArgs args, CustomResourceOptions options)
type: oci:LogAnalytics:LogAnalyticsEntity
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args LogAnalyticsEntityArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args LogAnalyticsEntityArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args LogAnalyticsEntityArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args LogAnalyticsEntityArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args LogAnalyticsEntityArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var logAnalyticsEntityResource = new Oci.LogAnalytics.LogAnalyticsEntity("logAnalyticsEntityResource", new()
{
    Namespace = "string",
    EntityTypeName = "string",
    CompartmentId = "string",
    TimeLastDiscovered = "string",
    FreeformTags = 
    {
        { "string", "string" },
    },
    Hostname = "string",
    Name = "string",
    ManagementAgentId = "string",
    DefinedTags = 
    {
        { "string", "string" },
    },
    CloudResourceId = "string",
    Properties = 
    {
        { "string", "string" },
    },
    SourceId = "string",
    Metadata = new Oci.LogAnalytics.Inputs.LogAnalyticsEntityMetadataArgs
    {
        Items = new[]
        {
            new Oci.LogAnalytics.Inputs.LogAnalyticsEntityMetadataItemArgs
            {
                Name = "string",
                Type = "string",
                Value = "string",
            },
        },
    },
    TimezoneRegion = "string",
});
example, err := LogAnalytics.NewLogAnalyticsEntity(ctx, "logAnalyticsEntityResource", &LogAnalytics.LogAnalyticsEntityArgs{
	Namespace:          pulumi.String("string"),
	EntityTypeName:     pulumi.String("string"),
	CompartmentId:      pulumi.String("string"),
	TimeLastDiscovered: pulumi.String("string"),
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Hostname:          pulumi.String("string"),
	Name:              pulumi.String("string"),
	ManagementAgentId: pulumi.String("string"),
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	CloudResourceId: pulumi.String("string"),
	Properties: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	SourceId: pulumi.String("string"),
	Metadata: &loganalytics.LogAnalyticsEntityMetadataArgs{
		Items: loganalytics.LogAnalyticsEntityMetadataItemArray{
			&loganalytics.LogAnalyticsEntityMetadataItemArgs{
				Name:  pulumi.String("string"),
				Type:  pulumi.String("string"),
				Value: pulumi.String("string"),
			},
		},
	},
	TimezoneRegion: pulumi.String("string"),
})
var logAnalyticsEntityResource = new LogAnalyticsEntity("logAnalyticsEntityResource", LogAnalyticsEntityArgs.builder()
    .namespace("string")
    .entityTypeName("string")
    .compartmentId("string")
    .timeLastDiscovered("string")
    .freeformTags(Map.of("string", "string"))
    .hostname("string")
    .name("string")
    .managementAgentId("string")
    .definedTags(Map.of("string", "string"))
    .cloudResourceId("string")
    .properties(Map.of("string", "string"))
    .sourceId("string")
    .metadata(LogAnalyticsEntityMetadataArgs.builder()
        .items(LogAnalyticsEntityMetadataItemArgs.builder()
            .name("string")
            .type("string")
            .value("string")
            .build())
        .build())
    .timezoneRegion("string")
    .build());
log_analytics_entity_resource = oci.log_analytics.LogAnalyticsEntity("logAnalyticsEntityResource",
    namespace="string",
    entity_type_name="string",
    compartment_id="string",
    time_last_discovered="string",
    freeform_tags={
        "string": "string",
    },
    hostname="string",
    name="string",
    management_agent_id="string",
    defined_tags={
        "string": "string",
    },
    cloud_resource_id="string",
    properties={
        "string": "string",
    },
    source_id="string",
    metadata={
        "items": [{
            "name": "string",
            "type": "string",
            "value": "string",
        }],
    },
    timezone_region="string")
const logAnalyticsEntityResource = new oci.loganalytics.LogAnalyticsEntity("logAnalyticsEntityResource", {
    namespace: "string",
    entityTypeName: "string",
    compartmentId: "string",
    timeLastDiscovered: "string",
    freeformTags: {
        string: "string",
    },
    hostname: "string",
    name: "string",
    managementAgentId: "string",
    definedTags: {
        string: "string",
    },
    cloudResourceId: "string",
    properties: {
        string: "string",
    },
    sourceId: "string",
    metadata: {
        items: [{
            name: "string",
            type: "string",
            value: "string",
        }],
    },
    timezoneRegion: "string",
});
type: oci:LogAnalytics:LogAnalyticsEntity
properties:
    cloudResourceId: string
    compartmentId: string
    definedTags:
        string: string
    entityTypeName: string
    freeformTags:
        string: string
    hostname: string
    managementAgentId: string
    metadata:
        items:
            - name: string
              type: string
              value: string
    name: string
    namespace: string
    properties:
        string: string
    sourceId: string
    timeLastDiscovered: string
    timezoneRegion: string
LogAnalyticsEntity Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The LogAnalyticsEntity resource accepts the following input properties:
- CompartmentId string
- (Updatable) Compartment Identifier [OCID] (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm).
- EntityType stringName 
- Log analytics entity type name.
- Namespace string
- The Logging Analytics namespace used for the request.
- CloudResource stringId 
- 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.
- Dictionary<string, string>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- Dictionary<string, string>
- (Updatable) 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
- (Updatable) The hostname where the entity represented here is actually present. This would be the output one would get if they run echo $HOSTNAMEon Linux or an equivalent OS command. This may be different from management agents host since logs may be collected remotely.
- ManagementAgent stringId 
- (Updatable) The OCID of the Management Agent.
- Metadata
LogAnalytics Entity Metadata 
- (Updatable) Details of Entity Metadata.
- Name string
- (Updatable) Log analytics entity name.
- Properties Dictionary<string, string>
- (Updatable) 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.
- TimeLast stringDiscovered 
- (Updatable) The date and time the resource was last discovered, in the format defined by RFC3339.
- TimezoneRegion string
- (Updatable) The timezone region of the log analytics entity. - ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values 
- CompartmentId string
- (Updatable) Compartment Identifier [OCID] (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm).
- EntityType stringName 
- Log analytics entity type name.
- Namespace string
- The Logging Analytics namespace used for the request.
- CloudResource stringId 
- 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.
- map[string]string
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- map[string]string
- (Updatable) 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
- (Updatable) The hostname where the entity represented here is actually present. This would be the output one would get if they run echo $HOSTNAMEon Linux or an equivalent OS command. This may be different from management agents host since logs may be collected remotely.
- ManagementAgent stringId 
- (Updatable) The OCID of the Management Agent.
- Metadata
LogAnalytics Entity Metadata Args 
- (Updatable) Details of Entity Metadata.
- Name string
- (Updatable) Log analytics entity name.
- Properties map[string]string
- (Updatable) 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.
- TimeLast stringDiscovered 
- (Updatable) The date and time the resource was last discovered, in the format defined by RFC3339.
- TimezoneRegion string
- (Updatable) The timezone region of the log analytics entity. - ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values 
- compartmentId String
- (Updatable) Compartment Identifier [OCID] (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm).
- entityType StringName 
- Log analytics entity type name.
- namespace String
- The Logging Analytics namespace used for the request.
- cloudResource StringId 
- 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.
- Map<String,String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- Map<String,String>
- (Updatable) 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
- (Updatable) The hostname where the entity represented here is actually present. This would be the output one would get if they run echo $HOSTNAMEon Linux or an equivalent OS command. This may be different from management agents host since logs may be collected remotely.
- managementAgent StringId 
- (Updatable) The OCID of the Management Agent.
- metadata
EntityMetadata 
- (Updatable) Details of Entity Metadata.
- name String
- (Updatable) Log analytics entity name.
- properties Map<String,String>
- (Updatable) 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.
- timeLast StringDiscovered 
- (Updatable) The date and time the resource was last discovered, in the format defined by RFC3339.
- timezoneRegion String
- (Updatable) The timezone region of the log analytics entity. - ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values 
- compartmentId string
- (Updatable) Compartment Identifier [OCID] (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm).
- entityType stringName 
- Log analytics entity type name.
- namespace string
- The Logging Analytics namespace used for the request.
- cloudResource stringId 
- 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.
- {[key: string]: string}
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- {[key: string]: string}
- (Updatable) 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
- (Updatable) The hostname where the entity represented here is actually present. This would be the output one would get if they run echo $HOSTNAMEon Linux or an equivalent OS command. This may be different from management agents host since logs may be collected remotely.
- managementAgent stringId 
- (Updatable) The OCID of the Management Agent.
- metadata
LogAnalytics Entity Metadata 
- (Updatable) Details of Entity Metadata.
- name string
- (Updatable) Log analytics entity name.
- properties {[key: string]: string}
- (Updatable) 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.
- timeLast stringDiscovered 
- (Updatable) The date and time the resource was last discovered, in the format defined by RFC3339.
- timezoneRegion string
- (Updatable) The timezone region of the log analytics entity. - ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values 
- compartment_id str
- (Updatable) Compartment Identifier [OCID] (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm).
- entity_type_ strname 
- Log analytics entity type name.
- namespace str
- The Logging Analytics namespace used for the request.
- cloud_resource_ strid 
- 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.
- Mapping[str, str]
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- Mapping[str, str]
- (Updatable) 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
- (Updatable) The hostname where the entity represented here is actually present. This would be the output one would get if they run echo $HOSTNAMEon Linux or an equivalent OS command. This may be different from management agents host since logs may be collected remotely.
- management_agent_ strid 
- (Updatable) The OCID of the Management Agent.
- metadata
loganalytics.Log Analytics Entity Metadata Args 
- (Updatable) Details of Entity Metadata.
- name str
- (Updatable) Log analytics entity name.
- properties Mapping[str, str]
- (Updatable) 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.
- time_last_ strdiscovered 
- (Updatable) The date and time the resource was last discovered, in the format defined by RFC3339.
- timezone_region str
- (Updatable) The timezone region of the log analytics entity. - ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values 
- compartmentId String
- (Updatable) Compartment Identifier [OCID] (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm).
- entityType StringName 
- Log analytics entity type name.
- namespace String
- The Logging Analytics namespace used for the request.
- cloudResource StringId 
- 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.
- Map<String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- Map<String>
- (Updatable) 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
- (Updatable) The hostname where the entity represented here is actually present. This would be the output one would get if they run echo $HOSTNAMEon Linux or an equivalent OS command. This may be different from management agents host since logs may be collected remotely.
- managementAgent StringId 
- (Updatable) The OCID of the Management Agent.
- metadata Property Map
- (Updatable) Details of Entity Metadata.
- name String
- (Updatable) Log analytics entity name.
- properties Map<String>
- (Updatable) 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.
- timeLast StringDiscovered 
- (Updatable) The date and time the resource was last discovered, in the format defined by RFC3339.
- timezoneRegion String
- (Updatable) The timezone region of the log analytics entity. - ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values 
Outputs
All input properties are implicitly available as output properties. Additionally, the LogAnalyticsEntity resource produces the following output properties:
- AreLogs boolCollected 
- The Boolean flag to indicate if logs are collected for an entity for log analytics usage.
- EntityType stringInternal Name 
- Internal name for the log analytics entity type.
- Id string
- The provider-assigned unique ID for this managed resource.
- LifecycleDetails string
- lifecycleDetails has additional information regarding substeps such as management agent plugin deployment.
- ManagementAgent stringCompartment Id 
- Management agent (management-agents resource kind) compartment OCID
- ManagementAgent stringDisplay Name 
- Management agent (management-agents resource kind) display name
- 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.
- TimeUpdated string
- The date and time the resource was last updated, in the format defined by RFC3339.
- AreLogs boolCollected 
- The Boolean flag to indicate if logs are collected for an entity for log analytics usage.
- EntityType stringInternal Name 
- Internal name for the log analytics entity type.
- Id string
- The provider-assigned unique ID for this managed resource.
- LifecycleDetails string
- lifecycleDetails has additional information regarding substeps such as management agent plugin deployment.
- ManagementAgent stringCompartment Id 
- Management agent (management-agents resource kind) compartment OCID
- ManagementAgent stringDisplay Name 
- Management agent (management-agents resource kind) display name
- 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.
- TimeUpdated string
- The date and time the resource was last updated, in the format defined by RFC3339.
- areLogs BooleanCollected 
- The Boolean flag to indicate if logs are collected for an entity for log analytics usage.
- entityType StringInternal Name 
- Internal name for the log analytics entity type.
- id String
- The provider-assigned unique ID for this managed resource.
- lifecycleDetails String
- lifecycleDetails has additional information regarding substeps such as management agent plugin deployment.
- managementAgent StringCompartment Id 
- Management agent (management-agents resource kind) compartment OCID
- managementAgent StringDisplay Name 
- Management agent (management-agents resource kind) display name
- 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.
- timeUpdated String
- The date and time the resource was last updated, in the format defined by RFC3339.
- areLogs booleanCollected 
- The Boolean flag to indicate if logs are collected for an entity for log analytics usage.
- entityType stringInternal Name 
- Internal name for the log analytics entity type.
- id string
- The provider-assigned unique ID for this managed resource.
- lifecycleDetails string
- lifecycleDetails has additional information regarding substeps such as management agent plugin deployment.
- managementAgent stringCompartment Id 
- Management agent (management-agents resource kind) compartment OCID
- managementAgent stringDisplay Name 
- Management agent (management-agents resource kind) display name
- 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.
- timeUpdated string
- The date and time the resource was last updated, in the format defined by RFC3339.
- are_logs_ boolcollected 
- The Boolean flag to indicate if logs are collected for an entity for log analytics usage.
- entity_type_ strinternal_ name 
- Internal name for the log analytics entity type.
- id str
- The provider-assigned unique ID for this managed resource.
- lifecycle_details str
- lifecycleDetails has additional information regarding substeps such as management agent plugin deployment.
- management_agent_ strcompartment_ id 
- Management agent (management-agents resource kind) compartment OCID
- management_agent_ strdisplay_ name 
- Management agent (management-agents resource kind) display name
- 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_updated str
- The date and time the resource was last updated, in the format defined by RFC3339.
- areLogs BooleanCollected 
- The Boolean flag to indicate if logs are collected for an entity for log analytics usage.
- entityType StringInternal Name 
- Internal name for the log analytics entity type.
- id String
- The provider-assigned unique ID for this managed resource.
- lifecycleDetails String
- lifecycleDetails has additional information regarding substeps such as management agent plugin deployment.
- managementAgent StringCompartment Id 
- Management agent (management-agents resource kind) compartment OCID
- managementAgent StringDisplay Name 
- Management agent (management-agents resource kind) display name
- 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.
- timeUpdated String
- The date and time the resource was last updated, in the format defined by RFC3339.
Look up Existing LogAnalyticsEntity Resource
Get an existing LogAnalyticsEntity resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: LogAnalyticsEntityState, opts?: CustomResourceOptions): LogAnalyticsEntity@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        are_logs_collected: Optional[bool] = None,
        cloud_resource_id: Optional[str] = None,
        compartment_id: Optional[str] = None,
        defined_tags: Optional[Mapping[str, str]] = None,
        entity_type_internal_name: Optional[str] = None,
        entity_type_name: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, str]] = None,
        hostname: Optional[str] = None,
        lifecycle_details: Optional[str] = None,
        management_agent_compartment_id: Optional[str] = None,
        management_agent_display_name: Optional[str] = None,
        management_agent_id: Optional[str] = None,
        metadata: Optional[_loganalytics.LogAnalyticsEntityMetadataArgs] = None,
        name: Optional[str] = None,
        namespace: Optional[str] = None,
        properties: Optional[Mapping[str, str]] = None,
        source_id: Optional[str] = None,
        state: Optional[str] = None,
        time_created: Optional[str] = None,
        time_last_discovered: Optional[str] = None,
        time_updated: Optional[str] = None,
        timezone_region: Optional[str] = None) -> LogAnalyticsEntityfunc GetLogAnalyticsEntity(ctx *Context, name string, id IDInput, state *LogAnalyticsEntityState, opts ...ResourceOption) (*LogAnalyticsEntity, error)public static LogAnalyticsEntity Get(string name, Input<string> id, LogAnalyticsEntityState? state, CustomResourceOptions? opts = null)public static LogAnalyticsEntity get(String name, Output<String> id, LogAnalyticsEntityState state, CustomResourceOptions options)resources:  _:    type: oci:LogAnalytics:LogAnalyticsEntity    get:      id: ${id}- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- AreLogs boolCollected 
- The Boolean flag to indicate if logs are collected for an entity for log analytics usage.
- CloudResource stringId 
- 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
- (Updatable) Compartment Identifier [OCID] (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm).
- Dictionary<string, string>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- EntityType stringInternal Name 
- Internal name for the log analytics entity type.
- EntityType stringName 
- Log analytics entity type name.
- Dictionary<string, string>
- (Updatable) 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
- (Updatable) The hostname where the entity represented here is actually present. This would be the output one would get if they run echo $HOSTNAMEon Linux or an equivalent OS command. This may be different from management agents host since logs may be collected remotely.
- LifecycleDetails string
- lifecycleDetails has additional information regarding substeps such as management agent plugin deployment.
- ManagementAgent stringCompartment Id 
- Management agent (management-agents resource kind) compartment OCID
- ManagementAgent stringDisplay Name 
- Management agent (management-agents resource kind) display name
- ManagementAgent stringId 
- (Updatable) The OCID of the Management Agent.
- Metadata
LogAnalytics Entity Metadata 
- (Updatable) Details of Entity Metadata.
- Name string
- (Updatable) Log analytics entity name.
- Namespace string
- The Logging Analytics namespace used for the request.
- Properties Dictionary<string, string>
- (Updatable) 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.
- TimeLast stringDiscovered 
- (Updatable) 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
- (Updatable) The timezone region of the log analytics entity. - ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values 
- AreLogs boolCollected 
- The Boolean flag to indicate if logs are collected for an entity for log analytics usage.
- CloudResource stringId 
- 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
- (Updatable) Compartment Identifier [OCID] (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm).
- map[string]string
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- EntityType stringInternal Name 
- Internal name for the log analytics entity type.
- EntityType stringName 
- Log analytics entity type name.
- map[string]string
- (Updatable) 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
- (Updatable) The hostname where the entity represented here is actually present. This would be the output one would get if they run echo $HOSTNAMEon Linux or an equivalent OS command. This may be different from management agents host since logs may be collected remotely.
- LifecycleDetails string
- lifecycleDetails has additional information regarding substeps such as management agent plugin deployment.
- ManagementAgent stringCompartment Id 
- Management agent (management-agents resource kind) compartment OCID
- ManagementAgent stringDisplay Name 
- Management agent (management-agents resource kind) display name
- ManagementAgent stringId 
- (Updatable) The OCID of the Management Agent.
- Metadata
LogAnalytics Entity Metadata Args 
- (Updatable) Details of Entity Metadata.
- Name string
- (Updatable) Log analytics entity name.
- Namespace string
- The Logging Analytics namespace used for the request.
- Properties map[string]string
- (Updatable) 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.
- TimeLast stringDiscovered 
- (Updatable) 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
- (Updatable) The timezone region of the log analytics entity. - ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values 
- areLogs BooleanCollected 
- The Boolean flag to indicate if logs are collected for an entity for log analytics usage.
- cloudResource StringId 
- 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
- (Updatable) Compartment Identifier [OCID] (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm).
- Map<String,String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- entityType StringInternal Name 
- Internal name for the log analytics entity type.
- entityType StringName 
- Log analytics entity type name.
- Map<String,String>
- (Updatable) 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
- (Updatable) The hostname where the entity represented here is actually present. This would be the output one would get if they run echo $HOSTNAMEon Linux or an equivalent OS command. This may be different from management agents host since logs may be collected remotely.
- lifecycleDetails String
- lifecycleDetails has additional information regarding substeps such as management agent plugin deployment.
- managementAgent StringCompartment Id 
- Management agent (management-agents resource kind) compartment OCID
- managementAgent StringDisplay Name 
- Management agent (management-agents resource kind) display name
- managementAgent StringId 
- (Updatable) The OCID of the Management Agent.
- metadata
EntityMetadata 
- (Updatable) Details of Entity Metadata.
- name String
- (Updatable) Log analytics entity name.
- namespace String
- The Logging Analytics namespace used for the request.
- properties Map<String,String>
- (Updatable) 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.
- timeLast StringDiscovered 
- (Updatable) 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
- (Updatable) The timezone region of the log analytics entity. - ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values 
- areLogs booleanCollected 
- The Boolean flag to indicate if logs are collected for an entity for log analytics usage.
- cloudResource stringId 
- 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
- (Updatable) Compartment Identifier [OCID] (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm).
- {[key: string]: string}
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- entityType stringInternal Name 
- Internal name for the log analytics entity type.
- entityType stringName 
- Log analytics entity type name.
- {[key: string]: string}
- (Updatable) 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
- (Updatable) The hostname where the entity represented here is actually present. This would be the output one would get if they run echo $HOSTNAMEon Linux or an equivalent OS command. This may be different from management agents host since logs may be collected remotely.
- lifecycleDetails string
- lifecycleDetails has additional information regarding substeps such as management agent plugin deployment.
- managementAgent stringCompartment Id 
- Management agent (management-agents resource kind) compartment OCID
- managementAgent stringDisplay Name 
- Management agent (management-agents resource kind) display name
- managementAgent stringId 
- (Updatable) The OCID of the Management Agent.
- metadata
LogAnalytics Entity Metadata 
- (Updatable) Details of Entity Metadata.
- name string
- (Updatable) Log analytics entity name.
- namespace string
- The Logging Analytics namespace used for the request.
- properties {[key: string]: string}
- (Updatable) 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.
- timeLast stringDiscovered 
- (Updatable) 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
- (Updatable) The timezone region of the log analytics entity. - ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values 
- are_logs_ boolcollected 
- The Boolean flag to indicate if logs are collected for an entity for log analytics usage.
- cloud_resource_ strid 
- 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
- (Updatable) Compartment Identifier [OCID] (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm).
- Mapping[str, str]
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- entity_type_ strinternal_ name 
- Internal name for the log analytics entity type.
- entity_type_ strname 
- Log analytics entity type name.
- Mapping[str, str]
- (Updatable) 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
- (Updatable) The hostname where the entity represented here is actually present. This would be the output one would get if they run echo $HOSTNAMEon Linux or an equivalent OS command. This may be different from management agents host since logs may be collected remotely.
- lifecycle_details str
- lifecycleDetails has additional information regarding substeps such as management agent plugin deployment.
- management_agent_ strcompartment_ id 
- Management agent (management-agents resource kind) compartment OCID
- management_agent_ strdisplay_ name 
- Management agent (management-agents resource kind) display name
- management_agent_ strid 
- (Updatable) The OCID of the Management Agent.
- metadata
loganalytics.Log Analytics Entity Metadata Args 
- (Updatable) Details of Entity Metadata.
- name str
- (Updatable) Log analytics entity name.
- namespace str
- The Logging Analytics namespace used for the request.
- properties Mapping[str, str]
- (Updatable) 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_ strdiscovered 
- (Updatable) 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
- (Updatable) The timezone region of the log analytics entity. - ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values 
- areLogs BooleanCollected 
- The Boolean flag to indicate if logs are collected for an entity for log analytics usage.
- cloudResource StringId 
- 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
- (Updatable) Compartment Identifier [OCID] (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm).
- Map<String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- entityType StringInternal Name 
- Internal name for the log analytics entity type.
- entityType StringName 
- Log analytics entity type name.
- Map<String>
- (Updatable) 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
- (Updatable) The hostname where the entity represented here is actually present. This would be the output one would get if they run echo $HOSTNAMEon Linux or an equivalent OS command. This may be different from management agents host since logs may be collected remotely.
- lifecycleDetails String
- lifecycleDetails has additional information regarding substeps such as management agent plugin deployment.
- managementAgent StringCompartment Id 
- Management agent (management-agents resource kind) compartment OCID
- managementAgent StringDisplay Name 
- Management agent (management-agents resource kind) display name
- managementAgent StringId 
- (Updatable) The OCID of the Management Agent.
- metadata Property Map
- (Updatable) Details of Entity Metadata.
- name String
- (Updatable) Log analytics entity name.
- namespace String
- The Logging Analytics namespace used for the request.
- properties Map<String>
- (Updatable) 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.
- timeLast StringDiscovered 
- (Updatable) 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
- (Updatable) The timezone region of the log analytics entity. - ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values 
Supporting Types
LogAnalyticsEntityMetadata, LogAnalyticsEntityMetadataArgs        
- Items
List<LogAnalytics Entity Metadata Item> 
- (Updatable) An array of entity metadata details.
- Items
[]LogAnalytics Entity Metadata Item 
- (Updatable) An array of entity metadata details.
- items
List<EntityMetadata Item> 
- (Updatable) An array of entity metadata details.
- items
LogAnalytics Entity Metadata Item[] 
- (Updatable) An array of entity metadata details.
- items
Sequence[loganalytics.Log Analytics Entity Metadata Item] 
- (Updatable) An array of entity metadata details.
- items List<Property Map>
- (Updatable) An array of entity metadata details.
LogAnalyticsEntityMetadataItem, LogAnalyticsEntityMetadataItemArgs          
Import
LogAnalyticsEntities can be imported using the id, e.g.
$ pulumi import oci:LogAnalytics/logAnalyticsEntity:LogAnalyticsEntity test_log_analytics_entity "namespaces/{namespaceName}/logAnalyticsEntities/{logAnalyticsEntityId}"
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the ociTerraform Provider.