Oracle Cloud Infrastructure

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

getLogAnalyticsCategoriesList

This data source provides details about Categories in Oracle Cloud Infrastructure Log Analytics service.

Returns a list of categories, containing detailed information about them. You may limit the number of results, provide sorting order, and filter by information such as category name or description.

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var testLogAnalyticsCategoriesList = Oci.LogAnalytics.GetLogAnalyticsCategoriesList.Invoke(new()
    {
        Namespace = @var.Log_analytics_categories_list_namespace,
        CategoryDisplayText = @var.Log_analytics_categories_list_category_display_text,
        CategoryType = @var.Log_analytics_categories_list_category_type,
        Name = @var.Log_analytics_categories_list_name,
    });

});
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.GetLogAnalyticsCategoriesList(ctx, &loganalytics.GetLogAnalyticsCategoriesListArgs{
			Namespace:           _var.Log_analytics_categories_list_namespace,
			CategoryDisplayText: pulumi.StringRef(_var.Log_analytics_categories_list_category_display_text),
			CategoryType:        pulumi.StringRef(_var.Log_analytics_categories_list_category_type),
			Name:                pulumi.StringRef(_var.Log_analytics_categories_list_name),
		}, 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.GetLogAnalyticsCategoriesListArgs;
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 testLogAnalyticsCategoriesList = LogAnalyticsFunctions.getLogAnalyticsCategoriesList(GetLogAnalyticsCategoriesListArgs.builder()
            .namespace(var_.log_analytics_categories_list_namespace())
            .categoryDisplayText(var_.log_analytics_categories_list_category_display_text())
            .categoryType(var_.log_analytics_categories_list_category_type())
            .name(var_.log_analytics_categories_list_name())
            .build());

    }
}
import pulumi
import pulumi_oci as oci

