你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Microsoft.SecurityInsights 监视列表 2022-08-01

Bicep 资源定义

监视列表资源类型可以部署到:

有关每个 API 版本中已更改属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.SecurityInsights/watchlists 资源,请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.SecurityInsights/watchlists@2022-08-01' = {
  name: 'string'
  etag: 'string'
  properties: {
    contentType: 'string'
    created: 'string'
    createdBy: {
      objectId: 'string'
    }
    defaultDuration: 'string'
    description: 'string'
    displayName: 'string'
    isDeleted: bool
    itemsSearchKey: 'string'
    labels: [
      'string'
    ]
    numberOfLinesToSkip: int
    provider: 'string'
    rawContent: 'string'
    source: 'string'
    tenantId: 'string'
    updated: 'string'
    updatedBy: {
      objectId: 'string'
    }
    uploadStatus: 'string'
    watchlistAlias: 'string'
    watchlistId: 'string'
    watchlistType: 'string'
  }
}

属性值

watchlists

名称 说明
name 资源名称 字符串 (必需)
etag Azure 资源的 Etag string
properties 监视列表属性 WatchlistProperties

WatchlistProperties

名称 说明
contentType 原始内容的内容类型。 目前,只有文本/csv 有效 string
created 创建监视列表的时间 string
createdBy 描述创建监视列表的用户 UserInfo
defaultDuration 以 ISO 8601 持续时间格式 (监视列表的默认持续时间) string
description 监视列表的说明 string
displayName 监视列表的显示名称 字符串 (必需)
isDeleted 指示是否删除监视列表的标志 bool
itemsSearchKey 使用监视列表与其他数据进行联接时,搜索键用于优化查询性能。 例如,将具有 IP 地址的列设置为指定的 SearchKey 字段,然后在按 IP 地址联接到其他事件数据时将此字段用作键字段。 字符串 (必需)
标签 与该监视列表相关的标签列表 string[]
numberOfLinesToSkip csv 内容中要跳过标题之前的行数 int
provider 监视列表的提供程序 字符串 (必需)
rawContent 表示要创建的监视列表项的原始内容。 示例:将跳过此行
header1,header2
value1,value2
string
source 监视列表的源 “本地文件”
“远程存储” ()
tenantId 监视列表所属的 tenantId string
已更新 上次更新监视列表的时间 string
updatedBy 描述更新了监视列表的用户 UserInfo
uploadStatus 监视列表上传的状态:“新建”、“正在进行”或“完成”。 注意 :当监视列表上传状态为 InProgress 时,无法删除监视列表 字符串
watchlistAlias 监视列表的别名 string
watchlistId id (监视列表的 Guid) string
watchlistType 监视列表的类型 string

UserInfo

名称 说明
objectId 用户的对象 ID。 string

ARM 模板资源定义

可将监视列表资源类型部署到:

有关每个 API 版本中更改的属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.SecurityInsights/watchlists 资源,请将以下 JSON 添加到模板。

{
  "type": "Microsoft.SecurityInsights/watchlists",
  "apiVersion": "2022-08-01",
  "name": "string",
  "etag": "string",
  "properties": {
    "contentType": "string",
    "created": "string",
    "createdBy": {
      "objectId": "string"
    },
    "defaultDuration": "string",
    "description": "string",
    "displayName": "string",
    "isDeleted": "bool",
    "itemsSearchKey": "string",
    "labels": [ "string" ],
    "numberOfLinesToSkip": "int",
    "provider": "string",
    "rawContent": "string",
    "source": "string",
    "tenantId": "string",
    "updated": "string",
    "updatedBy": {
      "objectId": "string"
    },
    "uploadStatus": "string",
    "watchlistAlias": "string",
    "watchlistId": "string",
    "watchlistType": "string"
  }
}

属性值

watchlists

名称 说明 Value
type 资源类型 “Microsoft.SecurityInsights/watchlists”
apiVersion 资源 API 版本 '2022-08-01'
name 资源名称 字符串 (必需)
etag Azure 资源的 Etag string
properties 监视列表属性 WatchlistProperties

WatchlistProperties

