Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v1
  3. API Docs
  4. securityinsights
  5. WatchlistItem
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

azure-native.securityinsights.WatchlistItem

Explore with Pulumi AI

azure-native-v1 logo
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

    Represents a Watchlist item in Azure Security Insights. API Version: 2021-03-01-preview.

    Example Usage

    Creates or updates a watchlist item.

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var watchlistItem = new AzureNative.SecurityInsights.WatchlistItem("watchlistItem", new()
    {
        ItemsKeyValue = 
        {
            { "Business tier", "10.0.2.0/24" },
            { "Data tier", "10.0.2.0/24" },
            { "Gateway subnet", "10.0.255.224/27" },
            { "Private DMZ in", "10.0.0.0/27" },
            { "Public DMZ out", "10.0.0.96/27" },
            { "Web Tier", "10.0.1.0/24" },
        },
        OperationalInsightsResourceProvider = "Microsoft.OperationalInsights",
        ResourceGroupName = "myRg",
        WatchlistAlias = "highValueAsset",
        WatchlistItemId = "82ba292c-dc97-4dfc-969d-d4dd9e666842",
        WorkspaceName = "myWorkspace",
    });

});

    Coming soon!

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.securityinsights.WatchlistItem;
import com.pulumi.azurenative.securityinsights.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 watchlistItem = new WatchlistItem("watchlistItem", WatchlistItemArgs.builder()        
            .itemsKeyValue(Map.ofEntries(
                Map.entry("Business tier", "10.0.2.0/24"),
                Map.entry("Data tier", "10.0.2.0/24"),
                Map.entry("Gateway subnet", "10.0.255.224/27"),
                Map.entry("Private DMZ in", "10.0.0.0/27"),
                Map.entry("Public DMZ out", "10.0.0.96/27"),
                Map.entry("Web Tier", "10.0.1.0/24")
            ))
            .operationalInsightsResourceProvider("Microsoft.OperationalInsights")
            .resourceGroupName("myRg")
            .watchlistAlias("highValueAsset")
            .watchlistItemId("82ba292c-dc97-4dfc-969d-d4dd9e666842")
            .workspaceName("myWorkspace")
            .build());

    }
}

    import pulumi
import pulumi_azure_native as azure_native

watchlist_item = azure_native.securityinsights.WatchlistItem("watchlistItem",
    items_key_value={
        "Business tier": "10.0.2.0/24",
        "Data tier": "10.0.2.0/24",
        "Gateway subnet": "10.0.255.224/27",
        "Private DMZ in": "10.0.0.0/27",
        "Public DMZ out": "10.0.0.96/27",
        "Web Tier": "10.0.1.0/24",
    },
    operational_insights_resource_provider="Microsoft.OperationalInsights",
    resource_group_name="myRg",
    watchlist_alias="highValueAsset",
    watchlist_item_id="82ba292c-dc97-4dfc-969d-d4dd9e666842",
    workspace_name="myWorkspace")

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

