Oracle Cloud Infrastructure

v0.5.0 published on Monday, Sep 12, 2022 by Pulumi

getLogAnalyticsObjectCollectionRule

This data source provides details about a specific Log Analytics Object Collection Rule resource in Oracle Cloud Infrastructure Log Analytics service.

Gets a configured object storage based collection rule by given id

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var testLogAnalyticsObjectCollectionRule = Oci.LogAnalytics.GetLogAnalyticsObjectCollectionRule.Invoke(new()
    {
        LogAnalyticsObjectCollectionRuleId = oci_log_analytics_log_analytics_object_collection_rule.Test_log_analytics_object_collection_rule.Id,
        Namespace = @var.Log_analytics_object_collection_rule_namespace,
    });

});
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := LogAnalytics.GetLogAnalyticsObjectCollectionRule(ctx, &loganalytics.GetLogAnalyticsObjectCollectionRuleArgs{
			LogAnalyticsObjectCollectionRuleId: oci_log_analytics_log_analytics_object_collection_rule.Test_log_analytics_object_collection_rule.Id,
			Namespace:                          _var.Log_analytics_object_collection_rule_namespace,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

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

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

    public static void stack(Context ctx) {
        final var testLogAnalyticsObjectCollectionRule = LogAnalyticsFunctions.getLogAnalyticsObjectCollectionRule(GetLogAnalyticsObjectCollectionRuleArgs.builder()
            .logAnalyticsObjectCollectionRuleId(oci_log_analytics_log_analytics_object_collection_rule.test_log_analytics_object_collection_rule().id())
            .namespace(var_.log_analytics_object_collection_rule_namespace())
            .build());

    }
}
import pulumi
import pulumi_oci as oci

test_log_analytics_object_collection_rule = oci.LogAnalytics.get_log_analytics_object_collection_rule(log_analytics_object_collection_rule_id=oci_log_analytics_log_analytics_object_collection_rule["test_log_analytics_object_collection_rule"]["id"],
    namespace=var["log_analytics_object_collection_rule_namespace"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testLogAnalyticsObjectCollectionRule = oci.LogAnalytics.getLogAnalyticsObjectCollectionRule({
    logAnalyticsObjectCollectionRuleId: oci_log_analytics_log_analytics_object_collection_rule.test_log_analytics_object_collection_rule.id,
    namespace: _var.log_analytics_object_collection_rule_namespace,
});
variables:
  testLogAnalyticsObjectCollectionRule:
    Fn::Invoke:
      Function: oci:LogAnalytics:getLogAnalyticsObjectCollectionRule
      Arguments:
        logAnalyticsObjectCollectionRuleId: ${oci_log_analytics_log_analytics_object_collection_rule.test_log_analytics_object_collection_rule.id}
        namespace: ${var.log_analytics_object_collection_rule_namespace}

Using getLogAnalyticsObjectCollectionRule

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

function getLogAnalyticsObjectCollectionRule(args: GetLogAnalyticsObjectCollectionRuleArgs, opts?: InvokeOptions): Promise<GetLogAnalyticsObjectCollectionRuleResult>
function getLogAnalyticsObjectCollectionRuleOutput(args: GetLogAnalyticsObjectCollectionRuleOutputArgs, opts?: InvokeOptions): Output<GetLogAnalyticsObjectCollectionRuleResult>
def get_log_analytics_object_collection_rule(log_analytics_object_collection_rule_id: Optional[str] = None,
                                             namespace: Optional[str] = None,
                                             opts: Optional[InvokeOptions] = None) -> GetLogAnalyticsObjectCollectionRuleResult
def get_log_analytics_object_collection_rule_output(log_analytics_object_collection_rule_id: Optional[pulumi.Input[str]] = None,
                                             namespace: Optional[pulumi.Input[str]] = None,
                                             opts: Optional[InvokeOptions] = None) -> Output[GetLogAnalyticsObjectCollectionRuleResult]
func GetLogAnalyticsObjectCollectionRule(ctx *Context, args *GetLogAnalyticsObjectCollectionRuleArgs, opts ...InvokeOption) (*GetLogAnalyticsObjectCollectionRuleResult, error)
func GetLogAnalyticsObjectCollectionRuleOutput(ctx *Context, args *GetLogAnalyticsObjectCollectionRuleOutputArgs, opts ...InvokeOption) GetLogAnalyticsObjectCollectionRuleResultOutput

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

public static class GetLogAnalyticsObjectCollectionRule 
{
    public static Task<GetLogAnalyticsObjectCollectionRuleResult> InvokeAsync(GetLogAnalyticsObjectCollectionRuleArgs args, InvokeOptions? opts = null)
    public static Output<GetLogAnalyticsObjectCollectionRuleResult> Invoke(GetLogAnalyticsObjectCollectionRuleInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetLogAnalyticsObjectCollectionRuleResult> getLogAnalyticsObjectCollectionRule(GetLogAnalyticsObjectCollectionRuleArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: oci:LogAnalytics/getLogAnalyticsObjectCollectionRule:getLogAnalyticsObjectCollectionRule
  arguments:
    # arguments dictionary

The following arguments are supported:

LogAnalyticsObjectCollectionRuleId string

The Logging Analytics Object Collection Rule OCID

Namespace string

The Logging Analytics namespace used for the request.

LogAnalyticsObjectCollectionRuleId string

The Logging Analytics Object Collection Rule OCID

Namespace string

The Logging Analytics namespace used for the request.

logAnalyticsObjectCollectionRuleId String

The Logging Analytics Object Collection Rule OCID

namespace String

The Logging Analytics namespace used for the request.

logAnalyticsObjectCollectionRuleId string

The Logging Analytics Object Collection Rule OCID

namespace string

The Logging Analytics namespace used for the request.

log_analytics_object_collection_rule_id str

The Logging Analytics Object Collection Rule OCID

namespace str

The Logging Analytics namespace used for the request.

logAnalyticsObjectCollectionRuleId String

The Logging Analytics Object Collection Rule OCID

namespace String

The Logging Analytics namespace used for the request.

getLogAnalyticsObjectCollectionRule Result

The following output properties are available:

CharEncoding string

An optional character encoding to aid in detecting the character encoding of the contents of the objects while processing. It is recommended to set this value as ISO_8589_1 when configuring content of the objects having more numeric characters, and very few alphabets. For e.g. this applies when configuring VCN Flow Logs.

CollectionType string

The type of collection. Supported collection types: LIVE, HISTORIC, HISTORIC_LIVE

CompartmentId string

The OCID of the compartment to which this rule belongs.

DefinedTags Dictionary<string, object>

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

Description string

A string that describes the details of the rule. It does not have to be unique, and can be changed. Avoid entering confidential information.

EntityId string

Logging Analytics entity OCID to associate the processed logs with.

FreeformTags Dictionary<string, object>

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

Id string

The OCID of this rule.

LifecycleDetails string

A detailed status of the life cycle state.

LogAnalyticsObjectCollectionRuleId string
LogGroupId string

Logging Analytics Log group OCID to associate the processed logs with.

LogSourceName string

Name of the Logging Analytics Source to use for the processing.

Name string

A unique name to the rule. The name must be unique, within the tenancy, and cannot be changed.

Namespace string
ObjectNameFilters List<string>

When the filters are provided, only the objects matching the filters are picked up for processing. The matchType supported is exact match and accommodates wildcard "*". For more information on filters, see Event Filters.

OsBucketName string

Name of the Object Storage bucket.

OsNamespace string

Object Storage namespace.

Overrides List<GetLogAnalyticsObjectCollectionRuleOverride>

Use this to override some property values which are defined at bucket level to the scope of object. Supported propeties for override are, logSourceName, charEncoding. Supported matchType for override are "contains".

PollSince string

The oldest time of the file in the bucket to consider for collection. Accepted values are: BEGINNING or CURRENT_TIME or RFC3339 formatted datetime string. When collectionType is LIVE, specifying pollSince value other than CURRENT_TIME will result in error.

PollTill string

The oldest time of the file in the bucket to consider for collection. Accepted values are: CURRENT_TIME or RFC3339 formatted datetime string. When collectionType is LIVE, specifying pollTill will result in error.

State string

The current state of the rule.

TimeCreated string

The time when this rule was created. An RFC3339 formatted datetime string.

TimeUpdated string

The time when this rule was last updated. An RFC3339 formatted datetime string.

CharEncoding string

An optional character encoding to aid in detecting the character encoding of the contents of the objects while processing. It is recommended to set this value as ISO_8589_1 when configuring content of the objects having more numeric characters, and very few alphabets. For e.g. this applies when configuring VCN Flow Logs.

CollectionType string

The type of collection. Supported collection types: LIVE, HISTORIC, HISTORIC_LIVE

CompartmentId string

The OCID of the compartment to which this rule belongs.

DefinedTags map[string]interface{}

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

Description string

A string that describes the details of the rule. It does not have to be unique, and can be changed. Avoid entering confidential information.

EntityId string

Logging Analytics entity OCID to associate the processed logs with.

FreeformTags map[string]interface{}

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

Id string

The OCID of this rule.

LifecycleDetails string

A detailed status of the life cycle state.

LogAnalyticsObjectCollectionRuleId string
LogGroupId string

Logging Analytics Log group OCID to associate the processed logs with.

LogSourceName string

Name of the Logging Analytics Source to use for the processing.

Name string

A unique name to the rule. The name must be unique, within the tenancy, and cannot be changed.

Namespace string
ObjectNameFilters []string

When the filters are provided, only the objects matching the filters are picked up for processing. The matchType supported is exact match and accommodates wildcard "*". For more information on filters, see Event Filters.

OsBucketName string

Name of the Object Storage bucket.

OsNamespace string

Object Storage namespace.

Overrides []GetLogAnalyticsObjectCollectionRuleOverride

Use this to override some property values which are defined at bucket level to the scope of object. Supported propeties for override are, logSourceName, charEncoding. Supported matchType for override are "contains".

PollSince string

The oldest time of the file in the bucket to consider for collection. Accepted values are: BEGINNING or CURRENT_TIME or RFC3339 formatted datetime string. When collectionType is LIVE, specifying pollSince value other than CURRENT_TIME will result in error.

PollTill string

The oldest time of the file in the bucket to consider for collection. Accepted values are: CURRENT_TIME or RFC3339 formatted datetime string. When collectionType is LIVE, specifying pollTill will result in error.

State string

The current state of the rule.

TimeCreated string

The time when this rule was created. An RFC3339 formatted datetime string.

TimeUpdated string

The time when this rule was last updated. An RFC3339 formatted datetime string.

charEncoding String

An optional character encoding to aid in detecting the character encoding of the contents of the objects while processing. It is recommended to set this value as ISO_8589_1 when configuring content of the objects having more numeric characters, and very few alphabets. For e.g. this applies when configuring VCN Flow Logs.

collectionType String

The type of collection. Supported collection types: LIVE, HISTORIC, HISTORIC_LIVE

compartmentId String

The OCID of the compartment to which this rule belongs.

definedTags Map<String,Object>

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

description String

A string that describes the details of the rule. It does not have to be unique, and can be changed. Avoid entering confidential information.

entityId String

Logging Analytics entity OCID to associate the processed logs with.

freeformTags Map<String,Object>

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

id String

The OCID of this rule.

lifecycleDetails String

A detailed status of the life cycle state.

logAnalyticsObjectCollectionRuleId String
logGroupId String

Logging Analytics Log group OCID to associate the processed logs with.

logSourceName String

Name of the Logging Analytics Source to use for the processing.

name String

A unique name to the rule. The name must be unique, within the tenancy, and cannot be changed.

namespace String
objectNameFilters List<String>

When the filters are provided, only the objects matching the filters are picked up for processing. The matchType supported is exact match and accommodates wildcard "*". For more information on filters, see Event Filters.

osBucketName String

Name of the Object Storage bucket.

osNamespace String

Object Storage namespace.

overrides List<GetObjectCollectionRuleOverride>

Use this to override some property values which are defined at bucket level to the scope of object. Supported propeties for override are, logSourceName, charEncoding. Supported matchType for override are "contains".

pollSince String

The oldest time of the file in the bucket to consider for collection. Accepted values are: BEGINNING or CURRENT_TIME or RFC3339 formatted datetime string. When collectionType is LIVE, specifying pollSince value other than CURRENT_TIME will result in error.

pollTill String

The oldest time of the file in the bucket to consider for collection. Accepted values are: CURRENT_TIME or RFC3339 formatted datetime string. When collectionType is LIVE, specifying pollTill will result in error.

state String

The current state of the rule.

timeCreated String

The time when this rule was created. An RFC3339 formatted datetime string.

timeUpdated String

The time when this rule was last updated. An RFC3339 formatted datetime string.

charEncoding string

An optional character encoding to aid in detecting the character encoding of the contents of the objects while processing. It is recommended to set this value as ISO_8589_1 when configuring content of the objects having more numeric characters, and very few alphabets. For e.g. this applies when configuring VCN Flow Logs.

collectionType string

The type of collection. Supported collection types: LIVE, HISTORIC, HISTORIC_LIVE

compartmentId string

The OCID of the compartment to which this rule belongs.

definedTags {[key: string]: any}

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

description string

A string that describes the details of the rule. It does not have to be unique, and can be changed. Avoid entering confidential information.

entityId string

Logging Analytics entity OCID to associate the processed logs with.

freeformTags {[key: string]: any}

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

id string

The OCID of this rule.

lifecycleDetails string

A detailed status of the life cycle state.

logAnalyticsObjectCollectionRuleId string
logGroupId string

Logging Analytics Log group OCID to associate the processed logs with.

logSourceName string

Name of the Logging Analytics Source to use for the processing.

name string

A unique name to the rule. The name must be unique, within the tenancy, and cannot be changed.

namespace string
objectNameFilters string[]

When the filters are provided, only the objects matching the filters are picked up for processing. The matchType supported is exact match and accommodates wildcard "*". For more information on filters, see Event Filters.

osBucketName string

Name of the Object Storage bucket.

osNamespace string

Object Storage namespace.

overrides GetLogAnalyticsObjectCollectionRuleOverride[]

Use this to override some property values which are defined at bucket level to the scope of object. Supported propeties for override are, logSourceName, charEncoding. Supported matchType for override are "contains".

pollSince string

The oldest time of the file in the bucket to consider for collection. Accepted values are: BEGINNING or CURRENT_TIME or RFC3339 formatted datetime string. When collectionType is LIVE, specifying pollSince value other than CURRENT_TIME will result in error.

pollTill string

The oldest time of the file in the bucket to consider for collection. Accepted values are: CURRENT_TIME or RFC3339 formatted datetime string. When collectionType is LIVE, specifying pollTill will result in error.

state string

The current state of the rule.

timeCreated string

The time when this rule was created. An RFC3339 formatted datetime string.

timeUpdated string

The time when this rule was last updated. An RFC3339 formatted datetime string.

char_encoding str

An optional character encoding to aid in detecting the character encoding of the contents of the objects while processing. It is recommended to set this value as ISO_8589_1 when configuring content of the objects having more numeric characters, and very few alphabets. For e.g. this applies when configuring VCN Flow Logs.

collection_type str

The type of collection. Supported collection types: LIVE, HISTORIC, HISTORIC_LIVE

compartment_id str

The OCID of the compartment to which this rule belongs.

defined_tags Mapping[str, Any]

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

description str

A string that describes the details of the rule. It does not have to be unique, and can be changed. Avoid entering confidential information.

entity_id str

Logging Analytics entity OCID to associate the processed logs with.

freeform_tags Mapping[str, Any]

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

id str

The OCID of this rule.

lifecycle_details str

A detailed status of the life cycle state.

log_analytics_object_collection_rule_id str
log_group_id str

Logging Analytics Log group OCID to associate the processed logs with.

log_source_name str

Name of the Logging Analytics Source to use for the processing.

name str

A unique name to the rule. The name must be unique, within the tenancy, and cannot be changed.

namespace str
object_name_filters Sequence[str]

When the filters are provided, only the objects matching the filters are picked up for processing. The matchType supported is exact match and accommodates wildcard "*". For more information on filters, see Event Filters.

os_bucket_name str

Name of the Object Storage bucket.

os_namespace str

Object Storage namespace.

overrides GetLogAnalyticsObjectCollectionRuleOverride]

Use this to override some property values which are defined at bucket level to the scope of object. Supported propeties for override are, logSourceName, charEncoding. Supported matchType for override are "contains".

poll_since str

The oldest time of the file in the bucket to consider for collection. Accepted values are: BEGINNING or CURRENT_TIME or RFC3339 formatted datetime string. When collectionType is LIVE, specifying pollSince value other than CURRENT_TIME will result in error.

poll_till str

The oldest time of the file in the bucket to consider for collection. Accepted values are: CURRENT_TIME or RFC3339 formatted datetime string. When collectionType is LIVE, specifying pollTill will result in error.

state str

The current state of the rule.

time_created str

The time when this rule was created. An RFC3339 formatted datetime string.

time_updated str

The time when this rule was last updated. An RFC3339 formatted datetime string.

charEncoding String

An optional character encoding to aid in detecting the character encoding of the contents of the objects while processing. It is recommended to set this value as ISO_8589_1 when configuring content of the objects having more numeric characters, and very few alphabets. For e.g. this applies when configuring VCN Flow Logs.

collectionType String

The type of collection. Supported collection types: LIVE, HISTORIC, HISTORIC_LIVE

compartmentId String

The OCID of the compartment to which this rule belongs.

definedTags Map<Any>

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

description String

A string that describes the details of the rule. It does not have to be unique, and can be changed. Avoid entering confidential information.

entityId String

Logging Analytics entity OCID to associate the processed logs with.

freeformTags Map<Any>

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

id String

The OCID of this rule.

lifecycleDetails String

A detailed status of the life cycle state.

logAnalyticsObjectCollectionRuleId String
logGroupId String

Logging Analytics Log group OCID to associate the processed logs with.

logSourceName String

Name of the Logging Analytics Source to use for the processing.

name String

A unique name to the rule. The name must be unique, within the tenancy, and cannot be changed.

namespace String
objectNameFilters List<String>

When the filters are provided, only the objects matching the filters are picked up for processing. The matchType supported is exact match and accommodates wildcard "*". For more information on filters, see Event Filters.

osBucketName String

Name of the Object Storage bucket.

osNamespace String

Object Storage namespace.

overrides List<Property Map>

Use this to override some property values which are defined at bucket level to the scope of object. Supported propeties for override are, logSourceName, charEncoding. Supported matchType for override are "contains".

pollSince String

The oldest time of the file in the bucket to consider for collection. Accepted values are: BEGINNING or CURRENT_TIME or RFC3339 formatted datetime string. When collectionType is LIVE, specifying pollSince value other than CURRENT_TIME will result in error.

pollTill String

The oldest time of the file in the bucket to consider for collection. Accepted values are: CURRENT_TIME or RFC3339 formatted datetime string. When collectionType is LIVE, specifying pollTill will result in error.

state String

The current state of the rule.

timeCreated String

The time when this rule was created. An RFC3339 formatted datetime string.

timeUpdated String

The time when this rule was last updated. An RFC3339 formatted datetime string.

Supporting Types

GetLogAnalyticsObjectCollectionRuleOverride

Package Details

Repository
https://github.com/pulumi/pulumi-oci
License
Apache-2.0
Notes

This Pulumi package is based on the oci Terraform Provider.