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

Microsoft.Network networkWatchers/packetCaptures 2019-08-01

Bicep 资源定义

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

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

资源格式

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

resource symbolicname 'Microsoft.Network/networkWatchers/packetCaptures@2019-08-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    bytesToCapturePerPacket: int
    filters: [
      {
        localIPAddress: 'string'
        localPort: 'string'
        protocol: 'string'
        remoteIPAddress: 'string'
        remotePort: 'string'
      }
    ]
    storageLocation: {
      filePath: 'string'
      storageId: 'string'
      storagePath: 'string'
    }
    target: 'string'
    timeLimitInSeconds: int
    totalBytesPerSession: int
  }
}

属性值

Microsoft.Network/networkWatchers/packetCaptures

名字 描述 价值
名字 资源名称 string (必需)
父母 在 Bicep 中,可以为子资源指定父资源。 仅当子资源在父资源外部声明时,才需要添加此属性。

有关详细信息,请参阅 父资源外部的子资源
类型资源的符号名称:networkWatchers
性能 数据包捕获的属性。 PacketCaptureParametersOrPacketCaptureResultProperties(必需)

PacketCaptureFilter

名字 描述 价值
localIPAddress 要筛选的本地 IP 地址。 表示法:单个地址条目的“127.0.0.1”。 范围为“127.0.0.1-127.0.0.255”。 "127.0.0.1;127.0.0.5"? 用于多个条目。 当前不支持多个范围。 目前不支持将范围与多个条目混合使用。 默认值 = null。 字符串
localPort 要筛选的本地端口。 表示法:单个端口条目的“80”。范围为 80-85 英寸。 "80;443;“用于多个条目。 当前不支持多个范围。 目前不支持将范围与多个条目混合使用。 默认值 = null。 字符串
协议 要筛选的协议。 “Any”
“TCP”
“UDP”
remoteIPAddress 要筛选的本地 IP 地址。 表示法:单个地址条目的“127.0.0.1”。 范围为“127.0.0.1-127.0.0.255”。 "127.0.0.1;127.0.0.5;“用于多个条目。 当前不支持多个范围。 目前不支持将范围与多个条目混合使用。 默认值 = null。 字符串
remotePort 要筛选的远程端口。 表示法:单个端口条目的“80”。范围为 80-85 英寸。 "80;443;“用于多个条目。 当前不支持多个范围。 目前不支持将范围与多个条目混合使用。 默认值 = null。 字符串

PacketCaptureParametersOrPacketCaptureResultProperties

名字 描述 价值
bytesToCapturePerPacket 每个数据包捕获的字节数,其余字节将被截断。 int
过滤 器 数据包捕获筛选器的列表。 PacketCaptureFilter[]
storageLocation 描述数据包捕获会话的存储位置。 PacketCaptureStorageLocation (必需)
目标 目标资源的 ID,目前仅支持 VM。 string (必需)
timeLimitInSeconds 捕获会话的最大持续时间(以秒为单位)。 int
totalBytesPerSession 捕获输出的最大大小。 int

PacketCaptureStorageLocation

名字 描述 价值
filePath 目标 VM 上的有效本地路径。 必须包含捕获文件的名称(*.cap)。 对于 Linux 虚拟机,它必须以 /var/captures 开头。 如果未提供存储 ID,则为必需,否则为可选。 字符串
storageId 用于保存数据包捕获会话的存储帐户的 ID。 如果未提供本地文件路径,则为必需。 字符串
storagePath 用于保存数据包捕获的存储路径的 URI。 必须是格式正确的 URI,用于描述保存数据包捕获的位置。 字符串

ARM 模板资源定义

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

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

资源格式

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

{
  "type": "Microsoft.Network/networkWatchers/packetCaptures",
  "apiVersion": "2019-08-01",
  "name": "string",
  "properties": {
    "bytesToCapturePerPacket": "int",
    "filters": [
      {
        "localIPAddress": "string",
        "localPort": "string",
        "protocol": "string",
        "remoteIPAddress": "string",
        "remotePort": "string"
      }
    ],
    "storageLocation": {
      "filePath": "string",
      "storageId": "string",
      "storagePath": "string"
    },
    "target": "string",
    "timeLimitInSeconds": "int",
    "totalBytesPerSession": "int"
  }
}

属性值

Microsoft.Network/networkWatchers/packetCaptures

名字 描述 价值
apiVersion API 版本 '2019-08-01'
名字 资源名称 string (必需)
性能 数据包捕获的属性。 PacketCaptureParametersOrPacketCaptureResultProperties(必需)
类型 资源类型 “Microsoft.Network/networkWatchers/packetCaptures”

PacketCaptureFilter

