Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi
oci.LogAnalytics.getLogAnalyticsObjectCollectionRules
Explore with Pulumi AI
This data source provides the list of Log Analytics Object Collection Rules in Oracle Cloud Infrastructure Log Analytics service.
Gets list of configuration details of Object Storage based collection rules.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testLogAnalyticsObjectCollectionRules = oci.LogAnalytics.getLogAnalyticsObjectCollectionRules({
    compartmentId: compartmentId,
    namespace: logAnalyticsObjectCollectionRuleNamespace,
    name: logAnalyticsObjectCollectionRuleName,
    state: logAnalyticsObjectCollectionRuleState,
});
import pulumi
import pulumi_oci as oci
test_log_analytics_object_collection_rules = oci.LogAnalytics.get_log_analytics_object_collection_rules(compartment_id=compartment_id,
    namespace=log_analytics_object_collection_rule_namespace,
    name=log_analytics_object_collection_rule_name,
    state=log_analytics_object_collection_rule_state)
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.GetLogAnalyticsObjectCollectionRules(ctx, &loganalytics.GetLogAnalyticsObjectCollectionRulesArgs{
			CompartmentId: compartmentId,
			Namespace:     logAnalyticsObjectCollectionRuleNamespace,
			Name:          pulumi.StringRef(logAnalyticsObjectCollectionRuleName),
			State:         pulumi.StringRef(logAnalyticsObjectCollectionRuleState),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;
return await Deployment.RunAsync(() => 
{
    var testLogAnalyticsObjectCollectionRules = Oci.LogAnalytics.GetLogAnalyticsObjectCollectionRules.Invoke(new()
    {
        CompartmentId = compartmentId,
        Namespace = logAnalyticsObjectCollectionRuleNamespace,
        Name = logAnalyticsObjectCollectionRuleName,
        State = logAnalyticsObjectCollectionRuleState,
    });
});
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.GetLogAnalyticsObjectCollectionRulesArgs;
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 testLogAnalyticsObjectCollectionRules = LogAnalyticsFunctions.getLogAnalyticsObjectCollectionRules(GetLogAnalyticsObjectCollectionRulesArgs.builder()
            .compartmentId(compartmentId)
            .namespace(logAnalyticsObjectCollectionRuleNamespace)
            .name(logAnalyticsObjectCollectionRuleName)
            .state(logAnalyticsObjectCollectionRuleState)
            .build());
    }
}
variables:
  testLogAnalyticsObjectCollectionRules:
    fn::invoke:
      function: oci:LogAnalytics:getLogAnalyticsObjectCollectionRules
      arguments:
        compartmentId: ${compartmentId}
        namespace: ${logAnalyticsObjectCollectionRuleNamespace}
        name: ${logAnalyticsObjectCollectionRuleName}
        state: ${logAnalyticsObjectCollectionRuleState}
Using getLogAnalyticsObjectCollectionRules
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 getLogAnalyticsObjectCollectionRules(args: GetLogAnalyticsObjectCollectionRulesArgs, opts?: InvokeOptions): Promise<GetLogAnalyticsObjectCollectionRulesResult>
function getLogAnalyticsObjectCollectionRulesOutput(args: GetLogAnalyticsObjectCollectionRulesOutputArgs, opts?: InvokeOptions): Output<GetLogAnalyticsObjectCollectionRulesResult>def get_log_analytics_object_collection_rules(compartment_id: Optional[str] = None,
                                              filters: Optional[Sequence[GetLogAnalyticsObjectCollectionRulesFilter]] = None,
                                              name: Optional[str] = None,
                                              namespace: Optional[str] = None,
                                              state: Optional[str] = None,
                                              opts: Optional[InvokeOptions] = None) -> GetLogAnalyticsObjectCollectionRulesResult
def get_log_analytics_object_collection_rules_output(compartment_id: Optional[pulumi.Input[str]] = None,
                                              filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetLogAnalyticsObjectCollectionRulesFilterArgs]]]] = None,
                                              name: Optional[pulumi.Input[str]] = None,
                                              namespace: Optional[pulumi.Input[str]] = None,
                                              state: Optional[pulumi.Input[str]] = None,
                                              opts: Optional[InvokeOptions] = None) -> Output[GetLogAnalyticsObjectCollectionRulesResult]func GetLogAnalyticsObjectCollectionRules(ctx *Context, args *GetLogAnalyticsObjectCollectionRulesArgs, opts ...InvokeOption) (*GetLogAnalyticsObjectCollectionRulesResult, error)
