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,
management_agent_id: Optional[str] = None,
freeform_tags: Optional[Mapping[str, str]] = None,
hostname: Optional[str] = None,
defined_tags: Optional[Mapping[str, str]] = None,
metadata: Optional[_loganalytics.LogAnalyticsEntityMetadataArgs] = None,
properties: Optional[Mapping[str, str]] = None,
cloud_resource_id: Optional[str] = None,
name: Optional[str] = None,
source_id: Optional[str] = None,
time_last_discovered: Optional[str] = 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",
ManagementAgentId = "string",
FreeformTags =
{
{ "string", "string" },
},
Hostname = "string",
DefinedTags =
{
{ "string", "string" },
},
Metadata = new Oci.LogAnalytics.Inputs.LogAnalyticsEntityMetadataArgs
{
Items = new[]
{
new Oci.LogAnalytics.Inputs.LogAnalyticsEntityMetadataItemArgs
{
Name = "string",
Type = "string",
Value = "string",
},
},
},
Properties =
{
{ "string", "string" },
},
CloudResourceId = "string",
Name = "string",
SourceId = "string",
TimeLastDiscovered = "string",
TimezoneRegion = "string",
});
example, err := LogAnalytics.NewLogAnalyticsEntity(ctx, "logAnalyticsEntityResource", &LogAnalytics.LogAnalyticsEntityArgs{
Namespace: pulumi.String("string"),
EntityTypeName: pulumi.String("string"),
CompartmentId: pulumi.String("string"),
ManagementAgentId: pulumi.String("string"),
FreeformTags: pulumi.StringMap{
"string": pulumi.String("string"),
},
Hostname: pulumi.String("string"),
DefinedTags: pulumi.StringMap{
"string": pulumi.String("string"),
},
Metadata: &loganalytics.LogAnalyticsEntityMetadataArgs{
Items: loganalytics.LogAnalyticsEntityMetadataItemArray{
&loganalytics.LogAnalyticsEntityMetadataItemArgs{
Name: pulumi.String("string"),
Type: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
},
Properties: pulumi.StringMap{
"string": pulumi.String("string"),
},
CloudResourceId: pulumi.String("string"),
Name: pulumi.String("string"),
SourceId: pulumi.String("string"),
TimeLastDiscovered: pulumi.String("string"),
TimezoneRegion: pulumi.String("string"),
})
var logAnalyticsEntityResource = new LogAnalyticsEntity("logAnalyticsEntityResource", LogAnalyticsEntityArgs.builder()
.namespace("string")
.entityTypeName("string")
.compartmentId("string")
.managementAgentId("string")
.freeformTags(Map.of("string", "string"))
.hostname("string")
.definedTags(Map.of("string", "string"))
.metadata(LogAnalyticsEntityMetadataArgs.builder()
.items(LogAnalyticsEntityMetadataItemArgs.builder()
.name("string")
.type("string")
.value("string")
.build())
.build())
.properties(Map.of("string", "string"))
.cloudResourceId("string")
.name("string")
.sourceId("string")
.timeLastDiscovered("string")
.timezoneRegion("string")
.build());
log_analytics_entity_resource = oci.log_analytics.LogAnalyticsEntity("logAnalyticsEntityResource",
namespace="string",
entity_type_name="string",
compartment_id="string",
management_agent_id="string",
freeform_tags={
"string": "string",
},
hostname="string",
defined_tags={
"string": "string",
},
metadata={
"items": [{
"name": "string",
"type": "string",
"value": "string",
}],
},
properties={
"string": "string",
},
cloud_resource_id="string",
name="string",
source_id="string",
time_last_discovered="string",
timezone_region="string")
const logAnalyticsEntityResource = new oci.loganalytics.LogAnalyticsEntity("logAnalyticsEntityResource", {
namespace: "string",
entityTypeName: "string",
compartmentId: "string",
managementAgentId: "string",
freeformTags: {
string: "string",
},
hostname: "string",
definedTags: {
string: "string",
},
metadata: {
items: [{
name: "string",
type: "string",
value: "string",
}],
},
properties: {
string: "string",
},
cloudResourceId: "string",
name: "string",
sourceId: "string",
timeLastDiscovered: "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:
- Compartment
Id string - (Updatable) Compartment Identifier [OCID] (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm).
- Entity
Type stringName - Log analytics entity type name.
- Namespace string
- The Logging Analytics namespace used for the request.
- Cloud
Resource 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 $HOSTNAME
on Linux or an equivalent OS command. This may be different from management agents host since logs may be collected remotely. - Management
Agent stringId - (Updatable) The OCID of the Management Agent.
- Metadata
Log
Analytics 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.
- Source
Id string - This indicates the type of source. It is primarily for Enterprise Manager Repository ID.
- Time
Last stringDiscovered - (Updatable) The date and time the resource was last discovered, in the format defined by RFC3339.
- Timezone
Region 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 string - (Updatable) Compartment Identifier [OCID] (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm).
- Entity
Type stringName - Log analytics entity type name.
- Namespace string
- The Logging Analytics namespace used for the request.
- Cloud
Resource 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 $HOSTNAME
on Linux or an equivalent OS command. This may be different from management agents host since logs may be collected remotely. - Management
Agent stringId - (Updatable) The OCID of the Management Agent.
- Metadata
Log
Analytics 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.
- Source
Id string - This indicates the type of source. It is primarily for Enterprise Manager Repository ID.
- Time
Last stringDiscovered - (Updatable) The date and time the resource was last discovered, in the format defined by RFC3339.
- Timezone
Region 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 String - (Updatable) Compartment Identifier [OCID] (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm).
- entity
Type StringName - Log analytics entity type name.
- namespace String
- The Logging Analytics namespace used for the request.
- cloud
Resource 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 $HOSTNAME
on Linux or an equivalent OS command. This may be different from management agents host since logs may be collected remotely. - management
Agent StringId - (Updatable) The OCID of the Management Agent.
- metadata
Entity
Metadata - (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.
- source
Id String - This indicates the type of source. It is primarily for Enterprise Manager Repository ID.
- time
Last StringDiscovered - (Updatable) The date and time the resource was last discovered, in the format defined by RFC3339.
- timezone
Region 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 string - (Updatable) Compartment Identifier [OCID] (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm).
- entity
Type stringName - Log analytics entity type name.
- namespace string
- The Logging Analytics namespace used for the request.
- cloud
Resource 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 $HOSTNAME
on Linux or an equivalent OS command. This may be different from management agents host since logs may be collected remotely. - management
Agent stringId - (Updatable) The OCID of the Management Agent.
- metadata
Log
Analytics 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.
- source
Id string - This indicates the type of source. It is primarily for Enterprise Manager Repository ID.
- time
Last stringDiscovered - (Updatable) The date and time the resource was last discovered, in the format defined by RFC3339.
- timezone
Region 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 $HOSTNAME
on 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
- compartment
Id String - (Updatable) Compartment Identifier [OCID] (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm).
- entity
Type StringName - Log analytics entity type name.
- namespace String
- The Logging Analytics namespace used for the request.
- cloud
Resource 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 $HOSTNAME
on Linux or an equivalent OS command. This may be different from management agents host since logs may be collected remotely. - management
Agent 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.
- source
Id String - This indicates the type of source. It is primarily for Enterprise Manager Repository ID.
- time
Last StringDiscovered - (Updatable) The date and time the resource was last discovered, in the format defined by RFC3339.
- timezone
Region 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:
- Are
Logs boolCollected - The Boolean flag to indicate if logs are collected for an entity for log analytics usage.
- Entity
Type stringInternal Name - Internal name for the log analytics entity type.
- Id string
- The provider-assigned unique ID for this managed resource.
- Lifecycle
Details string - lifecycleDetails has additional information regarding substeps such as management agent plugin deployment.
- Management
Agent stringCompartment Id - Management agent (management-agents resource kind) compartment OCID
- Management
Agent stringDisplay Name - Management agent (management-agents resource kind) display name
- State string
- The current state of the log analytics entity.
- Time
Created string - The date and time the resource was created, in the format defined by RFC3339.
- Time
Updated 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 stringInternal Name - Internal name for the log analytics entity type.
- Id string
- The provider-assigned unique ID for this managed resource.
- Lifecycle
Details string - lifecycleDetails has additional information regarding substeps such as management agent plugin deployment.
- Management
Agent stringCompartment Id - Management agent (management-agents resource kind) compartment OCID
- Management
Agent stringDisplay Name - Management agent (management-agents resource kind) display name
- State string
- The current state of the log analytics entity.
- Time
Created string - The date and time the resource was created, in the format defined by RFC3339.
- Time
Updated string - The date and time the resource was last updated, in the format defined by RFC3339.
- are
Logs BooleanCollected - The Boolean flag to indicate if logs are collected for an entity for log analytics usage.
- entity
Type StringInternal Name - Internal name for the log analytics entity type.
- id String
- The provider-assigned unique ID for this managed resource.
- lifecycle
Details String - lifecycleDetails has additional information regarding substeps such as management agent plugin deployment.
- management
Agent StringCompartment Id - Management agent (management-agents resource kind) compartment OCID
- management
Agent StringDisplay Name - Management agent (management-agents resource kind) display name
- state String
- The current state of the log analytics entity.
- time
Created String - The date and time the resource was created, in the format defined by RFC3339.
- time
Updated String - The date and time the resource was last updated, in the format defined by RFC3339.
- are
Logs booleanCollected - The Boolean flag to indicate if logs are collected for an entity for log analytics usage.
- entity
Type stringInternal Name - Internal name for the log analytics entity type.
- id string
- The provider-assigned unique ID for this managed resource.
- lifecycle
Details string - lifecycleDetails has additional information regarding substeps such as management agent plugin deployment.
- management
Agent stringCompartment Id - Management agent (management-agents resource kind) compartment OCID
- management
Agent stringDisplay Name - Management agent (management-agents resource kind) display name
- state string
- The current state of the log analytics entity.
- time
Created string - The date and time the resource was created, in the format defined by RFC3339.
- time
Updated 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.
- are
Logs BooleanCollected - The Boolean flag to indicate if logs are collected for an entity for log analytics usage.
- entity
Type StringInternal Name - Internal name for the log analytics entity type.
- id String
- The provider-assigned unique ID for this managed resource.
- lifecycle
Details String - lifecycleDetails has additional information regarding substeps such as management agent plugin deployment.
- management
Agent StringCompartment Id - Management agent (management-agents resource kind) compartment OCID
- management
Agent StringDisplay Name - Management agent (management-agents resource kind) display name
- state String
- The current state of the log analytics entity.
- time
Created String - The date and time the resource was created, in the format defined by RFC3339.
- time
Updated 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) -> LogAnalyticsEntity
func 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)
Resource lookup is not supported in YAML
- 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.
- Are
Logs boolCollected - The Boolean flag to indicate if logs are collected for an entity for log analytics usage.
- Cloud
Resource 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.
- Compartment
Id 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"}
- Entity
Type stringInternal Name - Internal name for the log analytics entity type.
- Entity
Type 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 $HOSTNAME
on Linux or an equivalent OS command. This may be different from management agents host since logs may be collected remotely. - Lifecycle
Details string - lifecycleDetails has additional information regarding substeps such as management agent plugin deployment.
- Management
Agent stringCompartment Id - Management agent (management-agents resource kind) compartment OCID
- Management
Agent stringDisplay Name - Management agent (management-agents resource kind) display name
- Management
Agent stringId - (Updatable) The OCID of the Management Agent.
- Metadata
Log
Analytics 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.
- Source
Id 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.
- Time
Created string - The date and time the resource was created, in the format defined by RFC3339.
- Time
Last stringDiscovered - (Updatable) The date and time the resource was last discovered, in the format defined by RFC3339.
- Time
Updated string - The date and time the resource was last updated, in the format defined by RFC3339.
- Timezone
Region 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 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.
- Compartment
Id 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"}
- Entity
Type stringInternal Name - Internal name for the log analytics entity type.
- Entity
Type 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 $HOSTNAME
on Linux or an equivalent OS command. This may be different from management agents host since logs may be collected remotely. - Lifecycle
Details string - lifecycleDetails has additional information regarding substeps such as management agent plugin deployment.
- Management
Agent stringCompartment Id - Management agent (management-agents resource kind) compartment OCID
- Management
Agent stringDisplay Name - Management agent (management-agents resource kind) display name
- Management
Agent stringId - (Updatable) The OCID of the Management Agent.
- Metadata
Log
Analytics 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.
- Source
Id 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.
- Time
Created string - The date and time the resource was created, in the format defined by RFC3339.
- Time
Last stringDiscovered - (Updatable) The date and time the resource was last discovered, in the format defined by RFC3339.
- Time
Updated string - The date and time the resource was last updated, in the format defined by RFC3339.
- Timezone
Region 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 BooleanCollected - The Boolean flag to indicate if logs are collected for an entity for log analytics usage.
- cloud
Resource 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.
- compartment
Id 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"}
- entity
Type StringInternal Name - Internal name for the log analytics entity type.
- entity
Type 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 $HOSTNAME
on Linux or an equivalent OS command. This may be different from management agents host since logs may be collected remotely. - lifecycle
Details String - lifecycleDetails has additional information regarding substeps such as management agent plugin deployment.
- management
Agent StringCompartment Id - Management agent (management-agents resource kind) compartment OCID
- management
Agent StringDisplay Name - Management agent (management-agents resource kind) display name
- management
Agent StringId - (Updatable) The OCID of the Management Agent.
- metadata
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 Map<String,String>
- (Updatable) The name/value pairs for parameter values to be used in file patterns specified in log sources.
- source
Id 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.
- time
Created String - The date and time the resource was created, in the format defined by RFC3339.
- time
Last StringDiscovered - (Updatable) The date and time the resource was last discovered, in the format defined by RFC3339.
- time
Updated String - The date and time the resource was last updated, in the format defined by RFC3339.
- timezone
Region 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 booleanCollected - The Boolean flag to indicate if logs are collected for an entity for log analytics usage.
- cloud
Resource 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.
- compartment
Id 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"}
- entity
Type stringInternal Name - Internal name for the log analytics entity type.
- entity
Type 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 $HOSTNAME
on Linux or an equivalent OS command. This may be different from management agents host since logs may be collected remotely. - lifecycle
Details string - lifecycleDetails has additional information regarding substeps such as management agent plugin deployment.
- management
Agent stringCompartment Id - Management agent (management-agents resource kind) compartment OCID
- management
Agent stringDisplay Name - Management agent (management-agents resource kind) display name
- management
Agent stringId - (Updatable) The OCID of the Management Agent.
- metadata
Log
Analytics 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.
- source
Id 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.
- time
Created string - The date and time the resource was created, in the format defined by RFC3339.
- time
Last stringDiscovered - (Updatable) The date and time the resource was last discovered, in the format defined by RFC3339.
- time
Updated string - The date and time the resource was last updated, in the format defined by RFC3339.
- timezone
Region 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 $HOSTNAME
on 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
- are
Logs BooleanCollected - The Boolean flag to indicate if logs are collected for an entity for log analytics usage.
- cloud
Resource 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.
- compartment
Id 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"}
- entity
Type StringInternal Name - Internal name for the log analytics entity type.
- entity
Type 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 $HOSTNAME
on Linux or an equivalent OS command. This may be different from management agents host since logs may be collected remotely. - lifecycle
Details String - lifecycleDetails has additional information regarding substeps such as management agent plugin deployment.
- management
Agent StringCompartment Id - Management agent (management-agents resource kind) compartment OCID
- management
Agent StringDisplay Name - Management agent (management-agents resource kind) display name
- management
Agent 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.
- source
Id 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.
- time
Created String - The date and time the resource was created, in the format defined by RFC3339.
- time
Last StringDiscovered - (Updatable) The date and time the resource was last discovered, in the format defined by RFC3339.
- time
Updated String - The date and time the resource was last updated, in the format defined by RFC3339.
- timezone
Region 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<Log
Analytics Entity Metadata Item> - (Updatable) An array of entity metadata details.
- Items
[]Log
Analytics Entity Metadata Item - (Updatable) An array of entity metadata details.
- items
List<Entity
Metadata Item> - (Updatable) An array of entity metadata details.
- items
Log
Analytics 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
oci
Terraform Provider.