Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. securityinsights
  5. Watchlist
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.63.0 published on Tuesday, Sep 24, 2024 by Pulumi
pulumi/pulumi-azure-native

azure-native.securityinsights.Watchlist

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.63.0 published on Tuesday, Sep 24, 2024 by Pulumi
pulumi/pulumi-azure-native

    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, 2023-10-01-preview, 2023-11-01, 2023-12-01-preview, 2024-01-01-preview, 2024-03-01.

    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 = AzureNative.SecurityInsights.Source.Local_file,
        WatchlistAlias = "highValueAsset",
        WorkspaceName = "myWorkspace",
    });

});

    package main

import (
	securityinsights "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(securityinsights.Source_Local_file),
			WatchlistAlias:      pulumi.String("highValueAsset"),
			WorkspaceName:       pulumi.String("myWorkspace"),
		})
		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.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());

    }
}

    import pulumi
import pulumi_azure_native as azure_native

watchlist = azure_native.securityinsights.Watchlist("watchlist",
    content_type="text/csv",
    description="Watchlist from CSV content",
    display_name="High Value Assets Watchlist",
    items_search_key="header1",
    number_of_lines_to_skip=1,
    provider="Microsoft",
    raw_content="""This line will be skipped
header1,header2
value1,value2""",
    resource_group_name="myRg",
    source=azure_native.securityinsights.Source.LOCAL_FILE,
    watchlist_alias="highValueAsset",
    workspace_name="myWorkspace")

    import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const watchlist = new azure_native.securityinsights.Watchlist("watchlist", {
    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: azure_native.securityinsights.Source.Local_file,
    watchlistAlias: "highValueAsset",
    workspaceName: "myWorkspace",
});

    resources:
  watchlist:
    type: azure-native:securityinsights:Watchlist
    properties:
      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

    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 = AzureNative.SecurityInsights.Source.Local_file,
        WatchlistAlias = "highValueAsset",
        WorkspaceName = "myWorkspace",
    });

});

    package main

import (
	securityinsights "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(securityinsights.Source_Local_file),
			WatchlistAlias:    pulumi.String("highValueAsset"),
			WorkspaceName:     pulumi.String("myWorkspace"),
		})
		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.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());

    }
}

    import pulumi
import pulumi_azure_native as azure_native

watchlist = azure_native.securityinsights.Watchlist("watchlist",
    description="Watchlist from CSV content",
    display_name="High Value Assets Watchlist",
    items_search_key="header1",
    provider="Microsoft",
    resource_group_name="myRg",
    source=azure_native.securityinsights.Source.LOCAL_FILE,
    watchlist_alias="highValueAsset",
    workspace_name="myWorkspace")

    import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const watchlist = new azure_native.securityinsights.Watchlist("watchlist", {
    description: "Watchlist from CSV content",
    displayName: "High Value Assets Watchlist",
    itemsSearchKey: "header1",
    provider: "Microsoft",
    resourceGroupName: "myRg",
    source: azure_native.securityinsights.Source.Local_file,
    watchlistAlias: "highValueAsset",
    workspaceName: "myWorkspace",
});

    resources:
  watchlist:
    type: azure-native:securityinsights:Watchlist
    properties:
      description: Watchlist from CSV content
      displayName: High Value Assets Watchlist
      itemsSearchKey: header1
      provider: Microsoft
      resourceGroupName: myRg
      source: Local file
      watchlistAlias: highValueAsset
      workspaceName: myWorkspace

    Create Watchlist Resource

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

    Constructor syntax

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

@overload
def Watchlist(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              provider: Optional[str] = None,
              items_search_key: Optional[str] = None,
              source: Optional[Union[str, Source]] = None,
              workspace_name: Optional[str] = None,
              resource_group_name: Optional[str] = None,
              display_name: Optional[str] = None,
              created_by: Optional[WatchlistUserInfoArgs] = None,
              raw_content: Optional[str] = None,
              description: Optional[str] = None,
              number_of_lines_to_skip: Optional[int] = None,
              default_duration: Optional[str] = None,
              created: Optional[str] = None,
              labels: Optional[Sequence[str]] = None,
              is_deleted: Optional[bool] = None,
              tenant_id: Optional[str] = None,
              updated: Optional[str] = None,
              updated_by: Optional[WatchlistUserInfoArgs] = None,
              upload_status: Optional[str] = None,
              watchlist_alias: Optional[str] = None,
              watchlist_id: Optional[str] = None,
              watchlist_type: Optional[str] = None,
              content_type: Optional[str] = None)
    func NewWatchlist(ctx *Context, name string, args WatchlistArgs, opts ...ResourceOption) (*Watchlist, error)
    public Watchlist(string name, WatchlistArgs args, CustomResourceOptions? opts = null)
    public Watchlist(String name, WatchlistArgs args)