func GetLogAnalyticsObjectCollectionRulesOutput(ctx *Context, args *GetLogAnalyticsObjectCollectionRulesOutputArgs, opts ...InvokeOption) GetLogAnalyticsObjectCollectionRulesResultOutput> Note: This function is named GetLogAnalyticsObjectCollectionRules in the Go SDK.
public static class GetLogAnalyticsObjectCollectionRules 
{
    public static Task<GetLogAnalyticsObjectCollectionRulesResult> InvokeAsync(GetLogAnalyticsObjectCollectionRulesArgs args, InvokeOptions? opts = null)
    public static Output<GetLogAnalyticsObjectCollectionRulesResult> Invoke(GetLogAnalyticsObjectCollectionRulesInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetLogAnalyticsObjectCollectionRulesResult> getLogAnalyticsObjectCollectionRules(GetLogAnalyticsObjectCollectionRulesArgs args, InvokeOptions options)
public static Output<GetLogAnalyticsObjectCollectionRulesResult> getLogAnalyticsObjectCollectionRules(GetLogAnalyticsObjectCollectionRulesArgs args, InvokeOptions options)
fn::invoke:
  function: oci:LogAnalytics/getLogAnalyticsObjectCollectionRules:getLogAnalyticsObjectCollectionRules
  arguments:
    # arguments dictionaryThe following arguments are supported:
- CompartmentId string
- The ID of the compartment in which to list resources.
- Namespace string
- The Logging Analytics namespace used for the request.
- Filters
List<GetLog Analytics Object Collection Rules Filter> 
- Name string
- A filter to return rules only matching with this name.
- State string
- Lifecycle state filter.
- CompartmentId string
- The ID of the compartment in which to list resources.
- Namespace string
- The Logging Analytics namespace used for the request.
- Filters
[]GetLog Analytics Object Collection Rules Filter 
- Name string
- A filter to return rules only matching with this name.
- State string
- Lifecycle state filter.
- compartmentId String
- The ID of the compartment in which to list resources.
- namespace String
- The Logging Analytics namespace used for the request.
- filters
List<GetObject Collection Rules Filter> 
- name String
- A filter to return rules only matching with this name.
- state String
- Lifecycle state filter.
- compartmentId string
- The ID of the compartment in which to list resources.
- namespace string
- The Logging Analytics namespace used for the request.
- filters
GetLog Analytics Object Collection Rules Filter[] 
- name string
- A filter to return rules only matching with this name.
- state string
- Lifecycle state filter.
- compartment_id str
- The ID of the compartment in which to list resources.
- namespace str
- The Logging Analytics namespace used for the request.
- filters
Sequence[GetLog Analytics Object Collection Rules Filter] 
- name str
- A filter to return rules only matching with this name.
- state str
- Lifecycle state filter.
- compartmentId String
- The ID of the compartment in which to list resources.
- namespace String
- The Logging Analytics namespace used for the request.
- filters List<Property Map>
- name String
- A filter to return rules only matching with this name.
- state String
- Lifecycle state filter.
getLogAnalyticsObjectCollectionRules Result
The following output properties are available:
- CompartmentId string
- The OCID of the compartment to which this rule belongs.
- Id string
- The provider-assigned unique ID for this managed resource.
- LogAnalytics List<GetObject Collection Rule Collections Log Analytics Object Collection Rules Log Analytics Object Collection Rule Collection> 
- The list of log_analytics_object_collection_rule_collection.
- Namespace string
- Filters
List<GetLog Analytics Object Collection Rules Filter> 
- Name string
- A unique name to the rule. The name must be unique, within the tenancy, and cannot be changed.
- State string
- The current state of the rule.
- CompartmentId string
- The OCID of the compartment to which this rule belongs.
- Id string
- The provider-assigned unique ID for this managed resource.
- LogAnalytics []GetObject Collection Rule Collections Log Analytics Object Collection Rules Log Analytics Object Collection Rule Collection 
- The list of log_analytics_object_collection_rule_collection.
- Namespace string
- Filters
[]GetLog Analytics Object Collection Rules Filter 
- Name string
- A unique name to the rule. The name must be unique, within the tenancy, and cannot be changed.
- State string
- The current state of the rule.
- compartmentId String
- The OCID of the compartment to which this rule belongs.
- id String
- The provider-assigned unique ID for this managed resource.
- logAnalytics List<GetObject Collection Rule Collections Object Collection Rules Object Collection Rule Collection> 
- The list of log_analytics_object_collection_rule_collection.
- namespace String
- filters
List<GetObject Collection Rules Filter> 
- name String
- A unique name to the rule. The name must be unique, within the tenancy, and cannot be changed.
- state String
- The current state of the rule.
- compartmentId string
- The OCID of the compartment to which this rule belongs.
- id string
- The provider-assigned unique ID for this managed resource.
- logAnalytics GetObject Collection Rule Collections Log Analytics Object Collection Rules Log Analytics Object Collection Rule Collection[] 
- The list of log_analytics_object_collection_rule_collection.
- namespace string
- filters
GetLog Analytics Object Collection Rules Filter[] 
- name string
- A unique name to the rule. The name must be unique, within the tenancy, and cannot be changed.
- state string
- The current state of the rule.
- compartment_id str
- The OCID of the compartment to which this rule belongs.
- id str
- The provider-assigned unique ID for this managed resource.
- log_analytics_ Sequence[Getobject_ collection_ rule_ collections Log Analytics Object Collection Rules Log Analytics Object Collection Rule Collection] 
- The list of log_analytics_object_collection_rule_collection.
- namespace str
- filters
Sequence[GetLog Analytics Object Collection Rules Filter] 
- name str
- A unique name to the rule. The name must be unique, within the tenancy, and cannot be changed.
- state str
- The current state of the rule.
- compartmentId String
- The OCID of the compartment to which this rule belongs.
- id String
- The provider-assigned unique ID for this managed resource.
- logAnalytics List<Property Map>Object Collection Rule Collections 
- The list of log_analytics_object_collection_rule_collection.
- namespace String
- filters List<Property Map>
- name String
- A unique name to the rule. The name must be unique, within the tenancy, and cannot be changed.
- state String
- The current state of the rule.
Supporting Types
GetLogAnalyticsObjectCollectionRulesFilter      
GetLogAnalyticsObjectCollectionRulesLogAnalyticsObjectCollectionRuleCollection           
GetLogAnalyticsObjectCollectionRulesLogAnalyticsObjectCollectionRuleCollectionItem            
- 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 ID of the compartment in which to list resources.
- Dictionary<string, string>
- 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.
- Dictionary<string, string>
- Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
- Id string
- The OCID of this rule.
- IsEnabled bool
- Whether or not this rule is currently enabled.
- IsForce boolHistoric Collection 
- Flag to allow historic collection if poll period overlaps with existing ACTIVE collection rule
- LifecycleDetails string
- A detailed status of the life cycle state.
- LogGroup stringId 
- Logging Analytics Log group OCID to associate the processed logs with.
- LogSet string
- The logSet to be associated with the processed logs. The logSet feature can be used by customers with high volume of data and this feature has to be enabled for a given tenancy prior to its usage. When logSetExtRegex value is provided, it will take precedence over this logSet value and logSet will be computed dynamically using logSetKey and logSetExtRegex.
- LogSet stringExt Regex 
- The regex to be applied against given logSetKey. Regex has to be in string escaped format.
- LogSet stringKey 
- An optional parameter to indicate from where the logSet to be extracted using logSetExtRegex. Default value is OBJECT_PATH (e.g. /n//b//o/).
- LogSource stringName 
- Name of the Logging Analytics Source to use for the processing.
- LogType string
- Type of files/objects in this object collection rule.
- Name string
- A filter to return rules only matching with this name.
- Namespace string
- The Logging Analytics namespace used for the request.
- ObjectName List<string>Filters 
- 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.
- OsBucket stringName 
- Name of the Object Storage bucket.
- OsNamespace string
- Object Storage namespace.
- Overrides
List<GetLog Analytics Object Collection Rules Log Analytics Object Collection Rule Collection Item Override> 
- 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
- Lifecycle state filter.
- 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.
- Timezone string
- Timezone to be used when processing log entries whose timestamps do not include an explicit timezone. When this property is not specified, the timezone of the entity specified is used. If the entity is also not specified or do not have a valid timezone then UTC is used.
- 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 ID of the compartment in which to list resources.
- map[string]string
- 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.
- map[string]string
- Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
- Id string
- The OCID of this rule.
- IsEnabled bool
- Whether or not this rule is currently enabled.
- IsForce boolHistoric Collection 
- Flag to allow historic collection if poll period overlaps with existing ACTIVE collection rule
- LifecycleDetails string
- A detailed status of the life cycle state.
- LogGroup stringId 
- Logging Analytics Log group OCID to associate the processed logs with.
- LogSet string
- The logSet to be associated with the processed logs. The logSet feature can be used by customers with high volume of data and this feature has to be enabled for a given tenancy prior to its usage. When logSetExtRegex value is provided, it will take precedence over this logSet value and logSet will be computed dynamically using logSetKey and logSetExtRegex.
- LogSet stringExt Regex 
- The regex to be applied against given logSetKey. Regex has to be in string escaped format.
- LogSet stringKey 
- An optional parameter to indicate from where the logSet to be extracted using logSetExtRegex. Default value is OBJECT_PATH (e.g. /n//b//o/).
- LogSource stringName 
- Name of the Logging Analytics Source to use for the processing.
- LogType string
- Type of files/objects in this object collection rule.
- Name string
- A filter to return rules only matching with this name.
- Namespace string
- The Logging Analytics namespace used for the request.
- ObjectName []stringFilters 
- 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.
- OsBucket stringName 
- Name of the Object Storage bucket.
- OsNamespace string
- Object Storage namespace.
- Overrides
[]GetLog Analytics Object Collection Rules Log Analytics Object Collection Rule Collection Item Override 
- 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
- Lifecycle state filter.
- 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.
- Timezone string
- Timezone to be used when processing log entries whose timestamps do not include an explicit timezone. When this property is not specified, the timezone of the entity specified is used. If the entity is also not specified or do not have a valid timezone then UTC is used.
- 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 ID of the compartment in which to list resources.
- Map<String,String>
- 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.
- Map<String,String>
- Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
- id String
- The OCID of this rule.
- isEnabled Boolean
- Whether or not this rule is currently enabled.
- isForce BooleanHistoric Collection 
- Flag to allow historic collection if poll period overlaps with existing ACTIVE collection rule
- lifecycleDetails String
- A detailed status of the life cycle state.
- logGroup StringId 
- Logging Analytics Log group OCID to associate the processed logs with.
- logSet String
- The logSet to be associated with the processed logs. The logSet feature can be used by customers with high volume of data and this feature has to be enabled for a given tenancy prior to its usage. When logSetExtRegex value is provided, it will take precedence over this logSet value and logSet will be computed dynamically using logSetKey and logSetExtRegex.
- logSet StringExt Regex 
- The regex to be applied against given logSetKey. Regex has to be in string escaped format.
- logSet StringKey 
- An optional parameter to indicate from where the logSet to be extracted using logSetExtRegex. Default value is OBJECT_PATH (e.g. /n//b//o/).
- logSource StringName 
- Name of the Logging Analytics Source to use for the processing.
- logType String
- Type of files/objects in this object collection rule.
- name String
- A filter to return rules only matching with this name.
- namespace String
- The Logging Analytics namespace used for the request.
- objectName List<String>Filters 
- 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.
- osBucket StringName 
- Name of the Object Storage bucket.
- osNamespace String
- Object Storage namespace.
- overrides
List<GetObject Collection Rules Object Collection Rule Collection Item Override> 
- 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
- Lifecycle state filter.
- 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.
- timezone String
- Timezone to be used when processing log entries whose timestamps do not include an explicit timezone. When this property is not specified, the timezone of the entity specified is used. If the entity is also not specified or do not have a valid timezone then UTC is used.
- 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 ID of the compartment in which to list resources.
- {[key: string]: string}
- 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.
- {[key: string]: string}
- Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
- id string
- The OCID of this rule.
- isEnabled boolean
- Whether or not this rule is currently enabled.
- isForce booleanHistoric Collection 
- Flag to allow historic collection if poll period overlaps with existing ACTIVE collection rule
- lifecycleDetails string
- A detailed status of the life cycle state.
- logGroup stringId 
- Logging Analytics Log group OCID to associate the processed logs with.
- logSet string
- The logSet to be associated with the processed logs. The logSet feature can be used by customers with high volume of data and this feature has to be enabled for a given tenancy prior to its usage. When logSetExtRegex value is provided, it will take precedence over this logSet value and logSet will be computed dynamically using logSetKey and logSetExtRegex.
- logSet stringExt Regex 
- The regex to be applied against given logSetKey. Regex has to be in string escaped format.
- logSet stringKey 
- An optional parameter to indicate from where the logSet to be extracted using logSetExtRegex. Default value is OBJECT_PATH (e.g. /n//b//o/).
- logSource stringName 
- Name of the Logging Analytics Source to use for the processing.
- logType string
- Type of files/objects in this object collection rule.
- name string
- A filter to return rules only matching with this name.
- namespace string
- The Logging Analytics namespace used for the request.
- objectName string[]Filters 
- 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.
- osBucket stringName 
- Name of the Object Storage bucket.
- osNamespace string
- Object Storage namespace.
- overrides
GetLog Analytics Object Collection Rules Log Analytics Object Collection Rule Collection Item Override[] 
- 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
- Lifecycle state filter.
- 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.
- timezone string
- Timezone to be used when processing log entries whose timestamps do not include an explicit timezone. When this property is not specified, the timezone of the entity specified is used. If the entity is also not specified or do not have a valid timezone then UTC is used.
- 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 ID of the compartment in which to list resources.
- Mapping[str, str]
- 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.
- Mapping[str, str]
- Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
- id str
- The OCID of this rule.
- is_enabled bool
- Whether or not this rule is currently enabled.
- is_force_ boolhistoric_ collection 
- Flag to allow historic collection if poll period overlaps with existing ACTIVE collection rule
- lifecycle_details str
- A detailed status of the life cycle state.
- log_group_ strid 
- Logging Analytics Log group OCID to associate the processed logs with.
- log_set str
- The logSet to be associated with the processed logs. The logSet feature can be used by customers with high volume of data and this feature has to be enabled for a given tenancy prior to its usage. When logSetExtRegex value is provided, it will take precedence over this logSet value and logSet will be computed dynamically using logSetKey and logSetExtRegex.
- log_set_ strext_ regex 
- The regex to be applied against given logSetKey. Regex has to be in string escaped format.
- log_set_ strkey 
- An optional parameter to indicate from where the logSet to be extracted using logSetExtRegex. Default value is OBJECT_PATH (e.g. /n//b//o/).
- log_source_ strname 
- Name of the Logging Analytics Source to use for the processing.
- log_type str
- Type of files/objects in this object collection rule.
- name str
- A filter to return rules only matching with this name.
- namespace str
- The Logging Analytics namespace used for the request.
- object_name_ Sequence[str]filters 
- 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_ strname 
- Name of the Object Storage bucket.
- os_namespace str
- Object Storage namespace.
- overrides
Sequence[GetLog Analytics Object Collection Rules Log Analytics Object Collection Rule Collection Item Override] 
- 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
- Lifecycle state filter.
- 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.
- timezone str
- Timezone to be used when processing log entries whose timestamps do not include an explicit timezone. When this property is not specified, the timezone of the entity specified is used. If the entity is also not specified or do not have a valid timezone then UTC is used.
- 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 ID of the compartment in which to list resources.
- Map<String>
- 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.
- Map<String>
- Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
- id String
- The OCID of this rule.
- isEnabled Boolean
- Whether or not this rule is currently enabled.
- isForce BooleanHistoric Collection 
- Flag to allow historic collection if poll period overlaps with existing ACTIVE collection rule
- lifecycleDetails String
- A detailed status of the life cycle state.
- logGroup StringId 
- Logging Analytics Log group OCID to associate the processed logs with.
- logSet String
- The logSet to be associated with the processed logs. The logSet feature can be used by customers with high volume of data and this feature has to be enabled for a given tenancy prior to its usage. When logSetExtRegex value is provided, it will take precedence over this logSet value and logSet will be computed dynamically using logSetKey and logSetExtRegex.
- logSet StringExt Regex 
- The regex to be applied against given logSetKey. Regex has to be in string escaped format.
- logSet StringKey 
- An optional parameter to indicate from where the logSet to be extracted using logSetExtRegex. Default value is OBJECT_PATH (e.g. /n//b//o/).
- logSource StringName 
- Name of the Logging Analytics Source to use for the processing.
- logType String
- Type of files/objects in this object collection rule.
- name String
- A filter to return rules only matching with this name.
- namespace String
- The Logging Analytics namespace used for the request.
- objectName List<String>Filters 
- 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.
- osBucket StringName 
- 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
- Lifecycle state filter.
- 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.
- timezone String
- Timezone to be used when processing log entries whose timestamps do not include an explicit timezone. When this property is not specified, the timezone of the entity specified is used. If the entity is also not specified or do not have a valid timezone then UTC is used.
GetLogAnalyticsObjectCollectionRulesLogAnalyticsObjectCollectionRuleCollectionItemOverride             
- MatchType string
- MatchValue string
- PropertyName string
- PropertyValue string
- MatchType string
- MatchValue string
- PropertyName string
- PropertyValue string
- matchType String
- matchValue String
- propertyName String
- propertyValue String
- matchType string
- matchValue string
- propertyName string
- propertyValue string
- match_type str
- match_value str
- property_name str
- property_value str
- matchType String
- matchValue String
- propertyName String
- propertyValue String
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the ociTerraform Provider.