你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
Microsoft.Network networkWatchers/packetCaptures 2024-01-01
- 最新
- 2024-05-01
- 2024-03-01
- 2024-01-01
- 2023-11-01
- 2023-09-01
- 2023-06-01
- 2023-05-01
- 2023-04-01
- 2023-02-01
- 2022-11-01
- 2022-09-01
- 2022-07-01
- 2022-05-01
- 2022-01-01
- 2021-08-01
- 2021-05-01
- 2021-03-01
- 2021-02-01
- 2020-11-01
- 2020-08-01
- 2020-07-01
- 2020-06-01
- 2020-05-01
- 2020-04-01
- 2020-03-01
- 2019-12-01
- 2019-11-01
- 2019-09-01
- 2019-08-01
- 2019-07-01
- 2019-06-01
- 2019-04-01
- 2019-02-01
- 2018-12-01
- 2018-11-01
- 2018-10-01
- 2018-08-01
- 2018-07-01
- 2018-06-01
- 2018-04-01
- 2018-02-01
- 2018-01-01
- 2017-11-01
- 2017-10-01
- 2017-09-01
- 2017-08-01
- 2017-06-01
- 2017-03-30
- 2017-03-01
- 2016-12-01
- 2016-09-01
Bicep 资源定义
可以使用目标操作部署 networkWatchers/packetCaptures 资源类型：
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.Network/networkWatchers/packetCaptures 资源，请将以下 Bicep 添加到模板。
resource symbolicname 'Microsoft.Network/networkWatchers/packetCaptures@2024-01-01' = {
parent: resourceSymbolicName
name: 'string'
properties: {
bytesToCapturePerPacket: int
captureSettings: {
fileCount: int
fileSizeInBytes: int
sessionTimeLimitInSeconds: int
}
continuousCapture: bool
filters: [
{
localIPAddress: 'string'
localPort: 'string'
protocol: 'string'
remoteIPAddress: 'string'
remotePort: 'string'
}
]
scope: {
exclude: [
'string'
]
include: [
'string'
]
}
storageLocation: {
filePath: 'string'
localPath: 'string'
storageId: 'string'
storagePath: 'string'
}
target: 'string'
targetType: '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。 | 字符串 |
PacketCaptureMachineScope
| 名字 | 描述 | 价值 |
|---|---|---|
| 排除 | 必须从 AzureVMSSS 中排除的 AzureVMSS 实例的列表，这些实例必须从运行数据包捕获中排除。 | string[] |
| 包括 | 要运行数据包捕获的 AzureVMSS 实例列表。 | string[] |
PacketCaptureParametersOrPacketCaptureResultProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| bytesToCapturePerPacket | 每个数据包捕获的字节数，其余字节将被截断。 | int 约束： 最小值 = 0 最大值 = 4294967295 |
| captureSettings | 捕获设置保存“FileCount”、“FileSizeInBytes”、“SessionTimeLimitInSeconds”值。 | PacketCaptureSettings |
| continuousCapture | 此连续捕获是可为 null 的布尔值，可以保存“null”、“true”或“false”值。 如果不传递此参数，则将其视为“null”，默认值为“null”。 | bool |
| 过滤 器 | 数据包捕获筛选器的列表。 | PacketCaptureFilter[] |
| 范围 | 可以包含或排除用于运行数据包捕获的 AzureVMSS 实例的列表。 如果包含和排除的都是空的，则数据包捕获将在 AzureVMSS 的所有实例上运行。 | PacketCaptureMachineScope |
| storageLocation | 数据包捕获会话的存储位置。 | PacketCaptureStorageLocation （必需） |
| 目标 | 当前支持目标资源的 ID，仅支持作为目标类型的 AzureVM 和 AzureVMSS。 | string （必需） |
| targetType | 提供的资源的目标类型。 | “AzureVM” “AzureVMSS” |
| timeLimitInSeconds | 捕获会话的最大持续时间（以秒为单位）。 | int 约束： 最小值 = 0 最大值 = 18000 |
| totalBytesPerSession | 捕获输出的最大大小。 | int 约束： 最小值 = 0 最大值 = 4294967295 |
PacketCaptureSettings
| 名字 | 描述 | 价值 |
|---|---|---|
| fileCount | 文件计数。 计数的默认值为 10，最大值为 10000。 | int 约束： 最小值 = 0 最大值 = 10000 |
| fileSizeInBytes | 每个数据包捕获的字节数。 默认值（以字节为单位104857600（100MB）和最大字节4294967295（4GB）。 | int 约束： 最小值 = 0 最大值 = 4294967295 |
| sessionTimeLimitInSeconds | 捕获会话的最大持续时间（以秒为单位）为 604800 秒（7 天）。 第二个 86400 秒（1 天）中的默认值。 | int 约束： 最小值 = 0 最大值 = 604800 |
PacketCaptureStorageLocation
| 名字 | 描述 | 价值 |
|---|---|---|
| filePath | 如果使用“true”或“false”提供“连续捕获”，则此路径无效。 目标 VM 上的有效本地路径。 必须包含捕获文件的名称（*.cap）。 对于 Linux 虚拟机，它必须以 /var/captures 开头。 如果未提供存储 ID，则为必需，否则为可选。 | 字符串 |
| localPath | 如果使用“true”或“false”提供“连续捕获”，并且如果没有提供存储 ID，则此路径有效，否则为可选。 必须包含捕获文件的名称（*.cap）。 对于 Linux 虚拟机，它必须以 /var/captures 开头。 | 字符串 |
| storageId | 用于保存数据包捕获会话的存储帐户的 ID。 如果未提供 localPath 或 filePath，则为必需。 | 字符串 |
| storagePath | 用于保存数据包捕获的存储路径的 URI。 必须是格式正确的 URI，用于描述保存数据包捕获的位置。 | 字符串 |
ARM 模板资源定义
可以使用目标操作部署 networkWatchers/packetCaptures 资源类型：
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.Network/networkWatchers/packetCaptures 资源，请将以下 JSON 添加到模板。
{
"type": "Microsoft.Network/networkWatchers/packetCaptures",
"apiVersion": "2024-01-01",
"name": "string",
"properties": {
"bytesToCapturePerPacket": "int",
"captureSettings": {
"fileCount": "int",
"fileSizeInBytes": "int",
"sessionTimeLimitInSeconds": "int"
},
"continuousCapture": "bool",
"filters": [
{
"localIPAddress": "string",
"localPort": "string",
"protocol": "string",
"remoteIPAddress": "string",
"remotePort": "string"
}
],
"scope": {
"exclude": [ "string" ],
"include": [ "string" ]
},
"storageLocation": {
"filePath": "string",
"localPath": "string",
"storageId": "string",
"storagePath": "string"
},
"target": "string",
"targetType": "string",
"timeLimitInSeconds": "int",
"totalBytesPerSession": "int"
}
}
属性值
Microsoft.Network/networkWatchers/packetCaptures
| 名字 | 描述 | 价值 |
|---|---|---|
| apiVersion | API 版本 | '2024-01-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。 | 字符串 |
PacketCaptureMachineScope
| 名字 | 描述 | 价值 |
|---|---|---|
| 排除 | 必须从 AzureVMSSS 中排除的 AzureVMSS 实例的列表，这些实例必须从运行数据包捕获中排除。 | string[] |
| 包括 | 要运行数据包捕获的 AzureVMSS 实例列表。 | string[] |
PacketCaptureParametersOrPacketCaptureResultProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| bytesToCapturePerPacket | 每个数据包捕获的字节数，其余字节将被截断。 | int 约束： 最小值 = 0 最大值 = 4294967295 |
| captureSettings | 捕获设置保存“FileCount”、“FileSizeInBytes”、“SessionTimeLimitInSeconds”值。 | PacketCaptureSettings |
| continuousCapture | 此连续捕获是可为 null 的布尔值，可以保存“null”、“true”或“false”值。 如果不传递此参数，则将其视为“null”，默认值为“null”。 | bool |
| 过滤 器 | 数据包捕获筛选器的列表。 | PacketCaptureFilter[] |
| 范围 | 可以包含或排除用于运行数据包捕获的 AzureVMSS 实例的列表。 如果包含和排除的都是空的，则数据包捕获将在 AzureVMSS 的所有实例上运行。 | PacketCaptureMachineScope |
| storageLocation | 数据包捕获会话的存储位置。 | PacketCaptureStorageLocation （必需） |
| 目标 | 当前支持目标资源的 ID，仅支持作为目标类型的 AzureVM 和 AzureVMSS。 | string （必需） |
| targetType | 提供的资源的目标类型。 | “AzureVM” “AzureVMSS” |
| timeLimitInSeconds | 捕获会话的最大持续时间（以秒为单位）。 | int 约束： 最小值 = 0 最大值 = 18000 |
| totalBytesPerSession | 捕获输出的最大大小。 | int 约束： 最小值 = 0 最大值 = 4294967295 |
PacketCaptureSettings
| 名字 | 描述 | 价值 |
|---|---|---|
| fileCount | 文件计数。 计数的默认值为 10，最大值为 10000。 | int 约束： 最小值 = 0 最大值 = 10000 |
| fileSizeInBytes | 每个数据包捕获的字节数。 默认值（以字节为单位104857600（100MB）和最大字节4294967295（4GB）。 | int 约束： 最小值 = 0 最大值 = 4294967295 |
| sessionTimeLimitInSeconds | 捕获会话的最大持续时间（以秒为单位）为 604800 秒（7 天）。 第二个 86400 秒（1 天）中的默认值。 | int 约束： 最小值 = 0 最大值 = 604800 |
PacketCaptureStorageLocation
| 名字 | 描述 | 价值 |
|---|---|---|
| filePath | 如果使用“true”或“false”提供“连续捕获”，则此路径无效。 目标 VM 上的有效本地路径。 必须包含捕获文件的名称（*.cap）。 对于 Linux 虚拟机，它必须以 /var/captures 开头。 如果未提供存储 ID，则为必需，否则为可选。 | 字符串 |
| localPath | 如果使用“true”或“false”提供“连续捕获”，并且如果没有提供存储 ID，则此路径有效，否则为可选。 必须包含捕获文件的名称（*.cap）。 对于 Linux 虚拟机，它必须以 /var/captures 开头。 | 字符串 |
| storageId | 用于保存数据包捕获会话的存储帐户的 ID。 如果未提供 localPath 或 filePath，则为必需。 | 字符串 |
| storagePath | 用于保存数据包捕获的存储路径的 URI。 必须是格式正确的 URI，用于描述保存数据包捕获的位置。 | 字符串 |
Terraform （AzAPI 提供程序）资源定义
可以使用目标操作部署 networkWatchers/packetCaptures 资源类型：
- 资源组
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.Network/networkWatchers/packetCaptures 资源，请将以下 Terraform 添加到模板。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Network/networkWatchers/packetCaptures@2024-01-01"
name = "string"
body = jsonencode({
properties = {
bytesToCapturePerPacket = int
captureSettings = {
fileCount = int
fileSizeInBytes = int
sessionTimeLimitInSeconds = int
}
continuousCapture = bool
filters = [
{
localIPAddress = "string"
localPort = "string"
protocol = "string"
remoteIPAddress = "string"
remotePort = "string"
}
]
scope = {
exclude = [
"string"
]
include = [
"string"
]
}
storageLocation = {
filePath = "string"
localPath = "string"
storageId = "string"
storagePath = "string"
}
target = "string"
targetType = "string"
timeLimitInSeconds = int
totalBytesPerSession = int
}
})
}
属性值
Microsoft.Network/networkWatchers/packetCaptures
| 名字 | 描述 | 价值 |
|---|---|---|
| 名字 | 资源名称 | string （必需） |
| parent_id | 此资源的父资源的 ID。 | 类型资源的 ID：networkWatchers |
| 性能 | 数据包捕获的属性。 | PacketCaptureParametersOrPacketCaptureResultProperties（必需） |
| 类型 | 资源类型 | “Microsoft.Network/networkWatchers/packetCaptures@2024-01-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。 | 字符串 |
PacketCaptureMachineScope
| 名字 | 描述 | 价值 |
|---|---|---|
| 排除 | 必须从 AzureVMSSS 中排除的 AzureVMSS 实例的列表，这些实例必须从运行数据包捕获中排除。 | string[] |
| 包括 | 要运行数据包捕获的 AzureVMSS 实例列表。 | string[] |
PacketCaptureParametersOrPacketCaptureResultProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| bytesToCapturePerPacket | 每个数据包捕获的字节数，其余字节将被截断。 | int 约束： 最小值 = 0 最大值 = 4294967295 |
| captureSettings | 捕获设置保存“FileCount”、“FileSizeInBytes”、“SessionTimeLimitInSeconds”值。 | PacketCaptureSettings |
| continuousCapture | 此连续捕获是可为 null 的布尔值，可以保存“null”、“true”或“false”值。 如果不传递此参数，则将其视为“null”，默认值为“null”。 | bool |
| 过滤 器 | 数据包捕获筛选器的列表。 | PacketCaptureFilter[] |
| 范围 | 可以包含或排除用于运行数据包捕获的 AzureVMSS 实例的列表。 如果包含和排除的都是空的，则数据包捕获将在 AzureVMSS 的所有实例上运行。 | PacketCaptureMachineScope |
| storageLocation | 数据包捕获会话的存储位置。 | PacketCaptureStorageLocation （必需） |
| 目标 | 当前支持目标资源的 ID，仅支持作为目标类型的 AzureVM 和 AzureVMSS。 | string （必需） |
| targetType | 提供的资源的目标类型。 | “AzureVM” “AzureVMSS” |
| timeLimitInSeconds | 捕获会话的最大持续时间（以秒为单位）。 | int 约束： 最小值 = 0 最大值 = 18000 |
| totalBytesPerSession | 捕获输出的最大大小。 | int 约束： 最小值 = 0 最大值 = 4294967295 |
PacketCaptureSettings
| 名字 | 描述 | 价值 |
|---|---|---|
| fileCount | 文件计数。 计数的默认值为 10，最大值为 10000。 | int 约束： 最小值 = 0 最大值 = 10000 |
| fileSizeInBytes | 每个数据包捕获的字节数。 默认值（以字节为单位104857600（100MB）和最大字节4294967295（4GB）。 | int 约束： 最小值 = 0 最大值 = 4294967295 |
| sessionTimeLimitInSeconds | 捕获会话的最大持续时间（以秒为单位）为 604800 秒（7 天）。 第二个 86400 秒（1 天）中的默认值。 | int 约束： 最小值 = 0 最大值 = 604800 |
PacketCaptureStorageLocation
| 名字 | 描述 | 价值 |
|---|---|---|
| filePath | 如果使用“true”或“false”提供“连续捕获”，则此路径无效。 目标 VM 上的有效本地路径。 必须包含捕获文件的名称（*.cap）。 对于 Linux 虚拟机，它必须以 /var/captures 开头。 如果未提供存储 ID，则为必需，否则为可选。 | 字符串 |
| localPath | 如果使用“true”或“false”提供“连续捕获”，并且如果没有提供存储 ID，则此路径有效，否则为可选。 必须包含捕获文件的名称（*.cap）。 对于 Linux 虚拟机，它必须以 /var/captures 开头。 | 字符串 |
| storageId | 用于保存数据包捕获会话的存储帐户的 ID。 如果未提供 localPath 或 filePath，则为必需。 | 字符串 |
| storagePath | 用于保存数据包捕获的存储路径的 URI。 必须是格式正确的 URI，用于描述保存数据包捕获的位置。 | 字符串 |