pulumi-azure-native-kotlin/com.pulumi.azurenative.securityinsights.kotlin/WatchlistArgs

WatchlistArgs

data class WatchlistArgs(val contentType: Output<String>? = null, val created: Output<String>? = null, val createdBy: Output<WatchlistUserInfoArgs>? = null, val defaultDuration: Output<String>? = null, val description: Output<String>? = null, val displayName: Output<String>? = null, val isDeleted: Output<Boolean>? = null, val itemsSearchKey: Output<String>? = null, val labels: Output<List<String>>? = null, val numberOfLinesToSkip: Output<Int>? = null, val provider: Output<String>? = null, val rawContent: Output<String>? = null, val resourceGroupName: Output<String>? = null, val source: Output<Either<String, Source>>? = null, val tenantId: Output<String>? = null, val updated: Output<String>? = null, val updatedBy: Output<WatchlistUserInfoArgs>? = null, val uploadStatus: Output<String>? = null, val watchlistAlias: Output<String>? = null, val watchlistId: Output<String>? = null, val watchlistType: Output<String>? = null, val workspaceName: Output<String>? = null) : ConvertibleToJava<WatchlistArgs>

Represents a Watchlist in Azure Security Insights. Azure REST API version: 2023-02-01. Prior API version in Azure Native 1.x: 2021-03-01-preview. Other available API versions: 2019-01-01-preview, 2021-03-01-preview, 2021-04-01, 2021-10-01-preview, 2022-01-01-preview, 2023-06-01-preview, 2023-07-01-preview, 2023-08-01-preview, 2023-09-01-preview.

Example Usage

Create or update a watchlist and bulk creates watchlist items.

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
    var watchlist = new AzureNative.SecurityInsights.Watchlist("watchlist", new()
    {
        ContentType = "text/csv",
        Description = "Watchlist from CSV content",
        DisplayName = "High Value Assets Watchlist",
        ItemsSearchKey = "header1",
        NumberOfLinesToSkip = 1,
        Provider = "Microsoft",
        RawContent = @"This line will be skipped
header1,header2
value1,value2",
        ResourceGroupName = "myRg",
        Source = "Local file",
        WatchlistAlias = "highValueAsset",
        WorkspaceName = "myWorkspace",
    });
});
Content copied to clipboard
package main
import (
	"github.com/pulumi/pulumi-azure-native-sdk/securityinsights/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := securityinsights.NewWatchlist(ctx, "watchlist", &securityinsights.WatchlistArgs{
			ContentType:         pulumi.String("text/csv"),
			Description:         pulumi.String("Watchlist from CSV content"),
			DisplayName:         pulumi.String("High Value Assets Watchlist"),
			ItemsSearchKey:      pulumi.String("header1"),
			NumberOfLinesToSkip: pulumi.Int(1),
			Provider:            pulumi.String("Microsoft"),
			RawContent:          pulumi.String("This line will be skipped\nheader1,header2\nvalue1,value2"),
			ResourceGroupName:   pulumi.String("myRg"),
			Source:              pulumi.String("Local file"),
			WatchlistAlias:      pulumi.String("highValueAsset"),
			WorkspaceName:       pulumi.String("myWorkspace"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.securityinsights.Watchlist;
import com.pulumi.azurenative.securityinsights.WatchlistArgs;
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 watchlist = new Watchlist("watchlist", WatchlistArgs.builder()
            .contentType("text/csv")
            .description("Watchlist from CSV content")
            .displayName("High Value Assets Watchlist")
            .itemsSearchKey("header1")
            .numberOfLinesToSkip(1)
            .provider("Microsoft")
            .rawContent("""
This line will be skipped
header1,header2
value1,value2            """)
            .resourceGroupName("myRg")
            .source("Local file")
            .watchlistAlias("highValueAsset")
            .workspaceName("myWorkspace")
            .build());
    }
}
Content copied to clipboard

