Azure Native v1.102.0, May 2 23

azure-native.securityinsights.getWatchlistItem

Explore with Pulumi AI

Gets a watchlist, without its watchlist items. API Version: 2021-03-01-preview.

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>

def get_watchlist_item(operational_insights_resource_provider: Optional[str] = None,
                       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(operational_insights_resource_provider: Optional[pulumi.Input[str]] = None,
                       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]

func LookupWatchlistItem(ctx *Context, args *LookupWatchlistItemArgs, opts ...InvokeOption) (*LookupWatchlistItemResult, error)
func LookupWatchlistItemOutput(ctx *Context, args *LookupWatchlistItemOutputArgs, opts ...InvokeOption) LookupWatchlistItemResultOutput

> 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)
}

public static CompletableFuture<GetWatchlistItemResult> getWatchlistItem(GetWatchlistItemArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: azure-native:securityinsights:getWatchlistItem
  arguments:
    # arguments dictionary

The following arguments are supported:

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
WatchlistItemId string: Watchlist Item Id (GUID)
WorkspaceName string: The name of the workspace.

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
WatchlistItemId string: Watchlist Item Id (GUID)
WorkspaceName string: The name of the workspace.

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
watchlistItemId String: Watchlist Item Id (GUID)
workspaceName String: The name of the workspace.

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
watchlistItemId string: Watchlist Item Id (GUID)
workspaceName string: The name of the workspace.

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
watchlist_item_id str: Watchlist Item Id (GUID)
workspace_name str: The name of the workspace.

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
watchlistItemId String: Watchlist Item Id (GUID)
workspaceName String: The name of the workspace.

getWatchlistItem Result

The following output properties are available:

Id string: Azure resource Id
ItemsKeyValue object: key-value pairs for a watchlist item
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
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

Id string: Azure resource Id
ItemsKeyValue interface{}: key-value pairs for a watchlist item
Name string: Azure resource name
SystemData SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string: Azure resource type
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

id String: Azure resource Id
itemsKeyValue Object: key-value pairs for a watchlist item
name String: Azure resource name
systemData SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String: Azure resource type
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

id string: Azure resource Id
itemsKeyValue any: key-value pairs for a watchlist item
name string: Azure resource name
systemData SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.
type string: Azure resource type
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

id str: Azure resource Id
items_key_value Any: key-value pairs for a watchlist item
name str: Azure resource name
system_data SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.
type str: Azure resource type
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

id String: Azure resource Id
itemsKeyValue Any: key-value pairs for a watchlist item
name String: Azure resource name
systemData Property Map: Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String: Azure resource type
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 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.

Package Details

Repository: Azure Native pulumi/pulumi-azure-native
License: Apache-2.0