azure-native.securityinsights.WatchlistItem
Explore with Pulumi AI
Represents a Watchlist Item in Azure Security Insights. Azure REST API version: 2023-02-01. Prior API version in Azure Native 1.x: 2021-03-01-preview.
Other available API versions: 2021-04-01, 2023-06-01-preview, 2023-07-01-preview, 2023-08-01-preview, 2023-09-01-preview, 2023-10-01-preview, 2023-11-01, 2023-12-01-preview, 2024-01-01-preview, 2024-03-01.
Example Usage
Create or update a watchlist 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 = new Dictionary<string, object?>
{
["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",
},
ResourceGroupName = "myRg",
WatchlistAlias = "highValueAsset",
WatchlistItemId = "82ba292c-dc97-4dfc-969d-d4dd9e666842",
WorkspaceName = "myWorkspace",
});
});
package main
import (
securityinsights "github.com/pulumi/pulumi-azure-native-sdk/securityinsights/v2"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := securityinsights.NewWatchlistItem(ctx, "watchlistItem", &securityinsights.WatchlistItemArgs{
ItemsKeyValue: pulumi.Any(map[string]interface{}{
"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",
}),
ResourceGroupName: pulumi.String("myRg"),
WatchlistAlias: pulumi.String("highValueAsset"),
WatchlistItemId: pulumi.String("82ba292c-dc97-4dfc-969d-d4dd9e666842"),
WorkspaceName: pulumi.String("myWorkspace"),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.securityinsights.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")
))
.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",
},
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",
},
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
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,
items_key_value: Optional[Any] = None,
workspace_name: Optional[str] = None,
watchlist_alias: Optional[str] = None,
resource_group_name: Optional[str] = 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()
{
ItemsKeyValue = "any",
WorkspaceName = "string",
WatchlistAlias = "string",
ResourceGroupName = "string",
IsDeleted = false,
Created = "string",
TenantId = "string",
Updated = "string",
UpdatedBy = new AzureNative.SecurityInsights.Inputs.WatchlistUserInfoArgs
{
ObjectId = "string",
},
EntityMapping = "any",
WatchlistItemId = "string",
WatchlistItemType = "string",
CreatedBy = new AzureNative.SecurityInsights.Inputs.WatchlistUserInfoArgs
{
ObjectId = "string",
},
});
example, err := securityinsights.NewWatchlistItem(ctx, "watchlistItemResource", &securityinsights.WatchlistItemArgs{
ItemsKeyValue: pulumi.Any("any"),
WorkspaceName: pulumi.String("string"),
WatchlistAlias: pulumi.String("string"),
ResourceGroupName: pulumi.String("string"),
IsDeleted: pulumi.Bool(false),
Created: pulumi.String("string"),
TenantId: pulumi.String("string"),
Updated: pulumi.String("string"),
UpdatedBy: &securityinsights.WatchlistUserInfoArgs{
ObjectId: pulumi.String("string"),
},
EntityMapping: pulumi.Any("any"),
WatchlistItemId: pulumi.String("string"),
WatchlistItemType: pulumi.String("string"),
CreatedBy: &securityinsights.WatchlistUserInfoArgs{
ObjectId: pulumi.String("string"),
},
})
var watchlistItemResource = new WatchlistItem("watchlistItemResource", WatchlistItemArgs.builder()
.itemsKeyValue("any")
.workspaceName("string")
.watchlistAlias("string")
.resourceGroupName("string")
.isDeleted(false)
.created("string")
.tenantId("string")
.updated("string")
.updatedBy(WatchlistUserInfoArgs.builder()
.objectId("string")
.build())
.entityMapping("any")
.watchlistItemId("string")
.watchlistItemType("string")
.createdBy(WatchlistUserInfoArgs.builder()
.objectId("string")
.build())
.build());
watchlist_item_resource = azure_native.securityinsights.WatchlistItem("watchlistItemResource",
items_key_value="any",
workspace_name="string",
watchlist_alias="string",
resource_group_name="string",
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", {
itemsKeyValue: "any",
workspaceName: "string",
watchlistAlias: "string",
resourceGroupName: "string",
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
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
The WatchlistItem resource accepts the following input properties:
- Items
Key objectValue - key-value pairs for a watchlist item
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Watchlist
Alias string - The watchlist alias
- Workspace
Name string - The name of the workspace.
- Created string
- The time the watchlist item was created
- Created
By Pulumi.Azure Native. Security Insights. Inputs. Watchlist User Info - Describes a user that created the watchlist item
- Entity
Mapping object - 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 string - The tenantId to which the watchlist item belongs to
- Updated string
- The last time the watchlist item was updated
- Updated
By Pulumi.Azure Native. Security Insights. Inputs. Watchlist User Info - Describes a user that updated the watchlist item
- Watchlist
Item stringId - The id (a Guid) of the watchlist item
- Watchlist
Item stringType - The type of the watchlist item
- Items
Key interface{}Value - key-value pairs for a watchlist item
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Watchlist
Alias string - The watchlist alias
- Workspace
Name string - The name of the workspace.
- Created string
- The time the watchlist item was created
- Created
By WatchlistUser Info Args - Describes a user that created the watchlist item
- Entity
Mapping interface{} - 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 string - The tenantId to which the watchlist item belongs to
- Updated string
- The last time the watchlist item was updated
- Updated
By WatchlistUser Info Args - Describes a user that updated the watchlist item
- Watchlist
Item stringId - The id (a Guid) of the watchlist item
- Watchlist
Item stringType - The type of the watchlist item
- items
Key ObjectValue - key-value pairs for a watchlist item
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- watchlist
Alias String - The watchlist alias
- workspace
Name String - The name of the workspace.
- created String
- The time the watchlist item was created
- created
By WatchlistUser Info - Describes a user that created the watchlist item
- entity
Mapping Object - key-value pairs for a watchlist item entity mapping
- is
Deleted Boolean - A flag that indicates if the watchlist item is deleted or not
- tenant
Id String - The tenantId to which the watchlist item belongs to
- updated String
- The last time the watchlist item was updated
- updated
By WatchlistUser Info - Describes a user that updated the watchlist item
- watchlist
Item StringId - The id (a Guid) of the watchlist item
- watchlist
Item StringType - The type of the watchlist item
- items
Key anyValue - key-value pairs for a watchlist item
- resource
Group stringName - The name of the resource group. The name is case insensitive.
- watchlist
Alias string - The watchlist alias
- workspace
Name string - The name of the workspace.
- created string
- The time the watchlist item was created
- created
By WatchlistUser Info - Describes a user that created the watchlist item
- entity
Mapping any - key-value pairs for a watchlist item entity mapping
- is
Deleted boolean - A flag that indicates if the watchlist item is deleted or not
- tenant
Id string - The tenantId to which the watchlist item belongs to
- updated string
- The last time the watchlist item was updated
- updated
By WatchlistUser Info - Describes a user that updated the watchlist item
- watchlist
Item stringId - The id (a Guid) of the watchlist item
- watchlist
Item stringType - The type of the watchlist item
- items_
key_ Anyvalue - key-value pairs for a watchlist item
- resource_
group_ strname - The name of the resource group. The name is case insensitive.
- watchlist_
alias str - The watchlist alias
- workspace_
name str - The name of the workspace.
- created str
- The time the watchlist item was created
- created_
by WatchlistUser Info Args - 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 WatchlistUser Info Args - Describes a user that updated the watchlist item
- watchlist_
item_ strid - The id (a Guid) of the watchlist item
- watchlist_
item_ strtype - The type of the watchlist item
- items
Key AnyValue - key-value pairs for a watchlist item
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- watchlist
Alias String - The watchlist alias
- workspace
Name String - The name of the workspace.
- created String
- The time the watchlist item was created
- created
By Property Map - Describes a user that created the watchlist item
- entity
Mapping Any - key-value pairs for a watchlist item entity mapping
- is
Deleted Boolean - A flag that indicates if the watchlist item is deleted or not
- tenant
Id String - The tenantId to which the watchlist item belongs to
- updated String
- The last time the watchlist item was updated
- updated
By Property Map - Describes a user that updated the watchlist item
- watchlist
Item StringId - The id (a Guid) of the watchlist item
- watchlist
Item StringType - 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
- The name of the resource
- System
Data Pulumi.Azure Native. Security Insights. Outputs. System Data Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- Etag string
- Etag of the azure resource
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- The name of the resource
- System
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- Etag string
- Etag of the azure resource
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- The name of the resource
- system
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- etag String
- Etag of the azure resource
- id string
- The provider-assigned unique ID for this managed resource.
- name string
- The name of the resource
- system
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- etag string
- Etag of the azure resource
- id str
- The provider-assigned unique ID for this managed resource.
- name str
- The name of the resource
- system_
data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type str
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- etag str
- Etag of the azure resource
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- The name of the resource
- system
Data Property Map - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- etag String
- Etag of the azure resource
Supporting Types
SystemDataResponse, SystemDataResponseArgs
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
- created
At string - The timestamp of resource creation (UTC).
- created
By string - The identity that created the resource.
- created
By stringType - The type of identity that created the resource.
- last
Modified stringAt - The timestamp of resource last modification (UTC)
- last
Modified stringBy - The identity that last modified the resource.
- last
Modified stringBy Type - 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_ strtype - The type of identity that created the resource.
- last_
modified_ strat - The timestamp of resource last modification (UTC)
- last_
modified_ strby - The identity that last modified the resource.
- last_
modified_ strby_ type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
WatchlistUserInfo, WatchlistUserInfoArgs
- Object
Id string - The object id of the user.
- Object
Id string - The object id of the user.
- object
Id String - The object id of the user.
- object
Id string - The object id of the user.
- object_
id str - The object id of the user.
- object
Id String - The object id of the user.
WatchlistUserInfoResponse, WatchlistUserInfoResponseArgs
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:securityinsights:WatchlistItem myresource1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/watchlists/{watchlistAlias}/watchlistItems/{watchlistItemId}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0