const watchlistItem = new azure_native.securityinsights.WatchlistItem("watchlistItem", {
    itemsKeyValue: {
        "Business tier": "10.0.2.0/24",
        "Data tier": "10.0.2.0/24",
        "Gateway subnet": "10.0.255.224/27",
        "Private DMZ in": "10.0.0.0/27",
        "Public DMZ out": "10.0.0.96/27",
        "Web Tier": "10.0.1.0/24",
    },
    operationalInsightsResourceProvider: "Microsoft.OperationalInsights",
    resourceGroupName: "myRg",
    watchlistAlias: "highValueAsset",
    watchlistItemId: "82ba292c-dc97-4dfc-969d-d4dd9e666842",
    workspaceName: "myWorkspace",
});

    resources:
  watchlistItem:
    type: azure-native:securityinsights:WatchlistItem
    properties:
      itemsKeyValue:
        Business tier: 10.0.2.0/24
        Data tier: 10.0.2.0/24
        Gateway subnet: 10.0.255.224/27
        Private DMZ in: 10.0.0.0/27
        Public DMZ out: 10.0.0.96/27
        Web Tier: 10.0.1.0/24
      operationalInsightsResourceProvider: Microsoft.OperationalInsights
      resourceGroupName: myRg
      watchlistAlias: highValueAsset
      watchlistItemId: 82ba292c-dc97-4dfc-969d-d4dd9e666842
      workspaceName: myWorkspace

    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,
                  operational_insights_resource_provider: Optional[str] = None,
                  workspace_name: Optional[str] = None,
                  watchlist_alias: Optional[str] = None,
                  resource_group_name: Optional[str] = None,
                  items_key_value: Optional[Any] = None,
                  is_deleted: Optional[bool] = None,
                  created: Optional[str] = None,
                  tenant_id: Optional[str] = None,
                  updated: Optional[str] = None,
                  updated_by: Optional[WatchlistUserInfoArgs] = None,
                  entity_mapping: Optional[Any] = None,
                  watchlist_item_id: Optional[str] = None,
                  watchlist_item_type: Optional[str] = None,
                  created_by: Optional[WatchlistUserInfoArgs] = 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-native:securityinsights: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.

    Constructor example

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

    var watchlistItemResource = new AzureNative.Securityinsights.WatchlistItem("watchlistItemResource", new()
{
    OperationalInsightsResourceProvider = "string",
    WorkspaceName = "string",
    WatchlistAlias = "string",
    ResourceGroupName = "string",
    ItemsKeyValue = "any",
    IsDeleted = false,
    Created = "string",
    TenantId = "string",
    Updated = "string",
    UpdatedBy = 
    {
        { "objectId", "string" },
    },
    EntityMapping = "any",
    WatchlistItemId = "string",
    WatchlistItemType = "string",
    CreatedBy = 
    {
        { "objectId", "string" },
    },
});

    example, err := securityinsights.NewWatchlistItem(ctx, "watchlistItemResource", &securityinsights.WatchlistItemArgs{
	OperationalInsightsResourceProvider: "string",
	WorkspaceName:                       "string",
	WatchlistAlias:                      "string",
	ResourceGroupName:                   "string",
	ItemsKeyValue:                       "any",
	IsDeleted:                           false,
	Created:                             "string",
	TenantId:                            "string",
	Updated:                             "string",
	UpdatedBy: map[string]interface{}{
		"objectId": "string",
	},
	EntityMapping:     "any",
	WatchlistItemId:   "string",
	WatchlistItemType: "string",
	CreatedBy: map[string]interface{}{
		"objectId": "string",
	},
})

    var watchlistItemResource = new WatchlistItem("watchlistItemResource", WatchlistItemArgs.builder()
    .operationalInsightsResourceProvider("string")
    .workspaceName("string")
    .watchlistAlias("string")
    .resourceGroupName("string")
    .itemsKeyValue("any")
    .isDeleted(false)
    .created("string")
    .tenantId("string")
    .updated("string")
    .updatedBy(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .entityMapping("any")
    .watchlistItemId("string")
    .watchlistItemType("string")
    .createdBy(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .build());

    watchlist_item_resource = azure_native.securityinsights.WatchlistItem("watchlistItemResource",
    operational_insights_resource_provider=string,
    workspace_name=string,
    watchlist_alias=string,
    resource_group_name=string,
    items_key_value=any,
    is_deleted=False,
    created=string,
    tenant_id=string,
    updated=string,
    updated_by={
        objectId: string,
    },
    entity_mapping=any,
    watchlist_item_id=string,
    watchlist_item_type=string,
    created_by={
        objectId: string,
    })

    const watchlistItemResource = new azure_native.securityinsights.WatchlistItem("watchlistItemResource", {
    operationalInsightsResourceProvider: "string",
    workspaceName: "string",
    watchlistAlias: "string",
    resourceGroupName: "string",
    itemsKeyValue: "any",
    isDeleted: false,
    created: "string",
    tenantId: "string",
    updated: "string",
    updatedBy: {
        objectId: "string",
    },
    entityMapping: "any",
    watchlistItemId: "string",
    watchlistItemType: "string",
    createdBy: {
        objectId: "string",
    },
});

    type: azure-native:securityinsights:WatchlistItem
properties:
    created: string
    createdBy:
        objectId: string
    entityMapping: any
    isDeleted: false
    itemsKeyValue: any
    operationalInsightsResourceProvider: string
    resourceGroupName: string
    tenantId: string
    updated: string
    updatedBy:
        objectId: string
    watchlistAlias: string
    watchlistItemId: string
    watchlistItemType: string
    workspaceName: 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

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

    The WatchlistItem resource accepts the following input properties:

    ItemsKeyValue object
    key-value pairs for a watchlist item
    OperationalInsightsResourceProvider string
    The namespace of workspaces resource provider- Microsoft.OperationalInsights.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    WatchlistAlias string
    Watchlist Alias
    WorkspaceName string
    The name of the workspace.
    Created string
    The time the watchlist item was created
    CreatedBy Pulumi.AzureNative.SecurityInsights.Inputs.WatchlistUserInfo
    Describes a user that created the watchlist item
    EntityMapping object
    key-value pairs for a watchlist item entity mapping
    IsDeleted bool
    A flag that indicates if the watchlist item is deleted or not
    TenantId string
    The tenantId to which the watchlist item belongs to
    Updated string
    The last time the watchlist item was updated
    UpdatedBy Pulumi.AzureNative.SecurityInsights.Inputs.WatchlistUserInfo
    Describes a user that updated the watchlist item
    WatchlistItemId string
    The id (a Guid) of the watchlist item
    WatchlistItemType string
    The type of the watchlist item
    ItemsKeyValue interface{}
    key-value pairs for a watchlist item
    OperationalInsightsResourceProvider string
    The namespace of workspaces resource provider- Microsoft.OperationalInsights.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    WatchlistAlias string
    Watchlist Alias
    WorkspaceName string
    The name of the workspace.
    Created string
    The time the watchlist item was created
    CreatedBy WatchlistUserInfoArgs
    Describes a user that created the watchlist item
    EntityMapping interface{}
    key-value pairs for a watchlist item entity mapping
    IsDeleted bool
    A flag that indicates if the watchlist item is deleted or not
    TenantId string
    The tenantId to which the watchlist item belongs to
    Updated string
    The last time the watchlist item was updated
    UpdatedBy WatchlistUserInfoArgs
    Describes a user that updated the watchlist item
    WatchlistItemId string
    The id (a Guid) of the watchlist item
    WatchlistItemType string
    The type of the watchlist item
    itemsKeyValue Object
    key-value pairs for a watchlist item
    operationalInsightsResourceProvider String
    The namespace of workspaces resource provider- Microsoft.OperationalInsights.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    watchlistAlias String
    Watchlist Alias
    workspaceName String
    The name of the workspace.
    created String
    The time the watchlist item was created
    createdBy WatchlistUserInfo
    Describes a user that created the watchlist item
    entityMapping Object
    key-value pairs for a watchlist item entity mapping
    isDeleted Boolean
    A flag that indicates if the watchlist item is deleted or not
    tenantId String
    The tenantId to which the watchlist item belongs to
    updated String
    The last time the watchlist item was updated
    updatedBy WatchlistUserInfo
    Describes a user that updated the watchlist item
    watchlistItemId String
    The id (a Guid) of the watchlist item
    watchlistItemType String
    The type of the watchlist item
    itemsKeyValue any
    key-value pairs for a watchlist item
    operationalInsightsResourceProvider string
    The namespace of workspaces resource provider- Microsoft.OperationalInsights.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    watchlistAlias string
    Watchlist Alias
    workspaceName string
    The name of the workspace.
    created string
    The time the watchlist item was created
    createdBy WatchlistUserInfo
    Describes a user that created the watchlist item
    entityMapping any
    key-value pairs for a watchlist item entity mapping
    isDeleted boolean
    A flag that indicates if the watchlist item is deleted or not
    tenantId string
    The tenantId to which the watchlist item belongs to
    updated string
    The last time the watchlist item was updated
    updatedBy WatchlistUserInfo
    Describes a user that updated the watchlist item
    watchlistItemId string
    The id (a Guid) of the watchlist item
    watchlistItemType string
    The type of the watchlist item
    items_key_value Any
    key-value pairs for a watchlist item
    operational_insights_resource_provider str
    The namespace of workspaces resource provider- Microsoft.OperationalInsights.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    watchlist_alias str
    Watchlist Alias
    workspace_name str
    The name of the workspace.
    created str
    The time the watchlist item was created
    created_by WatchlistUserInfoArgs
    Describes a user that created the watchlist item
    entity_mapping Any
    key-value pairs for a watchlist item entity mapping
    is_deleted bool
    A flag that indicates if the watchlist item is deleted or not
    tenant_id str
    The tenantId to which the watchlist item belongs to
    updated str
    The last time the watchlist item was updated
    updated_by WatchlistUserInfoArgs
    Describes a user that updated the watchlist item
    watchlist_item_id str
    The id (a Guid) of the watchlist item
    watchlist_item_type str
    The type of the watchlist item
    itemsKeyValue Any
    key-value pairs for a watchlist item
    operationalInsightsResourceProvider String
    The namespace of workspaces resource provider- Microsoft.OperationalInsights.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    watchlistAlias String
    Watchlist Alias
    workspaceName String
    The name of the workspace.
    created String
    The time the watchlist item was created
    createdBy Property Map
    Describes a user that created the watchlist item
    entityMapping Any
    key-value pairs for a watchlist item entity mapping
    isDeleted Boolean
    A flag that indicates if the watchlist item is deleted or not
    tenantId String
    The tenantId to which the watchlist item belongs to
    updated String
    The last time the watchlist item was updated
    updatedBy Property Map
    Describes a user that updated the watchlist item
    watchlistItemId String
    The id (a Guid) of the watchlist item
    watchlistItemType String
    The type of the watchlist item

    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.
    Name string
    Azure resource name
    SystemData Pulumi.AzureNative.SecurityInsights.Outputs.SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    Azure resource type
    Etag string
    Etag of the azure resource
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Azure resource name
    SystemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    Azure resource type
    Etag string
    Etag of the azure resource
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Azure resource name
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    Azure resource type
    etag String
    Etag of the azure resource
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    Azure resource name
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type string
    Azure resource type
    etag string
    Etag of the azure resource
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    Azure resource name
    system_data SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type str
    Azure resource type
    etag str
    Etag of the azure resource
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Azure resource name
    systemData Property Map
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    Azure resource type
    etag String
    Etag of the azure resource

    Supporting Types

    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:WatchlistItem myresource1 /subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/Watchlists/highValueAsset/WatchlistItems/82ba292c-dc97-4dfc-969d-d4dd9e666842

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

    Package Details

    Repository
    azure-native-v1 pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native-v1 logo
    These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
    Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
    pulumi/pulumi-azure-native