Docs
PackagesWe recommend using Azure Native.
azure.sentinel.Watchlist
Explore with Pulumi AI
Manages a Sentinel Watchlist.
Example Usage
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
return await Deployment.RunAsync(() =>
{
var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new()
{
Location = "West Europe",
});
var exampleAnalyticsWorkspace = new Azure.OperationalInsights.AnalyticsWorkspace("exampleAnalyticsWorkspace", new()
{
Location = exampleResourceGroup.Location,
ResourceGroupName = exampleResourceGroup.Name,
Sku = "PerGB2018",
});
var exampleLogAnalyticsWorkspaceOnboarding = new Azure.Sentinel.LogAnalyticsWorkspaceOnboarding("exampleLogAnalyticsWorkspaceOnboarding", new()
{
WorkspaceId = exampleAnalyticsWorkspace.Id,
});
var exampleWatchlist = new Azure.Sentinel.Watchlist("exampleWatchlist", new()
{
LogAnalyticsWorkspaceId = exampleLogAnalyticsWorkspaceOnboarding.WorkspaceId,
DisplayName = "example-wl",
ItemSearchKey = "Key",
});
});
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 {
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
}
exampleLogAnalyticsWorkspaceOnboarding, err := sentinel.NewLogAnalyticsWorkspaceOnboarding(ctx, "exampleLogAnalyticsWorkspaceOnboarding", &sentinel.LogAnalyticsWorkspaceOnboardingArgs{
WorkspaceId: exampleAnalyticsWorkspace.ID(),
})
if err != nil {
return err
}
_, err = sentinel.NewWatchlist(ctx, "exampleWatchlist", &sentinel.WatchlistArgs{
LogAnalyticsWorkspaceId: exampleLogAnalyticsWorkspaceOnboarding.WorkspaceId,
DisplayName: pulumi.String("example-wl"),
ItemSearchKey: pulumi.String("Key"),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.operationalinsights.AnalyticsWorkspace;
import com.pulumi.azure.operationalinsights.AnalyticsWorkspaceArgs;
import com.pulumi.azure.sentinel.LogAnalyticsWorkspaceOnboarding;
import com.pulumi.azure.sentinel.LogAnalyticsWorkspaceOnboardingArgs;
import com.pulumi.azure.sentinel.Watchlist;
import com.pulumi.azure.sentinel.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 exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()
.location("West Europe")
.build());
var exampleAnalyticsWorkspace = new AnalyticsWorkspace("exampleAnalyticsWorkspace", AnalyticsWorkspaceArgs.builder()
.location(exampleResourceGroup.location())
.resourceGroupName(exampleResourceGroup.name())
.sku("PerGB2018")
.build());
var exampleLogAnalyticsWorkspaceOnboarding = new LogAnalyticsWorkspaceOnboarding("exampleLogAnalyticsWorkspaceOnboarding", LogAnalyticsWorkspaceOnboardingArgs.builder()
.workspaceId(exampleAnalyticsWorkspace.id())
.build());
var exampleWatchlist = new Watchlist("exampleWatchlist", WatchlistArgs.builder()
.logAnalyticsWorkspaceId(exampleLogAnalyticsWorkspaceOnboarding.workspaceId())
.displayName("example-wl")
.itemSearchKey("Key")
.build());
}
}
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_log_analytics_workspace_onboarding = azure.sentinel.LogAnalyticsWorkspaceOnboarding("exampleLogAnalyticsWorkspaceOnboarding", workspace_id=example_analytics_workspace.id)
example_watchlist = azure.sentinel.Watchlist("exampleWatchlist",
log_analytics_workspace_id=example_log_analytics_workspace_onboarding.workspace_id,
display_name="example-wl",
item_search_key="Key")
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 exampleLogAnalyticsWorkspaceOnboarding = new azure.sentinel.LogAnalyticsWorkspaceOnboarding("exampleLogAnalyticsWorkspaceOnboarding", {workspaceId: exampleAnalyticsWorkspace.id});
const exampleWatchlist = new azure.sentinel.Watchlist("exampleWatchlist", {
logAnalyticsWorkspaceId: exampleLogAnalyticsWorkspaceOnboarding.workspaceId,
displayName: "example-wl",
itemSearchKey: "Key",
});
resources:
exampleResourceGroup:
type: azure:core:ResourceGroup
properties:
location: West Europe
exampleAnalyticsWorkspace:
type: azure:operationalinsights:AnalyticsWorkspace
properties:
location: ${exampleResourceGroup.location}
resourceGroupName: ${exampleResourceGroup.name}
sku: PerGB2018
exampleLogAnalyticsWorkspaceOnboarding:
type: azure:sentinel:LogAnalyticsWorkspaceOnboarding
properties:
workspaceId: ${exampleAnalyticsWorkspace.id}
exampleWatchlist:
type: azure:sentinel:Watchlist
properties:
logAnalyticsWorkspaceId: ${exampleLogAnalyticsWorkspaceOnboarding.workspaceId}
displayName: example-wl
itemSearchKey: Key
Create Watchlist Resource
new Watchlist(name: string, args: WatchlistArgs, opts?: CustomResourceOptions);@overload
def Watchlist(resource_name: str,
opts: Optional[ResourceOptions] = None,
default_duration: Optional[str] = None,
description: Optional[str] = None,
display_name: Optional[str] = None,
item_search_key: Optional[str] = None,
labels: Optional[Sequence[str]] = None,
log_analytics_workspace_id: Optional[str] = None,
name: Optional[str] = None)
@overload
def Watchlist(resource_name: str,
args: WatchlistArgs,
opts: Optional[ResourceOptions] = 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.
- 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.
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:
- Display
Name string The display name of this Sentinel Watchlist. Changing this forces a new Sentinel Watchlist to be created.
- Item
Search stringKey The key used to optimize query performance when using Watchlist for joins with other data. Changing this forces a new Sentinel Watchlist to be created.
- Log
Analytics stringWorkspace Id 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 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.
- Display
Name string The display name of this Sentinel Watchlist. Changing this forces a new Sentinel Watchlist to be created.
- Item
Search stringKey The key used to optimize query performance when using Watchlist for joins with other data. Changing this forces a new Sentinel Watchlist to be created.
- Log
Analytics stringWorkspace Id 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 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 String The display name of this Sentinel Watchlist. Changing this forces a new Sentinel Watchlist to be created.
- item
Search StringKey The key used to optimize query performance when using Watchlist for joins with other data. Changing this forces a new Sentinel Watchlist to be created.
- log
Analytics StringWorkspace Id 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 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.
- display
Name string The display name of this Sentinel Watchlist. Changing this forces a new Sentinel Watchlist to be created.
- item
Search stringKey The key used to optimize query performance when using Watchlist for joins with other data. Changing this forces a new Sentinel Watchlist to be created.
- log
Analytics stringWorkspace Id 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 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.
- item_
search_ strkey The key used to optimize query performance when using Watchlist for joins with other data. Changing this forces a new Sentinel Watchlist to be created.
- log_
analytics_ strworkspace_ id 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.
- display
Name String The display name of this Sentinel Watchlist. Changing this forces a new Sentinel Watchlist to be created.
- item
Search StringKey The key used to optimize query performance when using Watchlist for joins with other data. Changing this forces a new Sentinel Watchlist to be created.
- log
Analytics StringWorkspace Id 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 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,
item_search_key: Optional[str] = None,
labels: Optional[Sequence[str]] = None,
log_analytics_workspace_id: Optional[str] = None,
name: Optional[str] = None) -> Watchlistfunc 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)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.
- Default
Duration 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.
- Display
Name string The display name of this Sentinel Watchlist. Changing this forces a new Sentinel Watchlist to be created.
- Item
Search stringKey The key used to optimize query performance when using Watchlist for joins with other data. 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.
- Log
Analytics stringWorkspace Id 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 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.
- Display
Name string The display name of this Sentinel Watchlist. Changing this forces a new Sentinel Watchlist to be created.
- Item
Search stringKey The key used to optimize query performance when using Watchlist for joins with other data. 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.
- Log
Analytics stringWorkspace Id 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 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.
- display
Name String The display name of this Sentinel Watchlist. Changing this forces a new Sentinel Watchlist to be created.
- item
Search StringKey The key used to optimize query performance when using Watchlist for joins with other data. 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.
- log
Analytics StringWorkspace Id 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 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.
- display
Name string The display name of this Sentinel Watchlist. Changing this forces a new Sentinel Watchlist to be created.
- item
Search stringKey The key used to optimize query performance when using Watchlist for joins with other data. 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.
- log
Analytics stringWorkspace Id 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.
- item_
search_ strkey The key used to optimize query performance when using Watchlist for joins with other data. 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_ strworkspace_ id 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.
- default
Duration 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.
- display
Name String The display name of this Sentinel Watchlist. Changing this forces a new Sentinel Watchlist to be created.
- item
Search StringKey The key used to optimize query performance when using Watchlist for joins with other data. 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.
- log
Analytics StringWorkspace Id 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
Package Details
- Repository
- Azure Classic pulumi/pulumi-azure
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
azurermTerraform Provider.