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

Microsoft.Network networkWatchers/flowLogs

Bicep 资源定义

可以使用目标操作部署 networkWatchers/flowLogs 资源类型:

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

资源格式

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

resource symbolicname 'Microsoft.Network/networkWatchers/flowLogs@2024-03-01' = {
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    enabled: bool
    enabledFilteringCriteria: 'string'
    flowAnalyticsConfiguration: {
      networkWatcherFlowAnalyticsConfiguration: {
        enabled: bool
        trafficAnalyticsInterval: int
        workspaceId: 'string'
        workspaceRegion: 'string'
        workspaceResourceId: 'string'
      }
    }
    format: {
      type: 'string'
      version: int
    }
    retentionPolicy: {
      days: int
      enabled: bool
    }
    storageId: 'string'
    targetResourceId: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

属性值

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

名字 描述 价值

FlowLogFormatParameters

名字 描述 价值
类型 流日志的文件类型。 “JSON”
版本 流日志的版本(修订版)。 int

FlowLogPropertiesFormat

名字 描述 价值
启用 用于启用/禁用流日志记录的标志。 bool
enabledFilteringCriteria 可选字段,用于根据 SrcIP、SrcPort、DstIP、DstPort、协议、加密、方向和操作筛选网络流量日志。 如果未指定,将记录所有网络流量。 字符串
flowAnalyticsConfiguration 定义流量分析配置的参数。 TrafficAnalyticsProperties
格式 定义流日志格式的参数。 FlowLogFormatParameters
retentionPolicy 定义流日志保留策略的参数。 RetentionPolicyParameters
storageId 用于存储流日志的存储帐户的 ID。 string (必需)
targetResourceId 将向其应用流日志的网络安全组的 ID。 string (必需)

ManagedServiceIdentity

名字 描述 价值
类型 用于资源的标识类型。 类型“SystemAssigned,UserAssigned”包括隐式创建的标识和一组用户分配的标识。 类型“None”将从虚拟机中删除任何标识。 “None”
“SystemAssigned”
“SystemAssigned,UserAssigned”
“UserAssigned”
userAssignedIdentities 与资源关联的用户标识列表。 用户标识字典密钥引用的格式为 ARM 资源 ID:“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。 ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

名字 描述 价值

Microsoft.Network/networkWatchers/flowLogs

名字 描述 价值
身份 FlowLog 资源托管标识 ManagedServiceIdentity
位置 资源位置。 字符串
名字 资源名称 string (必需)
父母 在 Bicep 中,可以为子资源指定父资源。 仅当子资源在父资源外部声明时,才需要添加此属性。

有关详细信息,请参阅 父资源外部的子资源
类型资源的符号名称:networkWatchers
性能 流日志的属性。 FlowLogPropertiesFormat
标签 资源标记 标记名称和值的字典。 请参阅模板 中的 标记

ResourceTags

名字 描述 价值

RetentionPolicyParameters

名字 描述 价值
保留流日志记录的天数。 int
启用 用于启用/禁用保留的标志。 bool

TrafficAnalyticsConfigurationProperties

名字 描述 价值
启用 用于启用/禁用流量分析的标志。 bool
trafficAnalyticsInterval 以分钟为单位的时间间隔,决定 TA 服务应执行流分析的频率。 int
workspaceId 附加工作区的资源 GUID。 字符串
workspaceRegion 附加工作区的位置。 字符串
workspaceResourceId 附加工作区的资源 ID。 字符串

TrafficAnalyticsProperties

名字 描述 价值
networkWatcherFlowAnalyticsConfiguration 定义流量分析配置的参数。 TrafficAnalyticsConfigurationProperties

快速入门示例

以下快速入门示例部署此资源类型。

Bicep 文件 描述
启用 NSG 流日志 此模板创建 NSG 流日志资源
使用流量分析 NSG 流日志 此模板使用流量分析在现有 NSG 上创建 NSG 流日志

ARM 模板资源定义

可以使用目标操作部署 networkWatchers/flowLogs 资源类型:

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

资源格式

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

{
  "type": "Microsoft.Network/networkWatchers/flowLogs",
  "apiVersion": "2024-03-01",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "location": "string",
  "properties": {
    "enabled": "bool",
    "enabledFilteringCriteria": "string",
    "flowAnalyticsConfiguration": {
      "networkWatcherFlowAnalyticsConfiguration": {
        "enabled": "bool",
        "trafficAnalyticsInterval": "int",
        "workspaceId": "string",
        "workspaceRegion": "string",
        "workspaceResourceId": "string"
      }
    },
    "format": {
      "type": "string",
      "version": "int"
    },
    "retentionPolicy": {
      "days": "int",
      "enabled": "bool"
    },
    "storageId": "string",
    "targetResourceId": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

属性值

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

名字 描述 价值

FlowLogFormatParameters

名字 描述 价值
类型 流日志的文件类型。 “JSON”
版本 流日志的版本(修订版)。 int

FlowLogPropertiesFormat

名字 描述 价值
启用 用于启用/禁用流日志记录的标志。 bool
enabledFilteringCriteria 可选字段,用于根据 SrcIP、SrcPort、DstIP、DstPort、协议、加密、方向和操作筛选网络流量日志。 如果未指定,将记录所有网络流量。 字符串
flowAnalyticsConfiguration 定义流量分析配置的参数。 TrafficAnalyticsProperties
格式 定义流日志格式的参数。 FlowLogFormatParameters
retentionPolicy 定义流日志保留策略的参数。 RetentionPolicyParameters
storageId 用于存储流日志的存储帐户的 ID。 string (必需)
targetResourceId 将向其应用流日志的网络安全组的 ID。 string (必需)

ManagedServiceIdentity

名字 描述 价值
类型 用于资源的标识类型。 类型“SystemAssigned,UserAssigned”包括隐式创建的标识和一组用户分配的标识。 类型“None”将从虚拟机中删除任何标识。 “None”
“SystemAssigned”
“SystemAssigned,UserAssigned”
“UserAssigned”
userAssignedIdentities 与资源关联的用户标识列表。 用户标识字典密钥引用的格式为 ARM 资源 ID:“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。 ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

名字 描述 价值

Microsoft.Network/networkWatchers/flowLogs

名字 描述 价值
apiVersion API 版本 '2024-03-01'
身份 FlowLog 资源托管标识 ManagedServiceIdentity
位置 资源位置。 字符串
名字 资源名称 string (必需)
性能 流日志的属性。 FlowLogPropertiesFormat
标签 资源标记 标记名称和值的字典。 请参阅模板 中的 标记
类型 资源类型 “Microsoft.Network/networkWatchers/flowLogs”

ResourceTags

名字 描述 价值

RetentionPolicyParameters

名字 描述 价值
保留流日志记录的天数。 int
启用 用于启用/禁用保留的标志。 bool

TrafficAnalyticsConfigurationProperties

名字 描述 价值
启用 用于启用/禁用流量分析的标志。 bool
trafficAnalyticsInterval 以分钟为单位的时间间隔,决定 TA 服务应执行流分析的频率。 int
workspaceId 附加工作区的资源 GUID。 字符串
workspaceRegion 附加工作区的位置。 字符串
workspaceResourceId 附加工作区的资源 ID。 字符串

TrafficAnalyticsProperties

名字 描述 价值
networkWatcherFlowAnalyticsConfiguration 定义流量分析配置的参数。 TrafficAnalyticsConfigurationProperties

快速入门模板

以下快速入门模板部署此资源类型。

模板 描述
启用 NSG 流日志

部署到 Azure
此模板创建 NSG 流日志资源
使用流量分析 NSG 流日志

部署到 Azure
此模板使用流量分析在现有 NSG 上创建 NSG 流日志

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

可以使用目标操作部署 networkWatchers/flowLogs 资源类型:

  • 资源组

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

资源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/networkWatchers/flowLogs@2024-03-01"
  name = "string"
  identity = {
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
      }
    }
  }
  location = "string"
  body = jsonencode({
    properties = {
      enabled = bool
      enabledFilteringCriteria = "string"
      flowAnalyticsConfiguration = {
        networkWatcherFlowAnalyticsConfiguration = {
          enabled = bool
          trafficAnalyticsInterval = int
          workspaceId = "string"
          workspaceRegion = "string"
          workspaceResourceId = "string"
        }
      }
      format = {
        type = "string"
        version = int
      }
      retentionPolicy = {
        days = int
        enabled = bool
      }
      storageId = "string"
      targetResourceId = "string"
    }
  })
  tags = {
    {customized property} = "string"
  }
}