名字 描述 价值
localIPAddress 要筛选的本地 IP 地址。 表示法:单个地址条目的“127.0.0.1”。 范围为“127.0.0.1-127.0.0.255”。 "127.0.0.1;127.0.0.5"? 用于多个条目。 当前不支持多个范围。 目前不支持将范围与多个条目混合使用。 默认值 = null。 字符串
localPort 要筛选的本地端口。 表示法:单个端口条目的“80”。范围为 80-85 英寸。 "80;443;“用于多个条目。 当前不支持多个范围。 目前不支持将范围与多个条目混合使用。 默认值 = null。 字符串
协议 要筛选的协议。 “Any”
“TCP”
“UDP”
remoteIPAddress 要筛选的本地 IP 地址。 表示法:单个地址条目的“127.0.0.1”。 范围为“127.0.0.1-127.0.0.255”。 "127.0.0.1;127.0.0.5;“用于多个条目。 当前不支持多个范围。 目前不支持将范围与多个条目混合使用。 默认值 = null。 字符串
remotePort 要筛选的远程端口。 表示法:单个端口条目的“80”。范围为 80-85 英寸。 "80;443;“用于多个条目。 当前不支持多个范围。 目前不支持将范围与多个条目混合使用。 默认值 = null。 字符串

PacketCaptureParametersOrPacketCaptureResultProperties

名字 描述 价值
bytesToCapturePerPacket 每个数据包捕获的字节数,其余字节将被截断。 int
过滤 器 数据包捕获筛选器的列表。 PacketCaptureFilter[]
storageLocation 描述数据包捕获会话的存储位置。 PacketCaptureStorageLocation (必需)
目标 目标资源的 ID,目前仅支持 VM。 string (必需)
timeLimitInSeconds 捕获会话的最大持续时间(以秒为单位)。 int
totalBytesPerSession 捕获输出的最大大小。 int

PacketCaptureStorageLocation

名字 描述 价值
filePath 目标 VM 上的有效本地路径。 必须包含捕获文件的名称(*.cap)。 对于 Linux 虚拟机,它必须以 /var/captures 开头。 如果未提供存储 ID,则为必需,否则为可选。 字符串
storageId 用于保存数据包捕获会话的存储帐户的 ID。 如果未提供本地文件路径,则为必需。 字符串
storagePath 用于保存数据包捕获的存储路径的 URI。 必须是格式正确的 URI,用于描述保存数据包捕获的位置。 字符串

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

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

  • 资源组

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

资源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/networkWatchers/packetCaptures@2019-08-01"
  name = "string"
  body = jsonencode({
    properties = {
      bytesToCapturePerPacket = int
      filters = [
        {
          localIPAddress = "string"
          localPort = "string"
          protocol = "string"
          remoteIPAddress = "string"
          remotePort = "string"
        }
      ]
      storageLocation = {
        filePath = "string"
        storageId = "string"
        storagePath = "string"
      }
      target = "string"
      timeLimitInSeconds = int
      totalBytesPerSession = int
    }
  })
}

属性值

Microsoft.Network/networkWatchers/packetCaptures

名字 描述 价值
名字 资源名称 string (必需)
parent_id 此资源的父资源的 ID。 类型资源的 ID:networkWatchers
性能 数据包捕获的属性。 PacketCaptureParametersOrPacketCaptureResultProperties(必需)
类型 资源类型 “Microsoft.Network/networkWatchers/packetCaptures@2019-08-01”

PacketCaptureFilter

名字 描述 价值
localIPAddress 要筛选的本地 IP 地址。 表示法:单个地址条目的“127.0.0.1”。 范围为“127.0.0.1-127.0.0.255”。 "127.0.0.1;127.0.0.5"? 用于多个条目。 当前不支持多个范围。 目前不支持将范围与多个条目混合使用。 默认值 = null。 字符串
localPort 要筛选的本地端口。 表示法:单个端口条目的“80”。范围为 80-85 英寸。 "80;443;“用于多个条目。 当前不支持多个范围。 目前不支持将范围与多个条目混合使用。 默认值 = null。 字符串
协议 要筛选的协议。 “Any”
“TCP”
“UDP”
remoteIPAddress 要筛选的本地 IP 地址。 表示法:单个地址条目的“127.0.0.1”。 范围为“127.0.0.1-127.0.0.255”。 "127.0.0.1;127.0.0.5;“用于多个条目。 当前不支持多个范围。 目前不支持将范围与多个条目混合使用。 默认值 = null。 字符串
remotePort 要筛选的远程端口。 表示法:单个端口条目的“80”。范围为 80-85 英寸。 "80;443;“用于多个条目。 当前不支持多个范围。 目前不支持将范围与多个条目混合使用。 默认值 = null。 字符串

PacketCaptureParametersOrPacketCaptureResultProperties

名字 描述 价值
bytesToCapturePerPacket 每个数据包捕获的字节数,其余字节将被截断。 int
过滤 器 数据包捕获筛选器的列表。 PacketCaptureFilter[]
storageLocation 描述数据包捕获会话的存储位置。 PacketCaptureStorageLocation (必需)
目标 目标资源的 ID,目前仅支持 VM。 string (必需)
timeLimitInSeconds 捕获会话的最大持续时间(以秒为单位)。 int
totalBytesPerSession 捕获输出的最大大小。 int

PacketCaptureStorageLocation

名字 描述 价值
filePath 目标 VM 上的有效本地路径。 必须包含捕获文件的名称(*.cap)。 对于 Linux 虚拟机,它必须以 /var/captures 开头。 如果未提供存储 ID,则为必需,否则为可选。 字符串
storageId 用于保存数据包捕获会话的存储帐户的 ID。 如果未提供本地文件路径,则为必需。 字符串
storagePath 用于保存数据包捕获的存储路径的 URI。 必须是格式正确的 URI,用于描述保存数据包捕获的位置。 字符串