SavedSearchArgs

data class SavedSearchArgs(val category: Output<String>? = null, val displayName: Output<String>? = null, val functionAlias: Output<String>? = null, val functionParameters: Output<List<String>>? = null, val logAnalyticsWorkspaceId: Output<String>? = null, val name: Output<String>? = null, val query: Output<String>? = null, val tags: Output<Map<String, String>>? = null) : ConvertibleToJava<SavedSearchArgs>

Manages a Log Analytics (formally Operational Insights) Saved Search.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const example = new azure.core.ResourceGroup("example", {
name: "example-resources",
location: "West Europe",
});
const exampleAnalyticsWorkspace = new azure.operationalinsights.AnalyticsWorkspace("example", {
name: "acctest-01",
location: example.location,
resourceGroupName: example.name,
sku: "PerGB2018",
retentionInDays: 30,
});
const exampleSavedSearch = new azure.loganalytics.SavedSearch("example", {
name: "exampleSavedSearch",
logAnalyticsWorkspaceId: exampleAnalyticsWorkspace.id,
category: "exampleCategory",
displayName: "exampleDisplayName",
query: "exampleQuery",
});
import pulumi
import pulumi_azure as azure
example = azure.core.ResourceGroup("example",
name="example-resources",
location="West Europe")
example_analytics_workspace = azure.operationalinsights.AnalyticsWorkspace("example",
name="acctest-01",
location=example.location,
resource_group_name=example.name,
sku="PerGB2018",
retention_in_days=30)
example_saved_search = azure.loganalytics.SavedSearch("example",
name="exampleSavedSearch",
log_analytics_workspace_id=example_analytics_workspace.id,
category="exampleCategory",
display_name="exampleDisplayName",
query="exampleQuery")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
return await Deployment.RunAsync(() =>
{
var example = new Azure.Core.ResourceGroup("example", new()
{
Name = "example-resources",
Location = "West Europe",
});
var exampleAnalyticsWorkspace = new Azure.OperationalInsights.AnalyticsWorkspace("example", new()
{
Name = "acctest-01",
Location = example.Location,
ResourceGroupName = example.Name,
Sku = "PerGB2018",
RetentionInDays = 30,
});
var exampleSavedSearch = new Azure.LogAnalytics.SavedSearch("example", new()
{
Name = "exampleSavedSearch",
LogAnalyticsWorkspaceId = exampleAnalyticsWorkspace.Id,
Category = "exampleCategory",
DisplayName = "exampleDisplayName",
Query = "exampleQuery",
});
});
package main
import (
"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/loganalytics"
"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/operationalinsights"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
Name: pulumi.String("example-resources"),
Location: pulumi.String("West Europe"),
})
if err != nil {
return err
}
exampleAnalyticsWorkspace, err := operationalinsights.NewAnalyticsWorkspace(ctx, "example", &operationalinsights.AnalyticsWorkspaceArgs{
Name: pulumi.String("acctest-01"),
Location: example.Location,
ResourceGroupName: example.Name,
Sku: pulumi.String("PerGB2018"),
RetentionInDays: pulumi.Int(30),
})
if err != nil {
return err
}
_, err = loganalytics.NewSavedSearch(ctx, "example", &loganalytics.SavedSearchArgs{
Name: pulumi.String("exampleSavedSearch"),
LogAnalyticsWorkspaceId: exampleAnalyticsWorkspace.ID(),
Category: pulumi.String("exampleCategory"),
DisplayName: pulumi.String("exampleDisplayName"),
Query: pulumi.String("exampleQuery"),
})
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.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.operationalinsights.AnalyticsWorkspace;
import com.pulumi.azure.operationalinsights.AnalyticsWorkspaceArgs;
import com.pulumi.azure.loganalytics.SavedSearch;
import com.pulumi.azure.loganalytics.SavedSearchArgs;
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 example = new ResourceGroup("example", ResourceGroupArgs.builder()
.name("example-resources")
.location("West Europe")
.build());
var exampleAnalyticsWorkspace = new AnalyticsWorkspace("exampleAnalyticsWorkspace", AnalyticsWorkspaceArgs.builder()
.name("acctest-01")
.location(example.location())
.resourceGroupName(example.name())
.sku("PerGB2018")
.retentionInDays(30)
.build());
var exampleSavedSearch = new SavedSearch("exampleSavedSearch", SavedSearchArgs.builder()
.name("exampleSavedSearch")
.logAnalyticsWorkspaceId(exampleAnalyticsWorkspace.id())
.category("exampleCategory")
.displayName("exampleDisplayName")
.query("exampleQuery")
.build());
}
}
resources:
example:
type: azure:core:ResourceGroup
properties:
name: example-resources
location: West Europe
exampleAnalyticsWorkspace:
type: azure:operationalinsights:AnalyticsWorkspace
name: example
properties:
name: acctest-01
location: ${example.location}
resourceGroupName: ${example.name}
sku: PerGB2018
retentionInDays: 30
exampleSavedSearch:
type: azure:loganalytics:SavedSearch
name: example
properties:
name: exampleSavedSearch
logAnalyticsWorkspaceId: ${exampleAnalyticsWorkspace.id}
category: exampleCategory
displayName: exampleDisplayName
query: exampleQuery

API Providers

This resource uses the following Azure API Providers:

  • Microsoft.OperationalInsights: 2020-08-01

Import

Log Analytics Saved Searches can be imported using the resource id, e.g.

$ pulumi import azure:loganalytics/savedSearch:SavedSearch search1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.OperationalInsights/workspaces/workspace1/savedSearches/search1

Constructors

Link copied to clipboard
constructor(category: Output<String>? = null, displayName: Output<String>? = null, functionAlias: Output<String>? = null, functionParameters: Output<List<String>>? = null, logAnalyticsWorkspaceId: Output<String>? = null, name: Output<String>? = null, query: Output<String>? = null, tags: Output<Map<String, String>>? = null)

Properties

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

The category that the Saved Search will be listed under. Changing this forces a new resource to be created.

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

The name that Saved Search will be displayed as. Changing this forces a new resource to be created.

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

The function alias if the query serves as a function. Changing this forces a new resource to be created.

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

The function parameters if the query serves as a function. Changing this forces a new resource to be created. For more examples and proper syntax please refer to this document.

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

Specifies the ID of the Log Analytics Workspace that the Saved Search will be associated with. Changing this forces a new resource to be created.

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

Specifies the name of the Log Analytics Saved Search. Changing this forces a new resource to be created.

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

The query expression for the saved search. Changing this forces a new resource to be created.

Link copied to clipboard
val tags: Output<Map<String, String>>? = null

A mapping of tags which should be assigned to the Logs Analytics Saved Search. Changing this forces a new resource to be created.

Functions

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