属性值

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

名字 描述 价值

FlowLogFormatParameters

名字 描述 价值
类型 流日志的文件类型。 “JSON”
版本 流日志的版本(修订版)。 int

FlowLogPropertiesFormat

名字 描述 价值
启用 用于启用/禁用流日志记录的标志。 bool
enabledFilteringCriteria 可选字段,用于根据 SrcIP、SrcPort、DstIP、DstPort、协议、加密、方向和操作筛选网络流量日志。 如果未指定,将记录所有网络流量。 字符串
flowAnalyticsConfiguration 定义流量分析配置的参数。 TrafficAnalyticsProperties
格式 定义流日志格式的参数。 FlowLogFormatParameters
retentionPolicy 定义流日志保留策略的参数。 RetentionPolicyParameters
storageId 用于存储流日志的存储帐户的 ID。 string (必需)
targetResourceId 将向其应用流日志的网络安全组的 ID。 string (必需)

ManagedServiceIdentity

名字 描述 价值
类型 用于资源的标识类型。 类型“SystemAssigned,UserAssigned”包括隐式创建的标识和一组用户分配的标识。 类型“None”将从虚拟机中删除任何标识。 “None”
“SystemAssigned”
“SystemAssigned,UserAssigned”
“UserAssigned”
userAssignedIdentities 与资源关联的用户标识列表。 用户标识字典密钥引用的格式为 ARM 资源 ID:“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。 ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

名字 描述 价值

Microsoft.Network/networkWatchers/flowLogs

名字 描述 价值
身份 FlowLog 资源托管标识 ManagedServiceIdentity
位置 资源位置。 字符串
名字 资源名称 string (必需)
parent_id 此资源的父资源的 ID。 类型资源的 ID:networkWatchers
性能 流日志的属性。 FlowLogPropertiesFormat
标签 资源标记 标记名称和值的字典。
类型 资源类型 “Microsoft.Network/networkWatchers/flowLogs@2024-03-01”

ResourceTags

名字 描述 价值

RetentionPolicyParameters

名字 描述 价值
保留流日志记录的天数。 int
启用 用于启用/禁用保留的标志。 bool

TrafficAnalyticsConfigurationProperties

名字 描述 价值
启用 用于启用/禁用流量分析的标志。 bool
trafficAnalyticsInterval 以分钟为单位的时间间隔,决定 TA 服务应执行流分析的频率。 int
workspaceId 附加工作区的资源 GUID。 字符串
workspaceRegion 附加工作区的位置。 字符串
workspaceResourceId 附加工作区的资源 ID。 字符串

TrafficAnalyticsProperties

名字 描述 价值
networkWatcherFlowAnalyticsConfiguration 定义流量分析配置的参数。 TrafficAnalyticsConfigurationProperties