SavedSearchArgs

data class SavedSearchArgs(val category: Output<String>? = null, val displayName: Output<String>? = null, val functionAlias: Output<String>? = null, val functionParameters: Output<String>? = null, val query: Output<String>? = null, val resourceGroupName: Output<String>? = null, val savedSearchId: Output<String>? = null, val tags: Output<List<TagArgs>>? = null, val version: Output<Double>? = null, val workspaceName: Output<String>? = null) : ConvertibleToJava<SavedSearchArgs>

Value object for saved search results. Uses Azure REST API version 2023-09-01. In version 2.x of the Azure Native provider, it used API version 2020-08-01. Other available API versions: 2020-03-01-preview, 2020-08-01, 2025-02-01. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native operationalinsights [ApiVersion]. See the ../../../version-guide/#accessing-any-api-version-via-local-packages for details.

Example Usage

SavedSearchCreateOrUpdate

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var savedSearch = new AzureNative.OperationalInsights.SavedSearch("savedSearch", new()
{
Category = "Saved Search Test Category",
DisplayName = "Create or Update Saved Search Test",
FunctionAlias = "heartbeat_func",
FunctionParameters = "a:int=1",
Query = "Heartbeat | summarize Count() by Computer | take a",
ResourceGroupName = "TestRG",
SavedSearchId = "00000000-0000-0000-0000-00000000000",
Tags = new[]
{
new AzureNative.OperationalInsights.Inputs.TagArgs
{
Name = "Group",
Value = "Computer",
},
},
Version = 2,
WorkspaceName = "TestWS",
});
});
package main
import (
operationalinsights "github.com/pulumi/pulumi-azure-native-sdk/operationalinsights/v3"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := operationalinsights.NewSavedSearch(ctx, "savedSearch", &operationalinsights.SavedSearchArgs{
Category: pulumi.String("Saved Search Test Category"),
DisplayName: pulumi.String("Create or Update Saved Search Test"),
FunctionAlias: pulumi.String("heartbeat_func"),
FunctionParameters: pulumi.String("a:int=1"),
Query: pulumi.String("Heartbeat | summarize Count() by Computer | take a"),
ResourceGroupName: pulumi.String("TestRG"),
SavedSearchId: pulumi.String("00000000-0000-0000-0000-00000000000"),
Tags: operationalinsights.TagArray{
&operationalinsights.TagArgs{
Name: pulumi.String("Group"),
Value: pulumi.String("Computer"),
},
},
Version: pulumi.Float64(2),
WorkspaceName: pulumi.String("TestWS"),
})
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.azurenative.operationalinsights.SavedSearch;
import com.pulumi.azurenative.operationalinsights.SavedSearchArgs;
import com.pulumi.azurenative.operationalinsights.inputs.TagArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var savedSearch = new SavedSearch("savedSearch", SavedSearchArgs.builder()
.category("Saved Search Test Category")
.displayName("Create or Update Saved Search Test")
.functionAlias("heartbeat_func")
.functionParameters("a:int=1")
.query("Heartbeat | summarize Count() by Computer | take a")
.resourceGroupName("TestRG")
.savedSearchId("00000000-0000-0000-0000-00000000000")
.tags(TagArgs.builder()
.name("Group")
.value("Computer")
.build())
.version(2.0)
.workspaceName("TestWS")
.build());
}
}

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:operationalinsights:SavedSearch myresource1 /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/savedSearches/{savedSearchId}

Constructors

Link copied to clipboard
constructor(category: Output<String>? = null, displayName: Output<String>? = null, functionAlias: Output<String>? = null, functionParameters: Output<String>? = null, query: Output<String>? = null, resourceGroupName: Output<String>? = null, savedSearchId: Output<String>? = null, tags: Output<List<TagArgs>>? = null, version: Output<Double>? = null, workspaceName: Output<String>? = null)

Properties

Link copied to clipboard
val category: Output<String>? = null

The category of the saved search. This helps the user to find a saved search faster.

Link copied to clipboard
val displayName: Output<String>? = null

Saved search display name.

Link copied to clipboard
val functionAlias: Output<String>? = null

The function alias if query serves as a function.

Link copied to clipboard
val functionParameters: Output<String>? = null

The optional function parameters if query serves as a function. Value should be in the following format: 'param-name1:type1 = default_value1, param-name2:type2 = default_value2'. For more examples and proper syntax please refer to https://docs.microsoft.com/en-us/azure/kusto/query/functions/user-defined-functions.

Link copied to clipboard
val query: Output<String>? = null

The query expression for the saved search.

Link copied to clipboard
val resourceGroupName: Output<String>? = null

The name of the resource group. The name is case insensitive.

Link copied to clipboard
val savedSearchId: Output<String>? = null

The id of the saved search.

Link copied to clipboard
val tags: Output<List<TagArgs>>? = null

The tags attached to the saved search.

Link copied to clipboard
val version: Output<Double>? = null

The version number of the query language. The current version is 2 and is the default.

Link copied to clipboard
val workspaceName: Output<String>? = null

The name of the workspace.

Functions

Link copied to clipboard
open override fun toJava(): SavedSearchArgs