test_log_analytics_categories_list = oci.LogAnalytics.get_log_analytics_categories_list(namespace=var["log_analytics_categories_list_namespace"],
    category_display_text=var["log_analytics_categories_list_category_display_text"],
    category_type=var["log_analytics_categories_list_category_type"],
    name=var["log_analytics_categories_list_name"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testLogAnalyticsCategoriesList = oci.LogAnalytics.getLogAnalyticsCategoriesList({
    namespace: _var.log_analytics_categories_list_namespace,
    categoryDisplayText: _var.log_analytics_categories_list_category_display_text,
    categoryType: _var.log_analytics_categories_list_category_type,
    name: _var.log_analytics_categories_list_name,
});
variables:
  testLogAnalyticsCategoriesList:
    Fn::Invoke:
      Function: oci:LogAnalytics:getLogAnalyticsCategoriesList
      Arguments:
        namespace: ${var.log_analytics_categories_list_namespace}
        categoryDisplayText: ${var.log_analytics_categories_list_category_display_text}
        categoryType: ${var.log_analytics_categories_list_category_type}
        name: ${var.log_analytics_categories_list_name}

Using getLogAnalyticsCategoriesList

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 getLogAnalyticsCategoriesList(args: GetLogAnalyticsCategoriesListArgs, opts?: InvokeOptions): Promise<GetLogAnalyticsCategoriesListResult>
function getLogAnalyticsCategoriesListOutput(args: GetLogAnalyticsCategoriesListOutputArgs, opts?: InvokeOptions): Output<GetLogAnalyticsCategoriesListResult>
def get_log_analytics_categories_list(category_display_text: Optional[str] = None,
                                      category_type: Optional[str] = None,
                                      name: Optional[str] = None,
                                      namespace: Optional[str] = None,
                                      opts: Optional[InvokeOptions] = None) -> GetLogAnalyticsCategoriesListResult
def get_log_analytics_categories_list_output(category_display_text: Optional[pulumi.Input[str]] = None,
                                      category_type: Optional[pulumi.Input[str]] = None,
                                      name: Optional[pulumi.Input[str]] = None,
                                      namespace: Optional[pulumi.Input[str]] = None,
                                      opts: Optional[InvokeOptions] = None) -> Output[GetLogAnalyticsCategoriesListResult]
func GetLogAnalyticsCategoriesList(ctx *Context, args *GetLogAnalyticsCategoriesListArgs, opts ...InvokeOption) (*GetLogAnalyticsCategoriesListResult, error)
func GetLogAnalyticsCategoriesListOutput(ctx *Context, args *GetLogAnalyticsCategoriesListOutputArgs, opts ...InvokeOption) GetLogAnalyticsCategoriesListResultOutput

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

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

The following arguments are supported:

Namespace string

The Logging Analytics namespace used for the request.

CategoryDisplayText string

The category display text used for filtering. Only categories matching the specified display name or description will be returned.

CategoryType string

A comma-separated list of category types used for filtering. Only categories of the specified types will be returned.

Name string

A filter to return only log analytics category whose name matches the entire name given. The match is case-insensitive.

Namespace string

The Logging Analytics namespace used for the request.

CategoryDisplayText string

The category display text used for filtering. Only categories matching the specified display name or description will be returned.

CategoryType string

A comma-separated list of category types used for filtering. Only categories of the specified types will be returned.

Name string

A filter to return only log analytics category whose name matches the entire name given. The match is case-insensitive.

namespace String

The Logging Analytics namespace used for the request.

categoryDisplayText String

The category display text used for filtering. Only categories matching the specified display name or description will be returned.

categoryType String

A comma-separated list of category types used for filtering. Only categories of the specified types will be returned.

name String

A filter to return only log analytics category whose name matches the entire name given. The match is case-insensitive.

namespace string

The Logging Analytics namespace used for the request.

categoryDisplayText string

The category display text used for filtering. Only categories matching the specified display name or description will be returned.

categoryType string

A comma-separated list of category types used for filtering. Only categories of the specified types will be returned.

name string

A filter to return only log analytics category whose name matches the entire name given. The match is case-insensitive.

namespace str

The Logging Analytics namespace used for the request.

category_display_text str

The category display text used for filtering. Only categories matching the specified display name or description will be returned.

category_type str

A comma-separated list of category types used for filtering. Only categories of the specified types will be returned.

name str

A filter to return only log analytics category whose name matches the entire name given. The match is case-insensitive.

namespace String

The Logging Analytics namespace used for the request.

categoryDisplayText String

The category display text used for filtering. Only categories matching the specified display name or description will be returned.

categoryType String

A comma-separated list of category types used for filtering. Only categories of the specified types will be returned.

name String

A filter to return only log analytics category whose name matches the entire name given. The match is case-insensitive.

getLogAnalyticsCategoriesList Result

The following output properties are available:

Id string

The provider-assigned unique ID for this managed resource.

Items List<GetLogAnalyticsCategoriesListItem>

An array of categories.

Namespace string
CategoryDisplayText string
CategoryType string
Name string

The unique name that identifies the category.

Id string

The provider-assigned unique ID for this managed resource.

Items []GetLogAnalyticsCategoriesListItem

An array of categories.

Namespace string
CategoryDisplayText string
CategoryType string
Name string

The unique name that identifies the category.

id String

The provider-assigned unique ID for this managed resource.

items List<GetCategoriesListItem>

An array of categories.

namespace String
categoryDisplayText String
categoryType String
name String

The unique name that identifies the category.

id string

The provider-assigned unique ID for this managed resource.

items GetLogAnalyticsCategoriesListItem[]

An array of categories.

namespace string
categoryDisplayText string
categoryType string
name string

The unique name that identifies the category.

id str

The provider-assigned unique ID for this managed resource.

items GetLogAnalyticsCategoriesListItem]

An array of categories.

namespace str
category_display_text str
category_type str
name str

The unique name that identifies the category.

id String

The provider-assigned unique ID for this managed resource.

items List<Property Map>

An array of categories.

namespace String
categoryDisplayText String
categoryType String
name String

The unique name that identifies the category.

Supporting Types

GetLogAnalyticsCategoriesListItem

Description string

The category description.

DisplayName string

The category display name.

IsSystem bool

The system flag. A value of false denotes a user-created category. A value of true denotes an Oracle-defined category.

Name string

A filter to return only log analytics category whose name matches the entire name given. The match is case-insensitive.

Type string

The category type. Values include "PRODUCT", "TIER", "VENDOR" and "GENERIC".

Description string

The category description.

DisplayName string

The category display name.

IsSystem bool

The system flag. A value of false denotes a user-created category. A value of true denotes an Oracle-defined category.

Name string

A filter to return only log analytics category whose name matches the entire name given. The match is case-insensitive.

Type string

The category type. Values include "PRODUCT", "TIER", "VENDOR" and "GENERIC".

description String

The category description.

displayName String

The category display name.

isSystem Boolean

The system flag. A value of false denotes a user-created category. A value of true denotes an Oracle-defined category.

name String

A filter to return only log analytics category whose name matches the entire name given. The match is case-insensitive.

type String

The category type. Values include "PRODUCT", "TIER", "VENDOR" and "GENERIC".

description string

The category description.

displayName string

The category display name.

isSystem boolean

The system flag. A value of false denotes a user-created category. A value of true denotes an Oracle-defined category.

name string

A filter to return only log analytics category whose name matches the entire name given. The match is case-insensitive.

type string

The category type. Values include "PRODUCT", "TIER", "VENDOR" and "GENERIC".

description str

The category description.

display_name str

The category display name.

is_system bool

The system flag. A value of false denotes a user-created category. A value of true denotes an Oracle-defined category.

name str

A filter to return only log analytics category whose name matches the entire name given. The match is case-insensitive.

type str

The category type. Values include "PRODUCT", "TIER", "VENDOR" and "GENERIC".

description String

The category description.

displayName String

The category display name.

isSystem Boolean

The system flag. A value of false denotes a user-created category. A value of true denotes an Oracle-defined category.

name String

A filter to return only log analytics category whose name matches the entire name given. The match is case-insensitive.

type String

The category type. Values include "PRODUCT", "TIER", "VENDOR" and "GENERIC".

Package Details

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

This Pulumi package is based on the oci Terraform Provider.