名称 说明
contentType 原始内容的内容类型。 目前,只有文本/csv 有效 string
created 创建监视列表的时间 string
createdBy 描述创建监视列表的用户 UserInfo
defaultDuration 监视列表的默认持续时间 (ISO 8601 持续时间格式) 字符串
description 监视列表的说明 string
displayName 监视列表的显示名称 字符串 (必需)
isDeleted 指示是否删除监视列表的标志 bool
itemsSearchKey 使用监视列表与其他数据进行联接时,搜索键用于优化查询性能。 例如,启用具有 IP 地址的列作为指定的 SearchKey 字段,然后在按 IP 地址联接到其他事件数据时将此字段用作键字段。 字符串 (必需)
标签 与此监视列表相关的标签列表 string[]
numberOfLinesToSkip csv 内容中要跳过标题前的行数 int
provider 监视列表的提供程序 字符串 (必需)
rawContent 表示要创建的监视列表项的原始内容。 示例:将跳过此行
header1,header2
value1,value2
string
source 监视列表的源 “本地文件”
“远程存储” (必需)
tenantId 监视列表所属的 tenantId 字符串
已更新 上次更新监视列表的时间 字符串
updatedBy 描述更新了监视列表的用户 UserInfo
uploadStatus 监视列表上传的状态:“新建”、“正在进行”或“完成”。 注意 :当监视列表上传状态为 InProgress 时,无法删除监视列表 字符串
watchlistAlias 监视列表的别名 字符串
watchlistId id (监视列表的 Guid) 字符串
watchlistType 监视列表的类型 字符串

UserInfo

名称 说明
objectId 用户的对象 ID。 字符串

Terraform (AzAPI 提供程序) 资源定义

可将监视列表资源类型部署到:

有关每个 API 版本中更改的属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.SecurityInsights/watchlists 资源,请将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.SecurityInsights/watchlists@2022-08-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      contentType = "string"
      created = "string"
      createdBy = {
        objectId = "string"
      }
      defaultDuration = "string"
      description = "string"
      displayName = "string"
      isDeleted = bool
      itemsSearchKey = "string"
      labels = [
        "string"
      ]
      numberOfLinesToSkip = int
      provider = "string"
      rawContent = "string"
      source = "string"
      tenantId = "string"
      updated = "string"
      updatedBy = {
        objectId = "string"
      }
      uploadStatus = "string"
      watchlistAlias = "string"
      watchlistId = "string"
      watchlistType = "string"
    }
    etag = "string"
  })
}

属性值

watchlists

名称 说明 Value
type 资源类型 “Microsoft.SecurityInsights/watchlists@2022-08-01”
name 资源名称 字符串 (必需)
parent_id 字符串 (必需)
etag Azure 资源的 Etag string
properties 监视列表属性 WatchlistProperties

WatchlistProperties

名称 说明
contentType 原始内容的内容类型。 目前,只有文本/csv 有效 string
created 创建监视列表的时间 字符串
createdBy 描述创建监视列表的用户 UserInfo
defaultDuration 监视列表的默认持续时间 (ISO 8601 持续时间格式) string
description 监视列表的说明 string
displayName 监视列表的显示名称 字符串 (必需)
isDeleted 指示是否删除监视列表的标志 bool
itemsSearchKey 使用监视列表与其他数据进行联接时,搜索键用于优化查询性能。 例如,启用具有 IP 地址的列作为指定的 SearchKey 字段,然后在按 IP 地址联接到其他事件数据时将此字段用作键字段。 字符串 (必需)
标签 与此监视列表相关的标签列表 string[]
numberOfLinesToSkip csv 内容中要跳过标题前的行数 int
provider 监视列表的提供程序 字符串 (必需)
rawContent 表示要创建的监视列表项的原始内容。 示例:将跳过此行
header1,header2
value1,value2
string
source 监视列表的源 “本地文件”
“远程存储” (必需)
tenantId 监视列表所属的 tenantId string
已更新 上次更新监视列表的时间 字符串
updatedBy 描述更新了监视列表的用户 UserInfo
uploadStatus 监视列表上传的状态:“新建”、“正在进行”或“完成”。 注意 :当监视列表上传状态为 InProgress 时,无法删除监视列表 字符串
watchlistAlias 监视列表的别名 字符串
watchlistId id (监视列表的 Guid) string
watchlistType 监视列表的类型 string

UserInfo

名称 说明
objectId 用户的对象 ID。 字符串