Microsoft.SecurityInsights watchlists/watchlistItems 2019-01-01-preview

  • Article

Bicep resource definition

The watchlists/watchlistItems resource type can be deployed to:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.SecurityInsights/watchlists/watchlistItems resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.SecurityInsights/watchlists/watchlistItems@2019-01-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  etag: 'string'
  properties: {
    created: 'string'
    createdBy: {
      objectId: 'string'
    }
    entityMapping: any()
    isDeleted: bool
    itemsKeyValue: any()
    tenantId: 'string'
    updated: 'string'
    updatedBy: {
      objectId: 'string'
    }
    watchlistItemId: 'string'
    watchlistItemType: 'string'
  }
}

Property values

watchlists/watchlistItems

Name Description Value
name The resource name

See how to set names and types for child resources in Bicep.		 string (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.		 Symbolic name for resource of type: watchlists
etag Etag of the azure resource string
properties Watchlist Item properties WatchlistItemProperties

WatchlistItemProperties

Name Description Value
created The time the watchlist item was created string
createdBy Describes a user that created the watchlist item UserInfo
entityMapping key-value pairs for a watchlist item entity mapping For Bicep, you can use the any() function.
isDeleted A flag that indicates if the watchlist item is deleted or not bool
itemsKeyValue key-value pairs for a watchlist item For Bicep, you can use the any() function.(required)
tenantId The tenantId to which the watchlist item belongs to string
updated The last time the watchlist item was updated string
updatedBy Describes a user that updated the watchlist item UserInfo
watchlistItemId The id (a Guid) of the watchlist item string
watchlistItemType The type of the watchlist item string

UserInfo

Name Description Value
objectId The object id of the user. string

ARM template resource definition

The watchlists/watchlistItems resource type can be deployed to:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.SecurityInsights/watchlists/watchlistItems resource, add the following JSON to your template.

{
  "type": "Microsoft.SecurityInsights/watchlists/watchlistItems",
  "apiVersion": "2019-01-01-preview",
  "name": "string",
  "etag": "string",
  "properties": {
    "created": "string",
    "createdBy": {
      "objectId": "string"
    },
    "entityMapping": {},
    "isDeleted": "bool",
    "itemsKeyValue": {},
    "tenantId": "string",
    "updated": "string",
    "updatedBy": {
      "objectId": "string"
    },
    "watchlistItemId": "string",
    "watchlistItemType": "string"
  }
}

Property values

watchlists/watchlistItems

Name Description Value
type The resource type 'Microsoft.SecurityInsights/watchlists/watchlistItems'
apiVersion The resource api version '2019-01-01-preview'
name The resource name

See how to set names and types for child resources in JSON ARM templates.		 string (required)
etag Etag of the azure resource string
properties Watchlist Item properties WatchlistItemProperties

WatchlistItemProperties

Name Description Value
created The time the watchlist item was created string
createdBy Describes a user that created the watchlist item UserInfo
entityMapping key-value pairs for a watchlist item entity mapping
isDeleted A flag that indicates if the watchlist item is deleted or not bool
itemsKeyValue key-value pairs for a watchlist item
tenantId The tenantId to which the watchlist item belongs to string
updated The last time the watchlist item was updated string
updatedBy Describes a user that updated the watchlist item UserInfo
watchlistItemId The id (a Guid) of the watchlist item string
watchlistItemType The type of the watchlist item string

UserInfo

Name Description Value
objectId The object id of the user. string

Terraform (AzAPI provider) resource definition

The watchlists/watchlistItems resource type can be deployed to:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.SecurityInsights/watchlists/watchlistItems resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.SecurityInsights/watchlists/watchlistItems@2019-01-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      created = "string"
      createdBy = {
        objectId = "string"
      }
      isDeleted = bool
      tenantId = "string"
      updated = "string"
      updatedBy = {
        objectId = "string"
      }
      watchlistItemId = "string"
      watchlistItemType = "string"
    }
    etag = "string"
  })
}

Property values

watchlists/watchlistItems

Name Description Value
type The resource type "Microsoft.SecurityInsights/watchlists/watchlistItems@2019-01-01-preview"
name The resource name string (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: watchlists
etag Etag of the azure resource string
properties Watchlist Item properties WatchlistItemProperties

WatchlistItemProperties

Name Description Value
created The time the watchlist item was created string
createdBy Describes a user that created the watchlist item UserInfo
entityMapping key-value pairs for a watchlist item entity mapping
isDeleted A flag that indicates if the watchlist item is deleted or not bool
itemsKeyValue key-value pairs for a watchlist item
tenantId The tenantId to which the watchlist item belongs to string
updated The last time the watchlist item was updated string
updatedBy Describes a user that updated the watchlist item UserInfo
watchlistItemId The id (a Guid) of the watchlist item string
watchlistItemType The type of the watchlist item string

UserInfo

Name Description Value
objectId The object id of the user. string