Microsoft.Network networkWatchers/packetCaptures 2021-02-01
- Latest
- 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 resource definition
The networkWatchers/packetCaptures resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Network/networkWatchers/packetCaptures resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Network/networkWatchers/packetCaptures@2021-02-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
}
}
Property values
Microsoft.Network/networkWatchers/packetCaptures
| Name | Description | Value |
|---|---|---|
| name | The resource name | 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: networkWatchers |
| properties | Properties of the packet capture. | PacketCaptureParametersOrPacketCaptureResultProperties (required) |
PacketCaptureFilter
| Name | Description | Value |
|---|---|---|
| localIPAddress | Local IP Address to be filtered on. Notation: "127.0.0.1" for single address entry. "127.0.0.1-127.0.0.255" for range. "127.0.0.1;127.0.0.5"? for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null. | string |
| localPort | Local port to be filtered on. Notation: "80" for single port entry."80-85" for range. "80;443;" for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null. | string |
| protocol | Protocol to be filtered on. | 'Any' 'TCP' 'UDP' |
| remoteIPAddress | Local IP Address to be filtered on. Notation: "127.0.0.1" for single address entry. "127.0.0.1-127.0.0.255" for range. "127.0.0.1;127.0.0.5;" for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null. | string |
| remotePort | Remote port to be filtered on. Notation: "80" for single port entry."80-85" for range. "80;443;" for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null. | string |
PacketCaptureParametersOrPacketCaptureResultProperties
| Name | Description | Value |
|---|---|---|
| bytesToCapturePerPacket | Number of bytes captured per packet, the remaining bytes are truncated. | int Constraints: Min value = 0 Max value = 4294967295 |
| filters | A list of packet capture filters. | PacketCaptureFilter[] |
| storageLocation | The storage location for a packet capture session. | PacketCaptureStorageLocation (required) |
| target | The ID of the targeted resource, only VM is currently supported. | string (required) |
| timeLimitInSeconds | Maximum duration of the capture session in seconds. | int Constraints: Min value = 0 Max value = 18000 |
| totalBytesPerSession | Maximum size of the capture output. | int Constraints: Min value = 0 Max value = 4294967295 |
PacketCaptureStorageLocation
| Name | Description | Value |
|---|---|---|
| filePath | A valid local path on the targeting VM. Must include the name of the capture file (*.cap). For linux virtual machine it must start with /var/captures. Required if no storage ID is provided, otherwise optional. | string |
| storageId | The ID of the storage account to save the packet capture session. Required if no local file path is provided. | string |
| storagePath | The URI of the storage path to save the packet capture. Must be a well-formed URI describing the location to save the packet capture. | string |
ARM template resource definition
The networkWatchers/packetCaptures resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Network/networkWatchers/packetCaptures resource, add the following JSON to your template.
{
"type": "Microsoft.Network/networkWatchers/packetCaptures",
"apiVersion": "2021-02-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"
}
}
Property values
Microsoft.Network/networkWatchers/packetCaptures
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2021-02-01' |
| name | The resource name | string (required) |
| properties | Properties of the packet capture. | PacketCaptureParametersOrPacketCaptureResultProperties (required) |
| type | The resource type | 'Microsoft.Network/networkWatchers/packetCaptures' |
PacketCaptureFilter
| Name | Description | Value |
|---|---|---|
| localIPAddress | Local IP Address to be filtered on. Notation: "127.0.0.1" for single address entry. "127.0.0.1-127.0.0.255" for range. "127.0.0.1;127.0.0.5"? for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null. | string |
| localPort | Local port to be filtered on. Notation: "80" for single port entry."80-85" for range. "80;443;" for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null. | string |
| protocol | Protocol to be filtered on. | 'Any' 'TCP' 'UDP' |
| remoteIPAddress | Local IP Address to be filtered on. Notation: "127.0.0.1" for single address entry. "127.0.0.1-127.0.0.255" for range. "127.0.0.1;127.0.0.5;" for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null. | string |
| remotePort | Remote port to be filtered on. Notation: "80" for single port entry."80-85" for range. "80;443;" for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null. | string |
PacketCaptureParametersOrPacketCaptureResultProperties
| Name | Description | Value |
|---|---|---|
| bytesToCapturePerPacket | Number of bytes captured per packet, the remaining bytes are truncated. | int Constraints: Min value = 0 Max value = 4294967295 |
| filters | A list of packet capture filters. | PacketCaptureFilter[] |
| storageLocation | The storage location for a packet capture session. | PacketCaptureStorageLocation (required) |
| target | The ID of the targeted resource, only VM is currently supported. | string (required) |
| timeLimitInSeconds | Maximum duration of the capture session in seconds. | int Constraints: Min value = 0 Max value = 18000 |
| totalBytesPerSession | Maximum size of the capture output. | int Constraints: Min value = 0 Max value = 4294967295 |
PacketCaptureStorageLocation
| Name | Description | Value |
|---|---|---|
| filePath | A valid local path on the targeting VM. Must include the name of the capture file (*.cap). For linux virtual machine it must start with /var/captures. Required if no storage ID is provided, otherwise optional. | string |
| storageId | The ID of the storage account to save the packet capture session. Required if no local file path is provided. | string |
| storagePath | The URI of the storage path to save the packet capture. Must be a well-formed URI describing the location to save the packet capture. | string |
Terraform (AzAPI provider) resource definition
The networkWatchers/packetCaptures resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Network/networkWatchers/packetCaptures resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Network/networkWatchers/packetCaptures@2021-02-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
}
})
}
Property values
Microsoft.Network/networkWatchers/packetCaptures
| Name | Description | Value |
|---|---|---|
| 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: networkWatchers |
| properties | Properties of the packet capture. | PacketCaptureParametersOrPacketCaptureResultProperties (required) |
| type | The resource type | "Microsoft.Network/networkWatchers/packetCaptures@2021-02-01" |
PacketCaptureFilter
| Name | Description | Value |
|---|---|---|
| localIPAddress | Local IP Address to be filtered on. Notation: "127.0.0.1" for single address entry. "127.0.0.1-127.0.0.255" for range. "127.0.0.1;127.0.0.5"? for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null. | string |
| localPort | Local port to be filtered on. Notation: "80" for single port entry."80-85" for range. "80;443;" for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null. | string |
| protocol | Protocol to be filtered on. | 'Any' 'TCP' 'UDP' |
| remoteIPAddress | Local IP Address to be filtered on. Notation: "127.0.0.1" for single address entry. "127.0.0.1-127.0.0.255" for range. "127.0.0.1;127.0.0.5;" for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null. | string |
| remotePort | Remote port to be filtered on. Notation: "80" for single port entry."80-85" for range. "80;443;" for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null. | string |
PacketCaptureParametersOrPacketCaptureResultProperties
| Name | Description | Value |
|---|---|---|
| bytesToCapturePerPacket | Number of bytes captured per packet, the remaining bytes are truncated. | int Constraints: Min value = 0 Max value = 4294967295 |
| filters | A list of packet capture filters. | PacketCaptureFilter[] |
| storageLocation | The storage location for a packet capture session. | PacketCaptureStorageLocation (required) |
| target | The ID of the targeted resource, only VM is currently supported. | string (required) |
| timeLimitInSeconds | Maximum duration of the capture session in seconds. | int Constraints: Min value = 0 Max value = 18000 |
| totalBytesPerSession | Maximum size of the capture output. | int Constraints: Min value = 0 Max value = 4294967295 |
PacketCaptureStorageLocation
| Name | Description | Value |
|---|---|---|
| filePath | A valid local path on the targeting VM. Must include the name of the capture file (*.cap). For linux virtual machine it must start with /var/captures. Required if no storage ID is provided, otherwise optional. | string |
| storageId | The ID of the storage account to save the packet capture session. Required if no local file path is provided. | string |
| storagePath | The URI of the storage path to save the packet capture. Must be a well-formed URI describing the location to save the packet capture. | string |