1. Packages
  2. Azure Classic
  3. API Docs
  4. sentinel
  5. WatchlistItem

We recommend using Azure Native.

Azure Classic v5.80.0 published on Monday, Jun 10, 2024 by Pulumi

azure.sentinel.WatchlistItem

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.80.0 published on Monday, Jun 10, 2024 by Pulumi

    Manages a Sentinel Watchlist Item.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    
    const example = new azure.core.ResourceGroup("example", {
        name: "example-rg",
        location: "West Europe",
    });
    const exampleAnalyticsWorkspace = new azure.operationalinsights.AnalyticsWorkspace("example", {
        name: "example-workspace",
        location: example.location,
        resourceGroupName: example.name,
        sku: "PerGB2018",
    });
    const exampleLogAnalyticsWorkspaceOnboarding = new azure.sentinel.LogAnalyticsWorkspaceOnboarding("example", {workspaceId: exampleAnalyticsWorkspace.id});
    const exampleWatchlist = new azure.sentinel.Watchlist("example", {
        name: "example-watchlist",
        logAnalyticsWorkspaceId: exampleLogAnalyticsWorkspaceOnboarding.workspaceId,
        displayName: "example-wl",
        itemSearchKey: "Key",
    });
    const exampleWatchlistItem = new azure.sentinel.WatchlistItem("example", {
        name: "0aac6fa5-223e-49cf-9bfd-3554dc9d2b76",
        watchlistId: exampleWatchlist.id,
        properties: {
            k1: "v1",
            k2: "v2",
        },
    });
    
    import pulumi
    import pulumi_azure as azure
    
    example = azure.core.ResourceGroup("example",
        name="example-rg",
        location="West Europe")
    example_analytics_workspace = azure.operationalinsights.AnalyticsWorkspace("example",
        name="example-workspace",
        location=example.location,
        resource_group_name=example.name,
        sku="PerGB2018")
    example_log_analytics_workspace_onboarding = azure.sentinel.LogAnalyticsWorkspaceOnboarding("example", workspace_id=example_analytics_workspace.id)
    example_watchlist = azure.sentinel.Watchlist("example",
        name="example-watchlist",
        log_analytics_workspace_id=example_log_analytics_workspace_onboarding.workspace_id,
        display_name="example-wl",
        item_search_key="Key")
    example_watchlist_item = azure.sentinel.WatchlistItem("example",
        name="0aac6fa5-223e-49cf-9bfd-3554dc9d2b76",
        watchlist_id=example_watchlist.id,
        properties={
            "k1": "v1",
            "k2": "v2",
        })
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/operationalinsights"
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/sentinel"
    	"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-rg"),
    			Location: pulumi.String("West Europe"),
    		})
    		if err != nil {
    			return err
    		}
    		exampleAnalyticsWorkspace, err := operationalinsights.NewAnalyticsWorkspace(ctx, "example", &operationalinsights.AnalyticsWorkspaceArgs{
    			Name:              pulumi.String("example-workspace"),
    			Location:          example.Location,
    			ResourceGroupName: example.Name,
    			Sku:               pulumi.String("PerGB2018"),
    		})
    		if err != nil {
    			return err
    		}
    		exampleLogAnalyticsWorkspaceOnboarding, err := sentinel.NewLogAnalyticsWorkspaceOnboarding(ctx, "example", &sentinel.LogAnalyticsWorkspaceOnboardingArgs{
    			WorkspaceId: exampleAnalyticsWorkspace.ID(),
    		})
    		if err != nil {
    			return err
    		}
    		exampleWatchlist, err := sentinel.NewWatchlist(ctx, "example", &sentinel.WatchlistArgs{
    			Name:                    pulumi.String("example-watchlist"),
    			LogAnalyticsWorkspaceId: exampleLogAnalyticsWorkspaceOnboarding.WorkspaceId,
    			DisplayName:             pulumi.String("example-wl"),
    			ItemSearchKey:           pulumi.String("Key"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = sentinel.NewWatchlistItem(ctx, "example", &sentinel.WatchlistItemArgs{
    			Name:        pulumi.String("0aac6fa5-223e-49cf-9bfd-3554dc9d2b76"),
    			WatchlistId: exampleWatchlist.ID(),
    			Properties: pulumi.StringMap{
    				"k1": pulumi.String("v1"),
    				"k2": pulumi.String("v2"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    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-rg",
            Location = "West Europe",
        });
    
        var exampleAnalyticsWorkspace = new Azure.OperationalInsights.AnalyticsWorkspace("example", new()
        {
            Name = "example-workspace",
            Location = example.Location,
            ResourceGroupName = example.Name,
            Sku = "PerGB2018",
        });
    
        var exampleLogAnalyticsWorkspaceOnboarding = new Azure.Sentinel.LogAnalyticsWorkspaceOnboarding("example", new()
        {
            WorkspaceId = exampleAnalyticsWorkspace.Id,
        });
    
        var exampleWatchlist = new Azure.Sentinel.Watchlist("example", new()
        {
            Name = "example-watchlist",
            LogAnalyticsWorkspaceId = exampleLogAnalyticsWorkspaceOnboarding.WorkspaceId,
            DisplayName = "example-wl",
            ItemSearchKey = "Key",
        });
    
        var exampleWatchlistItem = new Azure.Sentinel.WatchlistItem("example", new()
        {
            Name = "0aac6fa5-223e-49cf-9bfd-3554dc9d2b76",
            WatchlistId = exampleWatchlist.Id,
            Properties = 
            {
                { "k1", "v1" },
                { "k2", "v2" },
            },
        });
    
    });
    
    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.sentinel.LogAnalyticsWorkspaceOnboarding;
    import com.pulumi.azure.sentinel.LogAnalyticsWorkspaceOnboardingArgs;
    import com.pulumi.azure.sentinel.Watchlist;
    import com.pulumi.azure.sentinel.WatchlistArgs;
    import com.pulumi.azure.sentinel.WatchlistItem;
    import com.pulumi.azure.sentinel.WatchlistItemArgs;
    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-rg")
                .location("West Europe")
                .build());
    
            var exampleAnalyticsWorkspace = new AnalyticsWorkspace("exampleAnalyticsWorkspace", AnalyticsWorkspaceArgs.builder()
                .name("example-workspace")
                .location(example.location())
                .resourceGroupName(example.name())
                .sku("PerGB2018")
                .build());
    
            var exampleLogAnalyticsWorkspaceOnboarding = new LogAnalyticsWorkspaceOnboarding("exampleLogAnalyticsWorkspaceOnboarding", LogAnalyticsWorkspaceOnboardingArgs.builder()
                .workspaceId(exampleAnalyticsWorkspace.id())
                .build());
    
            var exampleWatchlist = new Watchlist("exampleWatchlist", WatchlistArgs.builder()
                .name("example-watchlist")
                .logAnalyticsWorkspaceId(exampleLogAnalyticsWorkspaceOnboarding.workspaceId())
                .displayName("example-wl")
                .itemSearchKey("Key")
                .build());
    
            var exampleWatchlistItem = new WatchlistItem("exampleWatchlistItem", WatchlistItemArgs.builder()
                .name("0aac6fa5-223e-49cf-9bfd-3554dc9d2b76")
                .watchlistId(exampleWatchlist.id())
                .properties(Map.ofEntries(
                    Map.entry("k1", "v1"),
                    Map.entry("k2", "v2")
                ))
                .build());
    
        }
    }
    
    resources:
      example:
        type: azure:core:ResourceGroup
        properties:
          name: example-rg
          location: West Europe
      exampleAnalyticsWorkspace:
        type: azure:operationalinsights:AnalyticsWorkspace
        name: example
        properties:
          name: example-workspace
          location: ${example.location}
          resourceGroupName: ${example.name}
          sku: PerGB2018
      exampleLogAnalyticsWorkspaceOnboarding:
        type: azure:sentinel:LogAnalyticsWorkspaceOnboarding
        name: example
        properties:
          workspaceId: ${exampleAnalyticsWorkspace.id}
      exampleWatchlist:
        type: azure:sentinel:Watchlist
        name: example
        properties:
          name: example-watchlist
          logAnalyticsWorkspaceId: ${exampleLogAnalyticsWorkspaceOnboarding.workspaceId}
          displayName: example-wl
          itemSearchKey: Key
      exampleWatchlistItem:
        type: azure:sentinel:WatchlistItem
        name: example
        properties:
          name: 0aac6fa5-223e-49cf-9bfd-3554dc9d2b76
          watchlistId: ${exampleWatchlist.id}
          properties:
            k1: v1
            k2: v2
    

    Create WatchlistItem Resource

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

    Constructor syntax

    new WatchlistItem(name: string, args: WatchlistItemArgs, opts?: CustomResourceOptions);
    @overload
    def WatchlistItem(resource_name: str,
                      args: WatchlistItemArgs,
                      opts: Optional[ResourceOptions] = None)
    
    @overload
    def WatchlistItem(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      properties: Optional[Mapping[str, str]] = None,
                      watchlist_id: Optional[str] = None,
                      name: Optional[str] = None)
    func NewWatchlistItem(ctx *Context, name string, args WatchlistItemArgs, opts ...ResourceOption) (*WatchlistItem, error)
    public WatchlistItem(string name, WatchlistItemArgs args, CustomResourceOptions? opts = null)
    public WatchlistItem(String name, WatchlistItemArgs args)
    public WatchlistItem(String name, WatchlistItemArgs args, CustomResourceOptions options)
    
    type: azure:sentinel:WatchlistItem
    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 WatchlistItemArgs
    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 WatchlistItemArgs
    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 WatchlistItemArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WatchlistItemArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WatchlistItemArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var watchlistItemResource = new Azure.Sentinel.WatchlistItem("watchlistItemResource", new()
    {
        Properties = 
        {
            { "string", "string" },
        },
        WatchlistId = "string",
        Name = "string",
    });
    
    example, err := sentinel.NewWatchlistItem(ctx, "watchlistItemResource", &sentinel.WatchlistItemArgs{
    	Properties: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	WatchlistId: pulumi.String("string"),
    	Name:        pulumi.String("string"),
    })
    
    var watchlistItemResource = new WatchlistItem("watchlistItemResource", WatchlistItemArgs.builder()
        .properties(Map.of("string", "string"))
        .watchlistId("string")
        .name("string")
        .build());
    
    watchlist_item_resource = azure.sentinel.WatchlistItem("watchlistItemResource",
        properties={
            "string": "string",
        },
        watchlist_id="string",
        name="string")
    
    const watchlistItemResource = new azure.sentinel.WatchlistItem("watchlistItemResource", {
        properties: {
            string: "string",
        },
        watchlistId: "string",
        name: "string",
    });
    
    type: azure:sentinel:WatchlistItem
    properties:
        name: string
        properties:
            string: string
        watchlistId: string
    

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

    Properties Dictionary<string, string>
    The key value pairs of the Sentinel Watchlist Item.
    WatchlistId string
    The ID of the Sentinel Watchlist that this Item resides in. Changing this forces a new Sentinel Watchlist Item to be created.
    Name string
    The name in UUID format which should be used for this Sentinel Watchlist Item. Changing this forces a new Sentinel Watchlist Item to be created.
    Properties map[string]string
    The key value pairs of the Sentinel Watchlist Item.
    WatchlistId string
    The ID of the Sentinel Watchlist that this Item resides in. Changing this forces a new Sentinel Watchlist Item to be created.
    Name string
    The name in UUID format which should be used for this Sentinel Watchlist Item. Changing this forces a new Sentinel Watchlist Item to be created.
    properties Map<String,String>
    The key value pairs of the Sentinel Watchlist Item.
    watchlistId String
    The ID of the Sentinel Watchlist that this Item resides in. Changing this forces a new Sentinel Watchlist Item to be created.
    name String
    The name in UUID format which should be used for this Sentinel Watchlist Item. Changing this forces a new Sentinel Watchlist Item to be created.
    properties {[key: string]: string}
    The key value pairs of the Sentinel Watchlist Item.
    watchlistId string
    The ID of the Sentinel Watchlist that this Item resides in. Changing this forces a new Sentinel Watchlist Item to be created.
    name string
    The name in UUID format which should be used for this Sentinel Watchlist Item. Changing this forces a new Sentinel Watchlist Item to be created.
    properties Mapping[str, str]
    The key value pairs of the Sentinel Watchlist Item.
    watchlist_id str
    The ID of the Sentinel Watchlist that this Item resides in. Changing this forces a new Sentinel Watchlist Item to be created.
    name str
    The name in UUID format which should be used for this Sentinel Watchlist Item. Changing this forces a new Sentinel Watchlist Item to be created.
    properties Map<String>
    The key value pairs of the Sentinel Watchlist Item.
    watchlistId String
    The ID of the Sentinel Watchlist that this Item resides in. Changing this forces a new Sentinel Watchlist Item to be created.
    name String
    The name in UUID format which should be used for this Sentinel Watchlist Item. Changing this forces a new Sentinel Watchlist Item to be created.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the WatchlistItem 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 WatchlistItem Resource

    Get an existing WatchlistItem 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?: WatchlistItemState, opts?: CustomResourceOptions): WatchlistItem
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            name: Optional[str] = None,
            properties: Optional[Mapping[str, str]] = None,
            watchlist_id: Optional[str] = None) -> WatchlistItem
    func GetWatchlistItem(ctx *Context, name string, id IDInput, state *WatchlistItemState, opts ...ResourceOption) (*WatchlistItem, error)
    public static WatchlistItem Get(string name, Input<string> id, WatchlistItemState? state, CustomResourceOptions? opts = null)
    public static WatchlistItem get(String name, Output<String> id, WatchlistItemState 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:
    Name string
    The name in UUID format which should be used for this Sentinel Watchlist Item. Changing this forces a new Sentinel Watchlist Item to be created.
    Properties Dictionary<string, string>
    The key value pairs of the Sentinel Watchlist Item.
    WatchlistId string
    The ID of the Sentinel Watchlist that this Item resides in. Changing this forces a new Sentinel Watchlist Item to be created.
    Name string
    The name in UUID format which should be used for this Sentinel Watchlist Item. Changing this forces a new Sentinel Watchlist Item to be created.
    Properties map[string]string
    The key value pairs of the Sentinel Watchlist Item.
    WatchlistId string
    The ID of the Sentinel Watchlist that this Item resides in. Changing this forces a new Sentinel Watchlist Item to be created.
    name String
    The name in UUID format which should be used for this Sentinel Watchlist Item. Changing this forces a new Sentinel Watchlist Item to be created.
    properties Map<String,String>
    The key value pairs of the Sentinel Watchlist Item.
    watchlistId String
    The ID of the Sentinel Watchlist that this Item resides in. Changing this forces a new Sentinel Watchlist Item to be created.
    name string
    The name in UUID format which should be used for this Sentinel Watchlist Item. Changing this forces a new Sentinel Watchlist Item to be created.
    properties {[key: string]: string}
    The key value pairs of the Sentinel Watchlist Item.
    watchlistId string
    The ID of the Sentinel Watchlist that this Item resides in. Changing this forces a new Sentinel Watchlist Item to be created.
    name str
    The name in UUID format which should be used for this Sentinel Watchlist Item. Changing this forces a new Sentinel Watchlist Item to be created.
    properties Mapping[str, str]
    The key value pairs of the Sentinel Watchlist Item.
    watchlist_id str
    The ID of the Sentinel Watchlist that this Item resides in. Changing this forces a new Sentinel Watchlist Item to be created.
    name String
    The name in UUID format which should be used for this Sentinel Watchlist Item. Changing this forces a new Sentinel Watchlist Item to be created.
    properties Map<String>
    The key value pairs of the Sentinel Watchlist Item.
    watchlistId String
    The ID of the Sentinel Watchlist that this Item resides in. Changing this forces a new Sentinel Watchlist Item to be created.

    Import

    Sentinel Watchlist Items can be imported using the resource id, e.g.

    $ pulumi import azure:sentinel/watchlistItem:WatchlistItem example /subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/resGroup1/providers/Microsoft.OperationalInsights/workspaces/workspace1/providers/Microsoft.SecurityInsights/watchlists/list1/watchlistItems/item1
    

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

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Azure Classic v5.80.0 published on Monday, Jun 10, 2024 by Pulumi