public Watchlist(String name, WatchlistArgs args, CustomResourceOptions options)

    type: azure-native:securityinsights:Watchlist
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 WatchlistArgs
    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 WatchlistArgs
    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 WatchlistArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WatchlistArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WatchlistArgs
    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 watchlistResource = new AzureNative.SecurityInsights.Watchlist("watchlistResource", new()
{
    Provider = "string",
    ItemsSearchKey = "string",
    Source = "string",
    WorkspaceName = "string",
    ResourceGroupName = "string",
    DisplayName = "string",
    CreatedBy = new AzureNative.SecurityInsights.Inputs.WatchlistUserInfoArgs
    {
        ObjectId = "string",
    },
    RawContent = "string",
    Description = "string",
    NumberOfLinesToSkip = 0,
    DefaultDuration = "string",
    Created = "string",
    Labels = new[]
    {
        "string",
    },
    IsDeleted = false,
    TenantId = "string",
    Updated = "string",
    UpdatedBy = new AzureNative.SecurityInsights.Inputs.WatchlistUserInfoArgs
    {
        ObjectId = "string",
    },
    UploadStatus = "string",
    WatchlistAlias = "string",
    WatchlistId = "string",
    WatchlistType = "string",
    ContentType = "string",
});

    example, err := securityinsights.NewWatchlist(ctx, "watchlistResource", &securityinsights.WatchlistArgs{
	Provider:          pulumi.String("string"),
	ItemsSearchKey:    pulumi.String("string"),
	Source:            pulumi.String("string"),
	WorkspaceName:     pulumi.String("string"),
	ResourceGroupName: pulumi.String("string"),
	DisplayName:       pulumi.String("string"),
	CreatedBy: &securityinsights.WatchlistUserInfoArgs{
		ObjectId: pulumi.String("string"),
	},
	RawContent:          pulumi.String("string"),
	Description:         pulumi.String("string"),
	NumberOfLinesToSkip: pulumi.Int(0),
	DefaultDuration:     pulumi.String("string"),
	Created:             pulumi.String("string"),
	Labels: pulumi.StringArray{
		pulumi.String("string"),
	},
	IsDeleted: pulumi.Bool(false),
	TenantId:  pulumi.String("string"),
	Updated:   pulumi.String("string"),
	UpdatedBy: &securityinsights.WatchlistUserInfoArgs{
		ObjectId: pulumi.String("string"),
	},
	UploadStatus:   pulumi.String("string"),
	WatchlistAlias: pulumi.String("string"),
	WatchlistId:    pulumi.String("string"),
	WatchlistType:  pulumi.String("string"),
	ContentType:    pulumi.String("string"),
})

    var watchlistResource = new Watchlist("watchlistResource", WatchlistArgs.builder()
    .provider("string")
    .itemsSearchKey("string")
    .source("string")
    .workspaceName("string")
    .resourceGroupName("string")
    .displayName("string")
    .createdBy(WatchlistUserInfoArgs.builder()
        .objectId("string")
        .build())
    .rawContent("string")
    .description("string")
    .numberOfLinesToSkip(0)
    .defaultDuration("string")
    .created("string")
    .labels("string")
    .isDeleted(false)
    .tenantId("string")
    .updated("string")
    .updatedBy(WatchlistUserInfoArgs.builder()
        .objectId("string")
        .build())
    .uploadStatus("string")
    .watchlistAlias("string")
    .watchlistId("string")
    .watchlistType("string")
    .contentType("string")
    .build());

    watchlist_resource = azure_native.securityinsights.Watchlist("watchlistResource",
    provider="string",
    items_search_key="string",
    source="string",
    workspace_name="string",
    resource_group_name="string",
    display_name="string",
    created_by={
        "objectId": "string",
    },
    raw_content="string",
    description="string",
    number_of_lines_to_skip=0,
    default_duration="string",
    created="string",
    labels=["string"],
    is_deleted=False,
    tenant_id="string",
    updated="string",
    updated_by={
        "objectId": "string",
    },
    upload_status="string",
    watchlist_alias="string",
    watchlist_id="string",
    watchlist_type="string",
    content_type="string")

    const watchlistResource = new azure_native.securityinsights.Watchlist("watchlistResource", {
    provider: "string",
    itemsSearchKey: "string",
    source: "string",
    workspaceName: "string",
    resourceGroupName: "string",
    displayName: "string",
    createdBy: {
        objectId: "string",
    },
    rawContent: "string",
    description: "string",
    numberOfLinesToSkip: 0,
    defaultDuration: "string",
    created: "string",
    labels: ["string"],
    isDeleted: false,
    tenantId: "string",
    updated: "string",
    updatedBy: {
        objectId: "string",
    },
    uploadStatus: "string",
    watchlistAlias: "string",
    watchlistId: "string",
    watchlistType: "string",
    contentType: "string",
});

    type: azure-native:securityinsights:Watchlist
