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

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
Go to latest version
Schema (JSON)
pulumi/pulumi-azure

azure.sentinel.Watchlist

azure logo

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
Go to latest version
Schema (JSON)
pulumi/pulumi-azure

    Manages a Sentinel Watchlist.

    Example Usage

    using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new Azure.Core.ResourceGroupArgs
        {
            Location = "West Europe",
        });
        var exampleAnalyticsWorkspace = new Azure.OperationalInsights.AnalyticsWorkspace("exampleAnalyticsWorkspace", new Azure.OperationalInsights.AnalyticsWorkspaceArgs
        {
            Location = exampleResourceGroup.Location,
            ResourceGroupName = exampleResourceGroup.Name,
            Sku = "PerGB2018",
        });
        var exampleAnalyticsSolution = new Azure.OperationalInsights.AnalyticsSolution("exampleAnalyticsSolution", new Azure.OperationalInsights.AnalyticsSolutionArgs
        {
            SolutionName = "SecurityInsights",
            Location = exampleResourceGroup.Location,
            ResourceGroupName = exampleResourceGroup.Name,
            WorkspaceResourceId = exampleAnalyticsWorkspace.Id,
            WorkspaceName = exampleAnalyticsWorkspace.Name,
            Plan = new Azure.OperationalInsights.Inputs.AnalyticsSolutionPlanArgs
            {
                Publisher = "Microsoft",
                Product = "OMSGallery/SecurityInsights",
            },
        });
        var exampleWatchlist = new Azure.Sentinel.Watchlist("exampleWatchlist", new Azure.Sentinel.WatchlistArgs
        {
            LogAnalyticsWorkspaceId = exampleAnalyticsSolution.WorkspaceResourceId,
            DisplayName = "example-wl",
        });
    }

}

    package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/operationalinsights"
	"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/sentinel"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleAnalyticsWorkspace, err := operationalinsights.NewAnalyticsWorkspace(ctx, "exampleAnalyticsWorkspace", &operationalinsights.AnalyticsWorkspaceArgs{
			Location:          exampleResourceGroup.Location,
			ResourceGroupName: exampleResourceGroup.Name,
			Sku:               pulumi.String("PerGB2018"),
		})
		if err != nil {
			return err
		}
		exampleAnalyticsSolution, err := operationalinsights.NewAnalyticsSolution(ctx, "exampleAnalyticsSolution", &operationalinsights.AnalyticsSolutionArgs{
			SolutionName:        pulumi.String("SecurityInsights"),
			Location:            exampleResourceGroup.Location,
			ResourceGroupName:   exampleResourceGroup.Name,
			WorkspaceResourceId: exampleAnalyticsWorkspace.ID(),
			WorkspaceName:       exampleAnalyticsWorkspace.Name,
			Plan: &operationalinsights.AnalyticsSolutionPlanArgs{
				Publisher: pulumi.String("Microsoft"),
				Product:   pulumi.String("OMSGallery/SecurityInsights"),
			},
		})
		if err != nil {
			return err
		}
		_, err = sentinel.NewWatchlist(ctx, "exampleWatchlist", &sentinel.WatchlistArgs{
			LogAnalyticsWorkspaceId: exampleAnalyticsSolution.WorkspaceResourceId,
			DisplayName:             pulumi.String("example-wl"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    Example coming soon!

    import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleAnalyticsWorkspace = new azure.operationalinsights.AnalyticsWorkspace("exampleAnalyticsWorkspace", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    sku: "PerGB2018",
});
const exampleAnalyticsSolution = new azure.operationalinsights.AnalyticsSolution("exampleAnalyticsSolution", {
    solutionName: "SecurityInsights",
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    workspaceResourceId: exampleAnalyticsWorkspace.id,
    workspaceName: exampleAnalyticsWorkspace.name,
    plan: {
        publisher: "Microsoft",
        product: "OMSGallery/SecurityInsights",
    },
});
const exampleWatchlist = new azure.sentinel.Watchlist("exampleWatchlist", {
    logAnalyticsWorkspaceId: exampleAnalyticsSolution.workspaceResourceId,
    displayName: "example-wl",
});

    import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_analytics_workspace = azure.operationalinsights.AnalyticsWorkspace("exampleAnalyticsWorkspace",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    sku="PerGB2018")
example_analytics_solution = azure.operationalinsights.AnalyticsSolution("exampleAnalyticsSolution",
    solution_name="SecurityInsights",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    workspace_resource_id=example_analytics_workspace.id,
    workspace_name=example_analytics_workspace.name,
    plan=azure.operationalinsights.AnalyticsSolutionPlanArgs(
        publisher="Microsoft",
        product="OMSGallery/SecurityInsights",
    ))
example_watchlist = azure.sentinel.Watchlist("exampleWatchlist",
    log_analytics_workspace_id=example_analytics_solution.workspace_resource_id,
    display_name="example-wl")

    Example coming soon!

    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,
              display_name: Optional[str] = None,
              log_analytics_workspace_id: Optional[str] = None,
              default_duration: Optional[str] = None,
              description: Optional[str] = None,
              labels: Optional[Sequence[str]] = None,
              name: 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:sentinel: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 Azure.Sentinel.Watchlist("watchlistResource", new()
{
    DisplayName = "string",
    LogAnalyticsWorkspaceId = "string",
    DefaultDuration = "string",
    Description = "string",
    Labels = new[]
    {
        "string",
    },
    Name = "string",
});

    example, err := sentinel.NewWatchlist(ctx, "watchlistResource", &sentinel.WatchlistArgs{
	DisplayName:             pulumi.String("string"),
	LogAnalyticsWorkspaceId: pulumi.String("string"),
	DefaultDuration:         pulumi.String("string"),
	Description:             pulumi.String("string"),
	Labels: pulumi.StringArray{
		pulumi.String("string"),
	},
	Name: pulumi.String("string"),
})

    var watchlistResource = new Watchlist("watchlistResource", WatchlistArgs.builder()
    .displayName("string")
    .logAnalyticsWorkspaceId("string")
    .defaultDuration("string")
    .description("string")
    .labels("string")
    .name("string")
    .build());

    watchlist_resource = azure.sentinel.Watchlist("watchlistResource",
    display_name="string",
    log_analytics_workspace_id="string",
    default_duration="string",
    description="string",
    labels=["string"],
    name="string")

    const watchlistResource = new azure.sentinel.Watchlist("watchlistResource", {
    displayName: "string",
    logAnalyticsWorkspaceId: "string",
    defaultDuration: "string",
    description: "string",
    labels: ["string"],
    name: "string",
});

    type: azure:sentinel:Watchlist
properties:
    defaultDuration: string
    description: string
    displayName: string
    labels:
        - string
    logAnalyticsWorkspaceId: string
    name: 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

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Watchlist resource accepts the following input properties:

    DisplayName string
    The display name of this Sentinel Watchlist. Changing this forces a new Sentinel Watchlist to be created.
    LogAnalyticsWorkspaceId string
    The ID of the Log Analytics Workspace where this Sentinel Watchlist resides in. Changing this forces a new Sentinel Watchlist to be created.
    DefaultDuration string
    The default duration in ISO8601 duration form of this Sentinel Watchlist. Changing this forces a new Sentinel Watchlist to be created.
    Description string
    The description of this Sentinel Watchlist. Changing this forces a new Sentinel Watchlist to be created.
    Labels List<string>
    Specifies a list of labels related to this Sentinel Watchlist. Changing this forces a new Sentinel Watchlist to be created.
    Name string
    The name which should be used for this Sentinel Watchlist. Changing this forces a new Sentinel Watchlist to be created.
    DisplayName string
    The display name of this Sentinel Watchlist. Changing this forces a new Sentinel Watchlist to be created.
    LogAnalyticsWorkspaceId string
    The ID of the Log Analytics Workspace where this Sentinel Watchlist resides in. Changing this forces a new Sentinel Watchlist to be created.
    DefaultDuration string
    The default duration in ISO8601 duration form of this Sentinel Watchlist. Changing this forces a new Sentinel Watchlist to be created.
    Description string
    The description of this Sentinel Watchlist. Changing this forces a new Sentinel Watchlist to be created.
    Labels []string
    Specifies a list of labels related to this Sentinel Watchlist. Changing this forces a new Sentinel Watchlist to be created.
    Name string
    The name which should be used for this Sentinel Watchlist. Changing this forces a new Sentinel Watchlist to be created.
    displayName String
    The display name of this Sentinel Watchlist. Changing this forces a new Sentinel Watchlist to be created.
    logAnalyticsWorkspaceId String
    The ID of the Log Analytics Workspace where this Sentinel Watchlist resides in. Changing this forces a new Sentinel Watchlist to be created.
    defaultDuration String
    The default duration in ISO8601 duration form of this Sentinel Watchlist. Changing this forces a new Sentinel Watchlist to be created.
    description String
    The description of this Sentinel Watchlist. Changing this forces a new Sentinel Watchlist to be created.
    labels List<String>
    Specifies a list of labels related to this Sentinel Watchlist. Changing this forces a new Sentinel Watchlist to be created.
    name String
    The name which should be used for this Sentinel Watchlist. Changing this forces a new Sentinel Watchlist to be created.
    displayName string
    The display name of this Sentinel Watchlist. Changing this forces a new Sentinel Watchlist to be created.
    logAnalyticsWorkspaceId string
    The ID of the Log Analytics Workspace where this Sentinel Watchlist resides in. Changing this forces a new Sentinel Watchlist to be created.
    defaultDuration string
    The default duration in ISO8601 duration form of this Sentinel Watchlist. Changing this forces a new Sentinel Watchlist to be created.
    description string
    The description of this Sentinel Watchlist. Changing this forces a new Sentinel Watchlist to be created.
    labels string[]
    Specifies a list of labels related to this Sentinel Watchlist. Changing this forces a new Sentinel Watchlist to be created.
    name string
    The name which should be used for this Sentinel Watchlist. Changing this forces a new Sentinel Watchlist to be created.
    display_name str
    The display name of this Sentinel Watchlist. Changing this forces a new Sentinel Watchlist to be created.
    log_analytics_workspace_id str
    The ID of the Log Analytics Workspace where this Sentinel Watchlist resides in. Changing this forces a new Sentinel Watchlist to be created.
    default_duration str
    The default duration in ISO8601 duration form of this Sentinel Watchlist. Changing this forces a new Sentinel Watchlist to be created.
    description str
    The description of this Sentinel Watchlist. Changing this forces a new Sentinel Watchlist to be created.
    labels Sequence[str]
    Specifies a list of labels related to this Sentinel Watchlist. Changing this forces a new Sentinel Watchlist to be created.
    name str
    The name which should be used for this Sentinel Watchlist. Changing this forces a new Sentinel Watchlist to be created.
    displayName String
    The display name of this Sentinel Watchlist. Changing this forces a new Sentinel Watchlist to be created.
    logAnalyticsWorkspaceId String
    The ID of the Log Analytics Workspace where this Sentinel Watchlist resides in. Changing this forces a new Sentinel Watchlist to be created.
    defaultDuration String
    The default duration in ISO8601 duration form of this Sentinel Watchlist. Changing this forces a new Sentinel Watchlist to be created.
    description String
    The description of this Sentinel Watchlist. Changing this forces a new Sentinel Watchlist to be created.
    labels List<String>
    Specifies a list of labels related to this Sentinel Watchlist. Changing this forces a new Sentinel Watchlist to be created.
    name String
    The name which should be used for this Sentinel Watchlist. Changing this forces a new Sentinel Watchlist to be created.

    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.
    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 Watchlist Resource

    Get an existing Watchlist 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?: WatchlistState, opts?: CustomResourceOptions): Watchlist
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        default_duration: Optional[str] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        labels: Optional[Sequence[str]] = None,
        log_analytics_workspace_id: Optional[str] = None,
        name: Optional[str] = None) -> Watchlist
    func GetWatchlist(ctx *Context, name string, id IDInput, state *WatchlistState, opts ...ResourceOption) (*Watchlist, error)
    public static Watchlist Get(string name, Input<string> id, WatchlistState? state, CustomResourceOptions? opts = null)
    public static Watchlist get(String name, Output<String> id, WatchlistState state, CustomResourceOptions options)
    resources:  _:    type: azure:sentinel:Watchlist    get:      id: ${id}
    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:
    DefaultDuration string
    The default duration in ISO8601 duration form of this Sentinel Watchlist. Changing this forces a new Sentinel Watchlist to be created.
    Description string
    The description of this Sentinel Watchlist. Changing this forces a new Sentinel Watchlist to be created.
    DisplayName string
    The display name of this Sentinel Watchlist. Changing this forces a new Sentinel Watchlist to be created.
    Labels List<string>
    Specifies a list of labels related to this Sentinel Watchlist. Changing this forces a new Sentinel Watchlist to be created.
    LogAnalyticsWorkspaceId string
    The ID of the Log Analytics Workspace where this Sentinel Watchlist resides in. Changing this forces a new Sentinel Watchlist to be created.
    Name string
    The name which should be used for this Sentinel Watchlist. Changing this forces a new Sentinel Watchlist to be created.
    DefaultDuration string
    The default duration in ISO8601 duration form of this Sentinel Watchlist. Changing this forces a new Sentinel Watchlist to be created.
    Description string
    The description of this Sentinel Watchlist. Changing this forces a new Sentinel Watchlist to be created.
    DisplayName string
    The display name of this Sentinel Watchlist. Changing this forces a new Sentinel Watchlist to be created.
    Labels []string
    Specifies a list of labels related to this Sentinel Watchlist. Changing this forces a new Sentinel Watchlist to be created.
    LogAnalyticsWorkspaceId string
    The ID of the Log Analytics Workspace where this Sentinel Watchlist resides in. Changing this forces a new Sentinel Watchlist to be created.
    Name string
    The name which should be used for this Sentinel Watchlist. Changing this forces a new Sentinel Watchlist to be created.
    defaultDuration String
    The default duration in ISO8601 duration form of this Sentinel Watchlist. Changing this forces a new Sentinel Watchlist to be created.
    description String
    The description of this Sentinel Watchlist. Changing this forces a new Sentinel Watchlist to be created.
    displayName String
    The display name of this Sentinel Watchlist. Changing this forces a new Sentinel Watchlist to be created.
    labels List<String>
    Specifies a list of labels related to this Sentinel Watchlist. Changing this forces a new Sentinel Watchlist to be created.
    logAnalyticsWorkspaceId String
    The ID of the Log Analytics Workspace where this Sentinel Watchlist resides in. Changing this forces a new Sentinel Watchlist to be created.
    name String
    The name which should be used for this Sentinel Watchlist. Changing this forces a new Sentinel Watchlist to be created.
    defaultDuration string
    The default duration in ISO8601 duration form of this Sentinel Watchlist. Changing this forces a new Sentinel Watchlist to be created.
    description string
    The description of this Sentinel Watchlist. Changing this forces a new Sentinel Watchlist to be created.
    displayName string
    The display name of this Sentinel Watchlist. Changing this forces a new Sentinel Watchlist to be created.
    labels string[]
    Specifies a list of labels related to this Sentinel Watchlist. Changing this forces a new Sentinel Watchlist to be created.
    logAnalyticsWorkspaceId string
    The ID of the Log Analytics Workspace where this Sentinel Watchlist resides in. Changing this forces a new Sentinel Watchlist to be created.
    name string
    The name which should be used for this Sentinel Watchlist. Changing this forces a new Sentinel Watchlist to be created.
    default_duration str
    The default duration in ISO8601 duration form of this Sentinel Watchlist. Changing this forces a new Sentinel Watchlist to be created.
    description str
    The description of this Sentinel Watchlist. Changing this forces a new Sentinel Watchlist to be created.
    display_name str
    The display name of this Sentinel Watchlist. Changing this forces a new Sentinel Watchlist to be created.
    labels Sequence[str]
    Specifies a list of labels related to this Sentinel Watchlist. Changing this forces a new Sentinel Watchlist to be created.
    log_analytics_workspace_id str
    The ID of the Log Analytics Workspace where this Sentinel Watchlist resides in. Changing this forces a new Sentinel Watchlist to be created.
    name str
    The name which should be used for this Sentinel Watchlist. Changing this forces a new Sentinel Watchlist to be created.
    defaultDuration String
    The default duration in ISO8601 duration form of this Sentinel Watchlist. Changing this forces a new Sentinel Watchlist to be created.
    description String
    The description of this Sentinel Watchlist. Changing this forces a new Sentinel Watchlist to be created.
    displayName String
    The display name of this Sentinel Watchlist. Changing this forces a new Sentinel Watchlist to be created.
    labels List<String>
    Specifies a list of labels related to this Sentinel Watchlist. Changing this forces a new Sentinel Watchlist to be created.
    logAnalyticsWorkspaceId String
    The ID of the Log Analytics Workspace where this Sentinel Watchlist resides in. Changing this forces a new Sentinel Watchlist to be created.
    name String
    The name which should be used for this Sentinel Watchlist. Changing this forces a new Sentinel Watchlist to be created.

    Import

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

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

    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.

    Viewing docs for Azure v4.42.0 (Older version)
    published on Monday, Mar 9, 2026 by Pulumi
    Go to latest version
    Schema (JSON)
    pulumi/pulumi-azure
      Try Pulumi Cloud free. Your team will thank you.