Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. securityinsights
  5. getWatchlistItem
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.securityinsights.getWatchlistItem

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

Get a watchlist item.

Uses Azure REST API version 2024-09-01.

Other available API versions: 2023-02-01, 2023-03-01-preview, 2023-04-01-preview, 2023-05-01-preview, 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, 2024-04-01-preview, 2024-10-01-preview, 2025-01-01-preview, 2025-03-01. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native securityinsights [ApiVersion]. See the version guide for details.

Using getWatchlistItem

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getWatchlistItem(args: GetWatchlistItemArgs, opts?: InvokeOptions): Promise<GetWatchlistItemResult>
function getWatchlistItemOutput(args: GetWatchlistItemOutputArgs, opts?: InvokeOptions): Output<GetWatchlistItemResult>
Copy
def get_watchlist_item(resource_group_name: Optional[str] = None,
                       watchlist_alias: Optional[str] = None,
                       watchlist_item_id: Optional[str] = None,
                       workspace_name: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetWatchlistItemResult
def get_watchlist_item_output(resource_group_name: Optional[pulumi.Input[str]] = None,
                       watchlist_alias: Optional[pulumi.Input[str]] = None,
                       watchlist_item_id: Optional[pulumi.Input[str]] = None,
                       workspace_name: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetWatchlistItemResult]
Copy
func LookupWatchlistItem(ctx *Context, args *LookupWatchlistItemArgs, opts ...InvokeOption) (*LookupWatchlistItemResult, error)
func LookupWatchlistItemOutput(ctx *Context, args *LookupWatchlistItemOutputArgs, opts ...InvokeOption) LookupWatchlistItemResultOutput
Copy

> Note: This function is named LookupWatchlistItem in the Go SDK.

public static class GetWatchlistItem 
{
    public static Task<GetWatchlistItemResult> InvokeAsync(GetWatchlistItemArgs args, InvokeOptions? opts = null)
    public static Output<GetWatchlistItemResult> Invoke(GetWatchlistItemInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetWatchlistItemResult> getWatchlistItem(GetWatchlistItemArgs args, InvokeOptions options)
public static Output<GetWatchlistItemResult> getWatchlistItem(GetWatchlistItemArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:securityinsights:getWatchlistItem
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
WatchlistAlias
This property is required.
Changes to this property will trigger replacement.
string
The watchlist alias
WatchlistItemId
This property is required.
Changes to this property will trigger replacement.
string
The watchlist item id (GUID)
WorkspaceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the workspace.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
WatchlistAlias
This property is required.
Changes to this property will trigger replacement.
string
The watchlist alias
WatchlistItemId
This property is required.
Changes to this property will trigger replacement.
string
The watchlist item id (GUID)
WorkspaceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the workspace.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
watchlistAlias
This property is required.
Changes to this property will trigger replacement.
String
The watchlist alias
watchlistItemId
This property is required.
Changes to this property will trigger replacement.
String
The watchlist item id (GUID)
workspaceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the workspace.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
watchlistAlias
This property is required.
Changes to this property will trigger replacement.
string
The watchlist alias
watchlistItemId
This property is required.
Changes to this property will trigger replacement.
string
The watchlist item id (GUID)
workspaceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the workspace.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
watchlist_alias
This property is required.
Changes to this property will trigger replacement.
str
The watchlist alias
watchlist_item_id
This property is required.
Changes to this property will trigger replacement.
str
The watchlist item id (GUID)
workspace_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the workspace.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
watchlistAlias
This property is required.
Changes to this property will trigger replacement.
String
The watchlist alias
watchlistItemId
This property is required.
Changes to this property will trigger replacement.
String
The watchlist item id (GUID)
workspaceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the workspace.

getWatchlistItem Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
Id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
ItemsKeyValue object
key-value pairs for a watchlist item
Name string
The name of the resource
SystemData Pulumi.AzureNative.SecurityInsights.Outputs.SystemDataResponse
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"
Created string
The time the watchlist item was created
CreatedBy Pulumi.AzureNative.SecurityInsights.Outputs.WatchlistUserInfoResponse
Describes a user that created the watchlist item
EntityMapping object
key-value pairs for a watchlist item entity mapping
Etag string
Etag of the azure resource
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.Outputs.WatchlistUserInfoResponse
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
AzureApiVersion string
The Azure API version of the resource.
Id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
ItemsKeyValue interface{}
key-value pairs for a watchlist item
Name string
The name of the resource
SystemData SystemDataResponse
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"
Created string
The time the watchlist item was created
CreatedBy WatchlistUserInfoResponse
Describes a user that created the watchlist item
EntityMapping interface{}
key-value pairs for a watchlist item entity mapping
Etag string
Etag of the azure resource
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 WatchlistUserInfoResponse
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
azureApiVersion String
The Azure API version of the resource.
id String
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
itemsKeyValue Object
key-value pairs for a watchlist item
name String
The name of the resource
systemData SystemDataResponse
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"
created String
The time the watchlist item was created
createdBy WatchlistUserInfoResponse
Describes a user that created the watchlist item
entityMapping Object
key-value pairs for a watchlist item entity mapping
etag String
Etag of the azure resource
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 WatchlistUserInfoResponse
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
azureApiVersion string
The Azure API version of the resource.
id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
itemsKeyValue any
key-value pairs for a watchlist item
name string
The name of the resource
systemData SystemDataResponse
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"
created string
The time the watchlist item was created
createdBy WatchlistUserInfoResponse
Describes a user that created the watchlist item
entityMapping any
key-value pairs for a watchlist item entity mapping
etag string
Etag of the azure resource
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 WatchlistUserInfoResponse
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
azure_api_version str
The Azure API version of the resource.
id str
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
items_key_value Any
key-value pairs for a watchlist item
name str
The name of the resource
system_data SystemDataResponse
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"
created str
The time the watchlist item was created
created_by WatchlistUserInfoResponse
Describes a user that created the watchlist item
entity_mapping Any
key-value pairs for a watchlist item entity mapping
etag str
Etag of the azure resource
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 WatchlistUserInfoResponse
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
azureApiVersion String
The Azure API version of the resource.
id String
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
itemsKeyValue Any
key-value pairs for a watchlist item
name String
The name of the resource
systemData 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"
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
etag String
Etag of the azure resource
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

Supporting Types

SystemDataResponse

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.

WatchlistUserInfoResponse

Email This property is required. string
The email of the user.
Name This property is required. string
The name of the user.
ObjectId string
The object id of the user.
Email This property is required. string
The email of the user.
Name This property is required. string
The name of the user.
ObjectId string
The object id of the user.
email This property is required. String
The email of the user.
name This property is required. String
The name of the user.
objectId String
The object id of the user.
email This property is required. string
The email of the user.
name This property is required. string
The name of the user.
objectId string
The object id of the user.
email This property is required. str
The email of the user.
name This property is required. str
The name of the user.
object_id str
The object id of the user.
email This property is required. String
The email of the user.
name This property is required. String
The name of the user.
objectId String
The object id of the user.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native