Docs Packages
  1. Packages
  2. Sumo Logic
  3. API Docs
  4. MetricsSearch
Sumo Logic v0.22.1 published on Sunday, Jun 9, 2024 by Pulumi
pulumi/pulumi-sumologic

sumologic.MetricsSearch

Explore with Pulumi AI

sumologic logo
Sumo Logic v0.22.1 published on Sunday, Jun 9, 2024 by Pulumi
pulumi/pulumi-sumologic

    Provides a Sumologic Metrics Search.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as sumologic from "@pulumi/sumologic";

const personalFolder = sumologic.getPersonalFolder({});
const exampleMetricsSearch = new sumologic.MetricsSearch("example_metrics_search", {
    title: "Demo Metrics Search",
    description: "Demo search description",
    parentId: personalFolder.then(personalFolder => personalFolder.id),
    metricsQueries: [{
        rowId: "A",
        query: "metric=cpu_idle | avg",
    }],
    desiredQuantizationInSecs: 0,
    timeRange: {
        beginBoundedTimeRange: {
            from: {
                relativeTimeRange: {
                    relativeTime: "-30m",
                },
            },
        },
    },
});

    import pulumi
import pulumi_sumologic as sumologic

personal_folder = sumologic.get_personal_folder()
example_metrics_search = sumologic.MetricsSearch("example_metrics_search",
    title="Demo Metrics Search",
    description="Demo search description",
    parent_id=personal_folder.id,
    metrics_queries=[sumologic.MetricsSearchMetricsQueryArgs(
        row_id="A",
        query="metric=cpu_idle | avg",
    )],
    desired_quantization_in_secs=0,
    time_range=sumologic.MetricsSearchTimeRangeArgs(
        begin_bounded_time_range=sumologic.MetricsSearchTimeRangeBeginBoundedTimeRangeArgs(
            from_=sumologic.MetricsSearchTimeRangeBeginBoundedTimeRangeFromArgs(
                relative_time_range=sumologic.MetricsSearchTimeRangeBeginBoundedTimeRangeFromRelativeTimeRangeArgs(
                    relative_time="-30m",
                ),
            ),
        ),
    ))

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		personalFolder, err := sumologic.GetPersonalFolder(ctx, nil, nil)
		if err != nil {
			return err
		}
		_, err = sumologic.NewMetricsSearch(ctx, "example_metrics_search", &sumologic.MetricsSearchArgs{
			Title:       pulumi.String("Demo Metrics Search"),
			Description: pulumi.String("Demo search description"),
			ParentId:    pulumi.String(personalFolder.Id),
			MetricsQueries: sumologic.MetricsSearchMetricsQueryArray{
				&sumologic.MetricsSearchMetricsQueryArgs{
					RowId: pulumi.String("A"),
					Query: pulumi.String("metric=cpu_idle | avg"),
				},
			},
			DesiredQuantizationInSecs: pulumi.Int(0),
			TimeRange: &sumologic.MetricsSearchTimeRangeArgs{
				BeginBoundedTimeRange: &sumologic.MetricsSearchTimeRangeBeginBoundedTimeRangeArgs{
					From: &sumologic.MetricsSearchTimeRangeBeginBoundedTimeRangeFromArgs{
						RelativeTimeRange: &sumologic.MetricsSearchTimeRangeBeginBoundedTimeRangeFromRelativeTimeRangeArgs{
							RelativeTime: pulumi.String("-30m"),
						},
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using SumoLogic = Pulumi.SumoLogic;

return await Deployment.RunAsync(() => 
{
    var personalFolder = SumoLogic.GetPersonalFolder.Invoke();

    var exampleMetricsSearch = new SumoLogic.MetricsSearch("example_metrics_search", new()
    {
        Title = "Demo Metrics Search",
        Description = "Demo search description",
        ParentId = personalFolder.Apply(getPersonalFolderResult => getPersonalFolderResult.Id),
        MetricsQueries = new[]
        {
            new SumoLogic.Inputs.MetricsSearchMetricsQueryArgs
            {
                RowId = "A",
                Query = "metric=cpu_idle | avg",
            },
        },
        DesiredQuantizationInSecs = 0,
        TimeRange = new SumoLogic.Inputs.MetricsSearchTimeRangeArgs
        {
            BeginBoundedTimeRange = new SumoLogic.Inputs.MetricsSearchTimeRangeBeginBoundedTimeRangeArgs
            {
                From = new SumoLogic.Inputs.MetricsSearchTimeRangeBeginBoundedTimeRangeFromArgs
                {
                    RelativeTimeRange = new SumoLogic.Inputs.MetricsSearchTimeRangeBeginBoundedTimeRangeFromRelativeTimeRangeArgs
                    {
                        RelativeTime = "-30m",
                    },
                },
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.sumologic.SumologicFunctions;
import com.pulumi.sumologic.inputs.GetPersonalFolderArgs;
import com.pulumi.sumologic.MetricsSearch;
import com.pulumi.sumologic.MetricsSearchArgs;
import com.pulumi.sumologic.inputs.MetricsSearchMetricsQueryArgs;
import com.pulumi.sumologic.inputs.MetricsSearchTimeRangeArgs;
import com.pulumi.sumologic.inputs.MetricsSearchTimeRangeBeginBoundedTimeRangeArgs;
import com.pulumi.sumologic.inputs.MetricsSearchTimeRangeBeginBoundedTimeRangeFromArgs;
import com.pulumi.sumologic.inputs.MetricsSearchTimeRangeBeginBoundedTimeRangeFromRelativeTimeRangeArgs;
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 personalFolder = SumologicFunctions.getPersonalFolder();

        var exampleMetricsSearch = new MetricsSearch("exampleMetricsSearch", MetricsSearchArgs.builder()
            .title("Demo Metrics Search")
            .description("Demo search description")
            .parentId(personalFolder.applyValue(getPersonalFolderResult -> getPersonalFolderResult.id()))
            .metricsQueries(MetricsSearchMetricsQueryArgs.builder()
                .rowId("A")
                .query("metric=cpu_idle | avg")
                .build())
            .desiredQuantizationInSecs(0)
            .timeRange(MetricsSearchTimeRangeArgs.builder()
                .beginBoundedTimeRange(MetricsSearchTimeRangeBeginBoundedTimeRangeArgs.builder()
                    .from(MetricsSearchTimeRangeBeginBoundedTimeRangeFromArgs.builder()
                        .relativeTimeRange(MetricsSearchTimeRangeBeginBoundedTimeRangeFromRelativeTimeRangeArgs.builder()
                            .relativeTime("-30m")
                            .build())
                        .build())
                    .build())
                .build())
            .build());

    }
}

    resources:
  exampleMetricsSearch:
    type: sumologic:MetricsSearch
    name: example_metrics_search
    properties:
      title: Demo Metrics Search
      description: Demo search description
      parentId: ${personalFolder.id}
      metricsQueries:
        - rowId: A
          query: metric=cpu_idle | avg
      desiredQuantizationInSecs: 0
      timeRange:
        beginBoundedTimeRange:
          from:
            relativeTimeRange:
              relativeTime: -30m
variables:
  personalFolder:
    fn::invoke:
      Function: sumologic:getPersonalFolder
      Arguments: {}

    Attributes reference

    In addition to all arguments above, the following attributes are exported:

    • id - The ID of the log search.

    Create MetricsSearch Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new MetricsSearch(name: string, args: MetricsSearchArgs, opts?: CustomResourceOptions);
    @overload
def MetricsSearch(resource_name: str,
                  args: MetricsSearchArgs,
                  opts: Optional[ResourceOptions] = None)

@overload
def MetricsSearch(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  description: Optional[str] = None,
                  metrics_queries: Optional[Sequence[MetricsSearchMetricsQueryArgs]] = None,
                  parent_id: Optional[str] = None,
                  time_range: Optional[MetricsSearchTimeRangeArgs] = None,
                  title: Optional[str] = None,
                  desired_quantization_in_secs: Optional[int] = None,
                  log_query: Optional[str] = None)
    func NewMetricsSearch(ctx *Context, name string, args MetricsSearchArgs, opts ...ResourceOption) (*MetricsSearch, error)
    public MetricsSearch(string name, MetricsSearchArgs args, CustomResourceOptions? opts = null)
    public MetricsSearch(String name, MetricsSearchArgs args)
public MetricsSearch(String name, MetricsSearchArgs args, CustomResourceOptions options)

    type: sumologic:MetricsSearch
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 MetricsSearchArgs
    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 MetricsSearchArgs
    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 MetricsSearchArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args MetricsSearchArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args MetricsSearchArgs
    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 metricsSearchResource = new SumoLogic.MetricsSearch("metricsSearchResource", new()
{
    Description = "string",
    MetricsQueries = new[]
    {
        new SumoLogic.Inputs.MetricsSearchMetricsQueryArgs
        {
            Query = "string",
            RowId = "string",
        },
    },
    ParentId = "string",
    TimeRange = new SumoLogic.Inputs.MetricsSearchTimeRangeArgs
    {
        BeginBoundedTimeRange = new SumoLogic.Inputs.MetricsSearchTimeRangeBeginBoundedTimeRangeArgs
        {
            From = new SumoLogic.Inputs.MetricsSearchTimeRangeBeginBoundedTimeRangeFromArgs
            {
                EpochTimeRange = new SumoLogic.Inputs.MetricsSearchTimeRangeBeginBoundedTimeRangeFromEpochTimeRangeArgs
                {
                    EpochMillis = 0,
                },
                Iso8601TimeRange = new SumoLogic.Inputs.MetricsSearchTimeRangeBeginBoundedTimeRangeFromIso8601TimeRangeArgs
                {
                    Iso8601Time = "string",
                },
                LiteralTimeRange = new SumoLogic.Inputs.MetricsSearchTimeRangeBeginBoundedTimeRangeFromLiteralTimeRangeArgs
                {
                    RangeName = "string",
                },
                RelativeTimeRange = new SumoLogic.Inputs.MetricsSearchTimeRangeBeginBoundedTimeRangeFromRelativeTimeRangeArgs
                {
                    RelativeTime = "string",
                },
            },
            To = new SumoLogic.Inputs.MetricsSearchTimeRangeBeginBoundedTimeRangeToArgs
            {
                EpochTimeRange = new SumoLogic.Inputs.MetricsSearchTimeRangeBeginBoundedTimeRangeToEpochTimeRangeArgs
                {
                    EpochMillis = 0,
                },
                Iso8601TimeRange = new SumoLogic.Inputs.MetricsSearchTimeRangeBeginBoundedTimeRangeToIso8601TimeRangeArgs
                {
                    Iso8601Time = "string",
                },
                LiteralTimeRange = new SumoLogic.Inputs.MetricsSearchTimeRangeBeginBoundedTimeRangeToLiteralTimeRangeArgs
                {
                    RangeName = "string",
                },
                RelativeTimeRange = new SumoLogic.Inputs.MetricsSearchTimeRangeBeginBoundedTimeRangeToRelativeTimeRangeArgs
                {
                    RelativeTime = "string",
                },
            },
        },
        CompleteLiteralTimeRange = new SumoLogic.Inputs.MetricsSearchTimeRangeCompleteLiteralTimeRangeArgs
        {
            RangeName = "string",
        },
    },
    Title = "string",
    DesiredQuantizationInSecs = 0,
    LogQuery = "string",
});

    example, err := sumologic.NewMetricsSearch(ctx, "metricsSearchResource", &sumologic.MetricsSearchArgs{
	Description: pulumi.String("string"),
	MetricsQueries: sumologic.MetricsSearchMetricsQueryArray{
		&sumologic.MetricsSearchMetricsQueryArgs{
			Query: pulumi.String("string"),
			RowId: pulumi.String("string"),
		},
	},
	ParentId: pulumi.String("string"),
	TimeRange: &sumologic.MetricsSearchTimeRangeArgs{
		BeginBoundedTimeRange: &sumologic.MetricsSearchTimeRangeBeginBoundedTimeRangeArgs{
			From: &sumologic.MetricsSearchTimeRangeBeginBoundedTimeRangeFromArgs{
				EpochTimeRange: &sumologic.MetricsSearchTimeRangeBeginBoundedTimeRangeFromEpochTimeRangeArgs{
					EpochMillis: pulumi.Int(0),
				},
				Iso8601TimeRange: &sumologic.MetricsSearchTimeRangeBeginBoundedTimeRangeFromIso8601TimeRangeArgs{
					Iso8601Time: pulumi.String("string"),
				},
				LiteralTimeRange: &sumologic.MetricsSearchTimeRangeBeginBoundedTimeRangeFromLiteralTimeRangeArgs{
					RangeName: pulumi.String("string"),
				},
				RelativeTimeRange: &sumologic.MetricsSearchTimeRangeBeginBoundedTimeRangeFromRelativeTimeRangeArgs{
					RelativeTime: pulumi.String("string"),
				},
			},
			To: &sumologic.MetricsSearchTimeRangeBeginBoundedTimeRangeToArgs{
				EpochTimeRange: &sumologic.MetricsSearchTimeRangeBeginBoundedTimeRangeToEpochTimeRangeArgs{
					EpochMillis: pulumi.Int(0),
				},
				Iso8601TimeRange: &sumologic.MetricsSearchTimeRangeBeginBoundedTimeRangeToIso8601TimeRangeArgs{
					Iso8601Time: pulumi.String("string"),
				},
				LiteralTimeRange: &sumologic.MetricsSearchTimeRangeBeginBoundedTimeRangeToLiteralTimeRangeArgs{
					RangeName: pulumi.String("string"),
				},
				RelativeTimeRange: &sumologic.MetricsSearchTimeRangeBeginBoundedTimeRangeToRelativeTimeRangeArgs{
					RelativeTime: pulumi.String("string"),
				},
			},
		},
		CompleteLiteralTimeRange: &sumologic.MetricsSearchTimeRangeCompleteLiteralTimeRangeArgs{
			RangeName: pulumi.String("string"),
		},
	},
	Title:                     pulumi.String("string"),
	DesiredQuantizationInSecs: pulumi.Int(0),
	LogQuery:                  pulumi.String("string"),
})

    var metricsSearchResource = new MetricsSearch("metricsSearchResource", MetricsSearchArgs.builder()
    .description("string")
    .metricsQueries(MetricsSearchMetricsQueryArgs.builder()
        .query("string")
        .rowId("string")
        .build())
    .parentId("string")
    .timeRange(MetricsSearchTimeRangeArgs.builder()
        .beginBoundedTimeRange(MetricsSearchTimeRangeBeginBoundedTimeRangeArgs.builder()
            .from(MetricsSearchTimeRangeBeginBoundedTimeRangeFromArgs.builder()
                .epochTimeRange(MetricsSearchTimeRangeBeginBoundedTimeRangeFromEpochTimeRangeArgs.builder()
                    .epochMillis(0)
                    .build())
                .iso8601TimeRange(MetricsSearchTimeRangeBeginBoundedTimeRangeFromIso8601TimeRangeArgs.builder()
                    .iso8601Time("string")
                    .build())
                .literalTimeRange(MetricsSearchTimeRangeBeginBoundedTimeRangeFromLiteralTimeRangeArgs.builder()
                    .rangeName("string")
                    .build())
                .relativeTimeRange(MetricsSearchTimeRangeBeginBoundedTimeRangeFromRelativeTimeRangeArgs.builder()
                    .relativeTime("string")
                    .build())
                .build())
            .to(MetricsSearchTimeRangeBeginBoundedTimeRangeToArgs.builder()
                .epochTimeRange(MetricsSearchTimeRangeBeginBoundedTimeRangeToEpochTimeRangeArgs.builder()
                    .epochMillis(0)
                    .build())
                .iso8601TimeRange(MetricsSearchTimeRangeBeginBoundedTimeRangeToIso8601TimeRangeArgs.builder()
                    .iso8601Time("string")
                    .build())
                .literalTimeRange(MetricsSearchTimeRangeBeginBoundedTimeRangeToLiteralTimeRangeArgs.builder()
                    .rangeName("string")
                    .build())
                .relativeTimeRange(MetricsSearchTimeRangeBeginBoundedTimeRangeToRelativeTimeRangeArgs.builder()
                    .relativeTime("string")
                    .build())
                .build())
            .build())
        .completeLiteralTimeRange(MetricsSearchTimeRangeCompleteLiteralTimeRangeArgs.builder()
            .rangeName("string")
            .build())
        .build())
    .title("string")
    .desiredQuantizationInSecs(0)
    .logQuery("string")
    .build());

    metrics_search_resource = sumologic.MetricsSearch("metricsSearchResource",
    description="string",
    metrics_queries=[sumologic.MetricsSearchMetricsQueryArgs(
        query="string",
        row_id="string",
    )],
    parent_id="string",
    time_range=sumologic.MetricsSearchTimeRangeArgs(
        begin_bounded_time_range=sumologic.MetricsSearchTimeRangeBeginBoundedTimeRangeArgs(
            from_=sumologic.MetricsSearchTimeRangeBeginBoundedTimeRangeFromArgs(
                epoch_time_range=sumologic.MetricsSearchTimeRangeBeginBoundedTimeRangeFromEpochTimeRangeArgs(
                    epoch_millis=0,
                ),
                iso8601_time_range=sumologic.MetricsSearchTimeRangeBeginBoundedTimeRangeFromIso8601TimeRangeArgs(
                    iso8601_time="string",
                ),
                literal_time_range=sumologic.MetricsSearchTimeRangeBeginBoundedTimeRangeFromLiteralTimeRangeArgs(
                    range_name="string",
                ),
                relative_time_range=sumologic.MetricsSearchTimeRangeBeginBoundedTimeRangeFromRelativeTimeRangeArgs(
                    relative_time="string",
                ),
            ),
            to=sumologic.MetricsSearchTimeRangeBeginBoundedTimeRangeToArgs(
                epoch_time_range=sumologic.MetricsSearchTimeRangeBeginBoundedTimeRangeToEpochTimeRangeArgs(
                    epoch_millis=0,
                ),
                iso8601_time_range=sumologic.MetricsSearchTimeRangeBeginBoundedTimeRangeToIso8601TimeRangeArgs(
                    iso8601_time="string",
                ),
                literal_time_range=sumologic.MetricsSearchTimeRangeBeginBoundedTimeRangeToLiteralTimeRangeArgs(
                    range_name="string",
                ),
                relative_time_range=sumologic.MetricsSearchTimeRangeBeginBoundedTimeRangeToRelativeTimeRangeArgs(
                    relative_time="string",
                ),
            ),
        ),
        complete_literal_time_range=sumologic.MetricsSearchTimeRangeCompleteLiteralTimeRangeArgs(
            range_name="string",
        ),
    ),
    title="string",
    desired_quantization_in_secs=0,
    log_query="string")

    const metricsSearchResource = new sumologic.MetricsSearch("metricsSearchResource", {
    description: "string",
    metricsQueries: [{
        query: "string",
        rowId: "string",
    }],
    parentId: "string",
    timeRange: {
        beginBoundedTimeRange: {
            from: {
                epochTimeRange: {
                    epochMillis: 0,
                },
                iso8601TimeRange: {
                    iso8601Time: "string",
                },
                literalTimeRange: {
                    rangeName: "string",
                },
                relativeTimeRange: {
                    relativeTime: "string",
                },
            },
            to: {
                epochTimeRange: {
                    epochMillis: 0,
                },
                iso8601TimeRange: {
                    iso8601Time: "string",
                },
                literalTimeRange: {
                    rangeName: "string",
                },
                relativeTimeRange: {
                    relativeTime: "string",
                },
            },
        },
        completeLiteralTimeRange: {
            rangeName: "string",
        },
    },
    title: "string",
    desiredQuantizationInSecs: 0,
    logQuery: "string",
});

    type: sumologic:MetricsSearch
properties:
    description: string
    desiredQuantizationInSecs: 0
    logQuery: string
    metricsQueries:
        - query: string
          rowId: string
    parentId: string
    timeRange:
        beginBoundedTimeRange:
            from:
                epochTimeRange:
                    epochMillis: 0
                iso8601TimeRange:
                    iso8601Time: string
                literalTimeRange:
                    rangeName: string
                relativeTimeRange:
                    relativeTime: string
            to:
                epochTimeRange:
                    epochMillis: 0
                iso8601TimeRange:
                    iso8601Time: string
                literalTimeRange:
                    rangeName: string
                relativeTimeRange:
                    relativeTime: string
        completeLiteralTimeRange:
            rangeName: string
    title: string

    MetricsSearch Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The MetricsSearch resource accepts the following input properties:

    Description string
    Description of the search.
    MetricsQueries List<Pulumi.SumoLogic.Inputs.MetricsSearchMetricsQuery>
    Array of objects MetricsSearchQuery. Metrics queries, up to the maximum of six.
    ParentId string
    The identifier of the folder to create the log search in.
    TimeRange Pulumi.SumoLogic.Inputs.MetricsSearchTimeRange
    Time range of the log search. See time range schema
    Title string
    Title of the search.
    DesiredQuantizationInSecs int
    Desired quantization in seconds. Default value is 0.
    LogQuery string
    Log query used to add an overlay to the chart.
    Description string
    Description of the search.
    MetricsQueries []MetricsSearchMetricsQueryArgs
    Array of objects MetricsSearchQuery. Metrics queries, up to the maximum of six.
    ParentId string
    The identifier of the folder to create the log search in.
    TimeRange MetricsSearchTimeRangeArgs
    Time range of the log search. See time range schema
    Title string
    Title of the search.
    DesiredQuantizationInSecs int
    Desired quantization in seconds. Default value is 0.
    LogQuery string
    Log query used to add an overlay to the chart.
    description String
    Description of the search.
    metricsQueries List<MetricsSearchMetricsQuery>
    Array of objects MetricsSearchQuery. Metrics queries, up to the maximum of six.
    parentId String
    The identifier of the folder to create the log search in.
    timeRange MetricsSearchTimeRange
    Time range of the log search. See time range schema
    title String
    Title of the search.
    desiredQuantizationInSecs Integer
    Desired quantization in seconds. Default value is 0.
    logQuery String
    Log query used to add an overlay to the chart.
    description string
    Description of the search.
    metricsQueries MetricsSearchMetricsQuery[]
    Array of objects MetricsSearchQuery. Metrics queries, up to the maximum of six.
    parentId string
    The identifier of the folder to create the log search in.
    timeRange MetricsSearchTimeRange
    Time range of the log search. See time range schema
    title string
    Title of the search.
    desiredQuantizationInSecs number
    Desired quantization in seconds. Default value is 0.
    logQuery string
    Log query used to add an overlay to the chart.
    description str
    Description of the search.
    metrics_queries Sequence[MetricsSearchMetricsQueryArgs]
    Array of objects MetricsSearchQuery. Metrics queries, up to the maximum of six.
    parent_id str
    The identifier of the folder to create the log search in.
    time_range MetricsSearchTimeRangeArgs
    Time range of the log search. See time range schema
    title str
    Title of the search.
    desired_quantization_in_secs int
    Desired quantization in seconds. Default value is 0.
    log_query str
    Log query used to add an overlay to the chart.
    description String
    Description of the search.
    metricsQueries List<Property Map>
    Array of objects MetricsSearchQuery. Metrics queries, up to the maximum of six.
    parentId String
    The identifier of the folder to create the log search in.
    timeRange Property Map
    Time range of the log search. See time range schema
    title String
    Title of the search.
    desiredQuantizationInSecs Number
    Desired quantization in seconds. Default value is 0.
    logQuery String
    Log query used to add an overlay to the chart.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the MetricsSearch resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing MetricsSearch Resource

    Get an existing MetricsSearch 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?: MetricsSearchState, opts?: CustomResourceOptions): MetricsSearch
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        desired_quantization_in_secs: Optional[int] = None,
        log_query: Optional[str] = None,
        metrics_queries: Optional[Sequence[MetricsSearchMetricsQueryArgs]] = None,
        parent_id: Optional[str] = None,
        time_range: Optional[MetricsSearchTimeRangeArgs] = None,
        title: Optional[str] = None) -> MetricsSearch
    func GetMetricsSearch(ctx *Context, name string, id IDInput, state *MetricsSearchState, opts ...ResourceOption) (*MetricsSearch, error)
    public static MetricsSearch Get(string name, Input<string> id, MetricsSearchState? state, CustomResourceOptions? opts = null)
    public static MetricsSearch get(String name, Output<String> id, MetricsSearchState 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.
    The following state arguments are supported:
    Description string
    Description of the search.
    DesiredQuantizationInSecs int
    Desired quantization in seconds. Default value is 0.
    LogQuery string
    Log query used to add an overlay to the chart.
    MetricsQueries List<Pulumi.SumoLogic.Inputs.MetricsSearchMetricsQuery>
    Array of objects MetricsSearchQuery. Metrics queries, up to the maximum of six.
    ParentId string
    The identifier of the folder to create the log search in.
    TimeRange Pulumi.SumoLogic.Inputs.MetricsSearchTimeRange
    Time range of the log search. See time range schema
    Title string
    Title of the search.
    Description string
    Description of the search.
    DesiredQuantizationInSecs int
    Desired quantization in seconds. Default value is 0.
    LogQuery string
    Log query used to add an overlay to the chart.
    MetricsQueries []MetricsSearchMetricsQueryArgs
    Array of objects MetricsSearchQuery. Metrics queries, up to the maximum of six.
    ParentId string
    The identifier of the folder to create the log search in.
    TimeRange MetricsSearchTimeRangeArgs
    Time range of the log search. See time range schema
    Title string
    Title of the search.
    description String
    Description of the search.
    desiredQuantizationInSecs Integer
    Desired quantization in seconds. Default value is 0.
    logQuery String
    Log query used to add an overlay to the chart.
    metricsQueries List<MetricsSearchMetricsQuery>
    Array of objects MetricsSearchQuery. Metrics queries, up to the maximum of six.
    parentId String
    The identifier of the folder to create the log search in.
    timeRange MetricsSearchTimeRange
    Time range of the log search. See time range schema
    title String
    Title of the search.
    description string
    Description of the search.
    desiredQuantizationInSecs number
    Desired quantization in seconds. Default value is 0.
    logQuery string
    Log query used to add an overlay to the chart.
    metricsQueries MetricsSearchMetricsQuery[]
    Array of objects MetricsSearchQuery. Metrics queries, up to the maximum of six.
    parentId string
    The identifier of the folder to create the log search in.
    timeRange MetricsSearchTimeRange
    Time range of the log search. See time range schema
    title string
    Title of the search.
    description str
    Description of the search.
    desired_quantization_in_secs int
    Desired quantization in seconds. Default value is 0.
    log_query str
    Log query used to add an overlay to the chart.
    metrics_queries Sequence[MetricsSearchMetricsQueryArgs]
    Array of objects MetricsSearchQuery. Metrics queries, up to the maximum of six.
    parent_id str
    The identifier of the folder to create the log search in.
    time_range MetricsSearchTimeRangeArgs
    Time range of the log search. See time range schema
    title str
    Title of the search.
    description String
    Description of the search.
    desiredQuantizationInSecs Number
    Desired quantization in seconds. Default value is 0.
    logQuery String
    Log query used to add an overlay to the chart.
    metricsQueries List<Property Map>
    Array of objects MetricsSearchQuery. Metrics queries, up to the maximum of six.
    parentId String
    The identifier of the folder to create the log search in.
    timeRange Property Map
    Time range of the log search. See time range schema
    title String
    Title of the search.

    Supporting Types

    MetricsSearchMetricsQuery, MetricsSearchMetricsQueryArgs

    Query string
    RowId string
    Query string
    RowId string
    query String
    rowId String
    query string
    rowId string
    query str
    row_id str
    query String
    rowId String

    MetricsSearchTimeRange, MetricsSearchTimeRangeArgs

    MetricsSearchTimeRangeBeginBoundedTimeRange, MetricsSearchTimeRangeBeginBoundedTimeRangeArgs

    MetricsSearchTimeRangeBeginBoundedTimeRangeFrom, MetricsSearchTimeRangeBeginBoundedTimeRangeFromArgs

    MetricsSearchTimeRangeBeginBoundedTimeRangeFromEpochTimeRange, MetricsSearchTimeRangeBeginBoundedTimeRangeFromEpochTimeRangeArgs

    epochMillis Integer

    MetricsSearchTimeRangeBeginBoundedTimeRangeFromIso8601TimeRange, MetricsSearchTimeRangeBeginBoundedTimeRangeFromIso8601TimeRangeArgs

    MetricsSearchTimeRangeBeginBoundedTimeRangeFromLiteralTimeRange, MetricsSearchTimeRangeBeginBoundedTimeRangeFromLiteralTimeRangeArgs

    RangeName string
    RangeName string
    rangeName String
    rangeName string
    rangeName String

    MetricsSearchTimeRangeBeginBoundedTimeRangeFromRelativeTimeRange, MetricsSearchTimeRangeBeginBoundedTimeRangeFromRelativeTimeRangeArgs

    MetricsSearchTimeRangeBeginBoundedTimeRangeTo, MetricsSearchTimeRangeBeginBoundedTimeRangeToArgs

    MetricsSearchTimeRangeBeginBoundedTimeRangeToEpochTimeRange, MetricsSearchTimeRangeBeginBoundedTimeRangeToEpochTimeRangeArgs

    epochMillis Integer

    MetricsSearchTimeRangeBeginBoundedTimeRangeToIso8601TimeRange, MetricsSearchTimeRangeBeginBoundedTimeRangeToIso8601TimeRangeArgs

    MetricsSearchTimeRangeBeginBoundedTimeRangeToLiteralTimeRange, MetricsSearchTimeRangeBeginBoundedTimeRangeToLiteralTimeRangeArgs

    RangeName string
    RangeName string
    rangeName String
    rangeName string
    rangeName String

    MetricsSearchTimeRangeBeginBoundedTimeRangeToRelativeTimeRange, MetricsSearchTimeRangeBeginBoundedTimeRangeToRelativeTimeRangeArgs

    MetricsSearchTimeRangeCompleteLiteralTimeRange, MetricsSearchTimeRangeCompleteLiteralTimeRangeArgs

    RangeName string
    RangeName string
    rangeName String
    rangeName string
    rangeName String

    Import

    A metrics search can be imported using it’s identifier, e.g.:

    hcl

    $ pulumi import sumologic:index/metricsSearch:MetricsSearch example_search 0000000007FFD79D

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Sumo Logic pulumi/pulumi-sumologic
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the sumologic Terraform Provider.
    sumologic logo
    Sumo Logic v0.22.1 published on Sunday, Jun 9, 2024 by Pulumi
    pulumi/pulumi-sumologic