Create or update a watchlist.

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
    var watchlist = new AzureNative.SecurityInsights.Watchlist("watchlist", new()
    {
        Description = "Watchlist from CSV content",
        DisplayName = "High Value Assets Watchlist",
        ItemsSearchKey = "header1",
        Provider = "Microsoft",
        ResourceGroupName = "myRg",
        Source = "Local file",
        WatchlistAlias = "highValueAsset",
        WorkspaceName = "myWorkspace",
    });
});
Content copied to clipboard
package main
import (
	"github.com/pulumi/pulumi-azure-native-sdk/securityinsights/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := securityinsights.NewWatchlist(ctx, "watchlist", &securityinsights.WatchlistArgs{
			Description:       pulumi.String("Watchlist from CSV content"),
			DisplayName:       pulumi.String("High Value Assets Watchlist"),
			ItemsSearchKey:    pulumi.String("header1"),
			Provider:          pulumi.String("Microsoft"),
			ResourceGroupName: pulumi.String("myRg"),
			Source:            pulumi.String("Local file"),
			WatchlistAlias:    pulumi.String("highValueAsset"),
			WorkspaceName:     pulumi.String("myWorkspace"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.securityinsights.Watchlist;
import com.pulumi.azurenative.securityinsights.WatchlistArgs;
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 watchlist = new Watchlist("watchlist", WatchlistArgs.builder()
            .description("Watchlist from CSV content")
            .displayName("High Value Assets Watchlist")
            .itemsSearchKey("header1")
            .provider("Microsoft")
            .resourceGroupName("myRg")
            .source("Local file")
            .watchlistAlias("highValueAsset")
            .workspaceName("myWorkspace")
            .build());
    }
}
Content copied to clipboard

Import

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

$ pulumi import azure-native:securityinsights:Watchlist highValueAsset /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/watchlists/{watchlistAlias}
Content copied to clipboard

Constructors

Link copied to clipboard
fun WatchlistArgs(contentType: Output<String>? = null, created: Output<String>? = null, createdBy: Output<WatchlistUserInfoArgs>? = null, defaultDuration: Output<String>? = null, description: Output<String>? = null, displayName: Output<String>? = null, isDeleted: Output<Boolean>? = null, itemsSearchKey: Output<String>? = null, labels: Output<List<String>>? = null, numberOfLinesToSkip: Output<Int>? = null, provider: Output<String>? = null, rawContent: Output<String>? = null, resourceGroupName: Output<String>? = null, source: Output<Either<String, Source>>? = null, tenantId: Output<String>? = null, updated: Output<String>? = null, updatedBy: Output<WatchlistUserInfoArgs>? = null, uploadStatus: Output<String>? = null, watchlistAlias: Output<String>? = null, watchlistId: Output<String>? = null, watchlistType: Output<String>? = null, workspaceName: Output<String>? = null)

Functions

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

Properties

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

The content type of the raw content. For now, only text/csv is valid

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

The time the watchlist was created

Link copied to clipboard
val createdBy: Output<WatchlistUserInfoArgs>? = null

Describes a user that created the watchlist

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

The default duration of a watchlist (in ISO 8601 duration format)

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

A description of the watchlist

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

The display name of the watchlist

Link copied to clipboard
val isDeleted: Output<Boolean>? = null

A flag that indicates if the watchlist is deleted or not

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

The search key is used to optimize query performance when using watchlists for joins with other data. For example, enable a column with IP addresses to be the designated SearchKey field, then use this field as the key field when joining to other event data by IP address.

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

List of labels relevant to this watchlist

Link copied to clipboard
val numberOfLinesToSkip: Output<Int>? = null

The number of lines in a csv content to skip before the header

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

The provider of the watchlist

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

The raw content that represents to watchlist items to create. Example : This line will be skipped header1,header2 value1,value2

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 source: Output<Either<String, Source>>? = null

The source of the watchlist

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

The tenantId where the watchlist belongs to

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

The last time the watchlist was updated

Link copied to clipboard
val updatedBy: Output<WatchlistUserInfoArgs>? = null

Describes a user that updated the watchlist

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

The status of the Watchlist upload : New, InProgress or Complete. Note : When a Watchlist upload status is InProgress, the Watchlist cannot be deleted

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

The alias of the watchlist

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

The id (a Guid) of the watchlist

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

The type of the watchlist

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

The name of the workspace.