properties:
    contentType: string
    created: string
    createdBy:
        objectId: string
    defaultDuration: string
    description: string
    displayName: string
    isDeleted: false
    itemsSearchKey: string
    labels:
        - string
    numberOfLinesToSkip: 0
    provider: string
    rawContent: string
    resourceGroupName: string
    source: string
    tenantId: string
    updated: string
    updatedBy:
        objectId: string
    uploadStatus: string
    watchlistAlias: string
    watchlistId: string
    watchlistType: string
    workspaceName: string

    Watchlist 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 Watchlist resource accepts the following input properties:

    DisplayName string
    The display name of the watchlist
    ItemsSearchKey string
    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.
    Provider string
    The provider of the watchlist
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    Source string | Pulumi.AzureNative.SecurityInsights.Source
    The source of the watchlist
    WorkspaceName string
    The name of the workspace.
    ContentType string
    The content type of the raw content. For now, only text/csv is valid
    Created string
    The time the watchlist was created
    CreatedBy Pulumi.AzureNative.SecurityInsights.Inputs.WatchlistUserInfo
    Describes a user that created the watchlist
    DefaultDuration string
    The default duration of a watchlist (in ISO 8601 duration format)
    Description string
    A description of the watchlist
    IsDeleted bool
    A flag that indicates if the watchlist is deleted or not
    Labels List<string>
    List of labels relevant to this watchlist
    NumberOfLinesToSkip int
    The number of lines in a csv content to skip before the header
    RawContent string
    The raw content that represents to watchlist items to create. Example : This line will be skipped header1,header2 value1,value2
    TenantId string
    The tenantId where the watchlist belongs to
    Updated string
    The last time the watchlist was updated
    UpdatedBy Pulumi.AzureNative.SecurityInsights.Inputs.WatchlistUserInfo
    Describes a user that updated the watchlist
    UploadStatus string
    The status of the Watchlist upload : New, InProgress or Complete. Note : When a Watchlist upload status is InProgress, the Watchlist cannot be deleted
    WatchlistAlias string
    The alias of the watchlist
    WatchlistId string
    The id (a Guid) of the watchlist
    WatchlistType string
    The type of the watchlist
    DisplayName string
    The display name of the watchlist
    ItemsSearchKey string
    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.
    Provider string
    The provider of the watchlist
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    Source string | Source
    The source of the watchlist
    WorkspaceName string
    The name of the workspace.
    ContentType string
    The content type of the raw content. For now, only text/csv is valid
    Created string
    The time the watchlist was created
    CreatedBy WatchlistUserInfoArgs
    Describes a user that created the watchlist
    DefaultDuration string
    The default duration of a watchlist (in ISO 8601 duration format)
    Description string
    A description of the watchlist
    IsDeleted bool
    A flag that indicates if the watchlist is deleted or not
    Labels []string
    List of labels relevant to this watchlist
    NumberOfLinesToSkip int
    The number of lines in a csv content to skip before the header
    RawContent string
    The raw content that represents to watchlist items to create. Example : This line will be skipped header1,header2 value1,value2
    TenantId string
    The tenantId where the watchlist belongs to
    Updated string
    The last time the watchlist was updated
    UpdatedBy WatchlistUserInfoArgs
    Describes a user that updated the watchlist
    UploadStatus string
    The status of the Watchlist upload : New, InProgress or Complete. Note : When a Watchlist upload status is InProgress, the Watchlist cannot be deleted
    WatchlistAlias string
    The alias of the watchlist
    WatchlistId string
    The id (a Guid) of the watchlist
    WatchlistType string
    The type of the watchlist
    displayName String
    The display name of the watchlist
    itemsSearchKey String
    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.
    provider String
    The provider of the watchlist
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    source String | Source
    The source of the watchlist
    workspaceName String
    The name of the workspace.
    contentType String
    The content type of the raw content. For now, only text/csv is valid
    created String
    The time the watchlist was created
    createdBy WatchlistUserInfo
    Describes a user that created the watchlist
    defaultDuration String
    The default duration of a watchlist (in ISO 8601 duration format)
    description String
    A description of the watchlist
    isDeleted Boolean
    A flag that indicates if the watchlist is deleted or not
    labels List<String>
    List of labels relevant to this watchlist
    numberOfLinesToSkip Integer
    The number of lines in a csv content to skip before the header
    rawContent String
    The raw content that represents to watchlist items to create. Example : This line will be skipped header1,header2 value1,value2
    tenantId String
    The tenantId where the watchlist belongs to
    updated String
    The last time the watchlist was updated
    updatedBy WatchlistUserInfo
    Describes a user that updated the watchlist
    uploadStatus String
    The status of the Watchlist upload : New, InProgress or Complete. Note : When a Watchlist upload status is InProgress, the Watchlist cannot be deleted
    watchlistAlias String
    The alias of the watchlist
    watchlistId String
    The id (a Guid) of the watchlist
    watchlistType String
    The type of the watchlist
    displayName string
    The display name of the watchlist
    itemsSearchKey string
    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.
    provider string
    The provider of the watchlist
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    source string | Source
    The source of the watchlist
    workspaceName string
    The name of the workspace.
    contentType string
    The content type of the raw content. For now, only text/csv is valid
    created string
    The time the watchlist was created
    createdBy WatchlistUserInfo
    Describes a user that created the watchlist
    defaultDuration string
    The default duration of a watchlist (in ISO 8601 duration format)
    description string
    A description of the watchlist
    isDeleted boolean
    A flag that indicates if the watchlist is deleted or not
    labels string[]
    List of labels relevant to this watchlist
    numberOfLinesToSkip number
    The number of lines in a csv content to skip before the header
    rawContent string
    The raw content that represents to watchlist items to create. Example : This line will be skipped header1,header2 value1,value2
    tenantId string
    The tenantId where the watchlist belongs to
    updated string
    The last time the watchlist was updated
    updatedBy WatchlistUserInfo
    Describes a user that updated the watchlist
    uploadStatus string
    The status of the Watchlist upload : New, InProgress or Complete. Note : When a Watchlist upload status is InProgress, the Watchlist cannot be deleted
    watchlistAlias string
    The alias of the watchlist
    watchlistId string
    The id (a Guid) of the watchlist
    watchlistType string
    The type of the watchlist
    display_name str
    The display name of the watchlist
    items_search_key str
    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.
    provider str
    The provider of the watchlist
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    source str | Source
    The source of the watchlist
    workspace_name str
    The name of the workspace.
    content_type str
    The content type of the raw content. For now, only text/csv is valid
    created str
    The time the watchlist was created
    created_by WatchlistUserInfoArgs
    Describes a user that created the watchlist
    default_duration str
    The default duration of a watchlist (in ISO 8601 duration format)
    description str
    A description of the watchlist
    is_deleted bool
    A flag that indicates if the watchlist is deleted or not
    labels Sequence[str]
    List of labels relevant to this watchlist
    number_of_lines_to_skip int
    The number of lines in a csv content to skip before the header
    raw_content str
    The raw content that represents to watchlist items to create. Example : This line will be skipped header1,header2 value1,value2
    tenant_id str
    The tenantId where the watchlist belongs to
    updated str
    The last time the watchlist was updated
    updated_by WatchlistUserInfoArgs
    Describes a user that updated the watchlist
    upload_status str
    The status of the Watchlist upload : New, InProgress or Complete. Note : When a Watchlist upload status is InProgress, the Watchlist cannot be deleted
    watchlist_alias str
    The alias of the watchlist
    watchlist_id str
    The id (a Guid) of the watchlist
    watchlist_type str
    The type of the watchlist
    displayName String
    The display name of the watchlist
    itemsSearchKey String
    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.
    provider String
    The provider of the watchlist
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    source String | "Local file" | "Remote storage"
    The source of the watchlist
    workspaceName String
    The name of the workspace.
    contentType String
    The content type of the raw content. For now, only text/csv is valid
    created String
    The time the watchlist was created
    createdBy Property Map
    Describes a user that created the watchlist
    defaultDuration String
    The default duration of a watchlist (in ISO 8601 duration format)
    description String
    A description of the watchlist
    isDeleted Boolean
    A flag that indicates if the watchlist is deleted or not
    labels List<String>
    List of labels relevant to this watchlist
    numberOfLinesToSkip Number
    The number of lines in a csv content to skip before the header
    rawContent String
    The raw content that represents to watchlist items to create. Example : This line will be skipped header1,header2 value1,value2
    tenantId String
    The tenantId where the watchlist belongs to
    updated String
    The last time the watchlist was updated
    updatedBy Property Map
    Describes a user that updated the watchlist
    uploadStatus String
    The status of the Watchlist upload : New, InProgress or Complete. Note : When a Watchlist upload status is InProgress, the Watchlist cannot be deleted
    watchlistAlias String
    The alias of the watchlist
    watchlistId String
    The id (a Guid) of the watchlist
    watchlistType String
    The type of the watchlist

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource
    SystemData Pulumi.AzureNative.SecurityInsights.Outputs.SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Etag string
    Etag of the azure resource
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource
    SystemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Etag string
    Etag of the azure resource
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    etag String
    Etag of the azure resource
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The name of the resource
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    etag string
    Etag of the azure resource
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The name of the resource
    system_data SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    etag str
    Etag of the azure resource
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource
    systemData Property Map
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    etag String
    Etag of the azure resource

    Supporting Types

    Source, SourceArgs

    Local_file
    Local file
    Remote_storage
    Remote storage
    Source_Local_file
    Local file
    Source_Remote_storage
    Remote storage
    Local_file
    Local file
    Remote_storage
    Remote storage
    Local_file
    Local file
    Remote_storage
    Remote storage
    LOCAL_FILE
    Local file
    REMOTE_STORAGE
    Remote storage
    "Local file"
    Local file
    "Remote storage"
    Remote storage

    SystemDataResponse, SystemDataResponseArgs

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The timestamp of resource last modification (UTC)
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    The type of identity that last modified the resource.
    created_at str
    The timestamp of resource creation (UTC).
    created_by str
    The identity that created the resource.
    created_by_type str
    The type of identity that created the resource.
    last_modified_at str
    The timestamp of resource last modification (UTC)
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    WatchlistUserInfo, WatchlistUserInfoArgs

    ObjectId string
    The object id of the user.
    ObjectId string
    The object id of the user.
    objectId String
    The object id of the user.
    objectId string
    The object id of the user.
    object_id str
    The object id of the user.
    objectId String
    The object id of the user.

    WatchlistUserInfoResponse, WatchlistUserInfoResponseArgs

    Email string
    The email of the user.
    Name string
    The name of the user.
    ObjectId string
    The object id of the user.
    Email string
    The email of the user.
    Name string
    The name of the user.
    ObjectId string
    The object id of the user.
    email String
    The email of the user.
    name String
    The name of the user.
    objectId String
    The object id of the user.
    email string
    The email of the user.
    name string
    The name of the user.
    objectId string
    The object id of the user.
    email str
    The email of the user.
    name str
    The name of the user.
    object_id str
    The object id of the user.
    email String
    The email of the user.
    name String
    The name of the user.
    objectId String
    The object id of the user.

    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}

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

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.63.0 published on Tuesday, Sep 24, 2024 by Pulumi
    pulumi/pulumi-azure-native