NetworkPacketCapture

Configures Network Packet Capturing against a Virtual Machine using a Network Watcher.

Create a NetworkPacketCapture Resource

new NetworkPacketCapture(name: string, args: NetworkPacketCaptureArgs, opts?: CustomResourceOptions);

def NetworkPacketCapture(resource_name, opts=None, filters=None, maximum_bytes_per_packet=None, maximum_bytes_per_session=None, maximum_capture_duration=None, name=None, network_watcher_name=None, resource_group_name=None, storage_location=None, target_resource_id=None, __props__=None);

func NewNetworkPacketCapture(ctx *Context, name string, args NetworkPacketCaptureArgs, opts ...ResourceOption) (*NetworkPacketCapture, error)

public NetworkPacketCapture(string name, NetworkPacketCaptureArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args NetworkPacketCaptureArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args NetworkPacketCaptureArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args NetworkPacketCaptureArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

NetworkPacketCapture Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The NetworkPacketCapture resource accepts the following input properties:

NetworkWatcherName string: The name of the Network Watcher. Changing this forces a new resource to be created.
ResourceGroupName string: The name of the resource group in which the Network Watcher exists. Changing this forces a new resource to be created.
StorageLocation NetworkPacketCaptureStorageLocationArgs: A storage_location block as defined below. Changing this forces a new resource to be created.
TargetResourceId string: The ID of the Resource to capture packets from. Changing this forces a new resource to be created.
Filters List<NetworkPacketCaptureFilterArgs>: One or more filter blocks as defined below. Changing this forces a new resource to be created.
MaximumBytesPerPacket int: The number of bytes captured per packet. The remaining bytes are truncated. Defaults to 0 (Entire Packet Captured). Changing this forces a new resource to be created.
MaximumBytesPerSession int: Maximum size of the capture in Bytes. Defaults to 1073741824 (1GB). Changing this forces a new resource to be created.
MaximumCaptureDuration int: The maximum duration of the capture session in seconds. Defaults to 18000 (5 hours). Changing this forces a new resource to be created.
Name string: The name to use for this Network Packet Capture. Changing this forces a new resource to be created.

NetworkWatcherName string: The name of the Network Watcher. Changing this forces a new resource to be created.
ResourceGroupName string: The name of the resource group in which the Network Watcher exists. Changing this forces a new resource to be created.
StorageLocation NetworkPacketCaptureStorageLocation: A storage_location block as defined below. Changing this forces a new resource to be created.
TargetResourceId string: The ID of the Resource to capture packets from. Changing this forces a new resource to be created.
Filters []NetworkPacketCaptureFilter: One or more filter blocks as defined below. Changing this forces a new resource to be created.
MaximumBytesPerPacket int: The number of bytes captured per packet. The remaining bytes are truncated. Defaults to 0 (Entire Packet Captured). Changing this forces a new resource to be created.
MaximumBytesPerSession int: Maximum size of the capture in Bytes. Defaults to 1073741824 (1GB). Changing this forces a new resource to be created.
MaximumCaptureDuration int: The maximum duration of the capture session in seconds. Defaults to 18000 (5 hours). Changing this forces a new resource to be created.
Name string: The name to use for this Network Packet Capture. Changing this forces a new resource to be created.

networkWatcherName string: The name of the Network Watcher. Changing this forces a new resource to be created.
resourceGroupName string: The name of the resource group in which the Network Watcher exists. Changing this forces a new resource to be created.
storageLocation NetworkPacketCaptureStorageLocation: A storage_location block as defined below. Changing this forces a new resource to be created.
targetResourceId string: The ID of the Resource to capture packets from. Changing this forces a new resource to be created.
filters NetworkPacketCaptureFilter[]: One or more filter blocks as defined below. Changing this forces a new resource to be created.
maximumBytesPerPacket number: The number of bytes captured per packet. The remaining bytes are truncated. Defaults to 0 (Entire Packet Captured). Changing this forces a new resource to be created.
maximumBytesPerSession number: Maximum size of the capture in Bytes. Defaults to 1073741824 (1GB). Changing this forces a new resource to be created.
maximumCaptureDuration number: The maximum duration of the capture session in seconds. Defaults to 18000 (5 hours). Changing this forces a new resource to be created.
name string: The name to use for this Network Packet Capture. Changing this forces a new resource to be created.

network_watcher_name str: The name of the Network Watcher. Changing this forces a new resource to be created.
resource_group_name str: The name of the resource group in which the Network Watcher exists. Changing this forces a new resource to be created.
storage_location Dict[NetworkPacketCaptureStorageLocation]: A storage_location block as defined below. Changing this forces a new resource to be created.
target_resource_id str: The ID of the Resource to capture packets from. Changing this forces a new resource to be created.
filters List[NetworkPacketCaptureFilter]: One or more filter blocks as defined below. Changing this forces a new resource to be created.
maximum_bytes_per_packet float: The number of bytes captured per packet. The remaining bytes are truncated. Defaults to 0 (Entire Packet Captured). Changing this forces a new resource to be created.
maximum_bytes_per_session float: Maximum size of the capture in Bytes. Defaults to 1073741824 (1GB). Changing this forces a new resource to be created.
maximum_capture_duration float: The maximum duration of the capture session in seconds. Defaults to 18000 (5 hours). Changing this forces a new resource to be created.
name str: The name to use for this Network Packet Capture. Changing this forces a new resource to be created.

Outputs

All input properties are implicitly available as output properties. Additionally, the NetworkPacketCapture resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

Look up an Existing NetworkPacketCapture Resource

Get an existing NetworkPacketCapture resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: NetworkPacketCaptureState, opts?: CustomResourceOptions): NetworkPacketCapture

static get(resource_name, id, opts=None, filters=None, maximum_bytes_per_packet=None, maximum_bytes_per_session=None, maximum_capture_duration=None, name=None, network_watcher_name=None, resource_group_name=None, storage_location=None, target_resource_id=None, __props__=None);

func GetNetworkPacketCapture(ctx *Context, name string, id IDInput, state *NetworkPacketCaptureState, opts ...ResourceOption) (*NetworkPacketCapture, error)

public static NetworkPacketCapture Get(string name, Input<string> id, NetworkPacketCaptureState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

Filters List<NetworkPacketCaptureFilterArgs>: One or more filter blocks as defined below. Changing this forces a new resource to be created.
MaximumBytesPerPacket int: The number of bytes captured per packet. The remaining bytes are truncated. Defaults to 0 (Entire Packet Captured). Changing this forces a new resource to be created.
MaximumBytesPerSession int: Maximum size of the capture in Bytes. Defaults to 1073741824 (1GB). Changing this forces a new resource to be created.
MaximumCaptureDuration int: The maximum duration of the capture session in seconds. Defaults to 18000 (5 hours). Changing this forces a new resource to be created.
Name string: The name to use for this Network Packet Capture. Changing this forces a new resource to be created.
NetworkWatcherName string: The name of the Network Watcher. Changing this forces a new resource to be created.
ResourceGroupName string: The name of the resource group in which the Network Watcher exists. Changing this forces a new resource to be created.
StorageLocation NetworkPacketCaptureStorageLocationArgs: A storage_location block as defined below. Changing this forces a new resource to be created.
TargetResourceId string: The ID of the Resource to capture packets from. Changing this forces a new resource to be created.

Filters []NetworkPacketCaptureFilter: One or more filter blocks as defined below. Changing this forces a new resource to be created.
MaximumBytesPerPacket int: The number of bytes captured per packet. The remaining bytes are truncated. Defaults to 0 (Entire Packet Captured). Changing this forces a new resource to be created.
MaximumBytesPerSession int: Maximum size of the capture in Bytes. Defaults to 1073741824 (1GB). Changing this forces a new resource to be created.
MaximumCaptureDuration int: The maximum duration of the capture session in seconds. Defaults to 18000 (5 hours). Changing this forces a new resource to be created.
Name string: The name to use for this Network Packet Capture. Changing this forces a new resource to be created.
NetworkWatcherName string: The name of the Network Watcher. Changing this forces a new resource to be created.
ResourceGroupName string: The name of the resource group in which the Network Watcher exists. Changing this forces a new resource to be created.
StorageLocation NetworkPacketCaptureStorageLocation: A storage_location block as defined below. Changing this forces a new resource to be created.
TargetResourceId string: The ID of the Resource to capture packets from. Changing this forces a new resource to be created.

filters NetworkPacketCaptureFilter[]: One or more filter blocks as defined below. Changing this forces a new resource to be created.
maximumBytesPerPacket number: The number of bytes captured per packet. The remaining bytes are truncated. Defaults to 0 (Entire Packet Captured). Changing this forces a new resource to be created.
maximumBytesPerSession number: Maximum size of the capture in Bytes. Defaults to 1073741824 (1GB). Changing this forces a new resource to be created.
maximumCaptureDuration number: The maximum duration of the capture session in seconds. Defaults to 18000 (5 hours). Changing this forces a new resource to be created.
name string: The name to use for this Network Packet Capture. Changing this forces a new resource to be created.
networkWatcherName string: The name of the Network Watcher. Changing this forces a new resource to be created.
resourceGroupName string: The name of the resource group in which the Network Watcher exists. Changing this forces a new resource to be created.
storageLocation NetworkPacketCaptureStorageLocation: A storage_location block as defined below. Changing this forces a new resource to be created.
targetResourceId string: The ID of the Resource to capture packets from. Changing this forces a new resource to be created.

filters List[NetworkPacketCaptureFilter]: One or more filter blocks as defined below. Changing this forces a new resource to be created.
maximum_bytes_per_packet float: The number of bytes captured per packet. The remaining bytes are truncated. Defaults to 0 (Entire Packet Captured). Changing this forces a new resource to be created.
maximum_bytes_per_session float: Maximum size of the capture in Bytes. Defaults to 1073741824 (1GB). Changing this forces a new resource to be created.
maximum_capture_duration float: The maximum duration of the capture session in seconds. Defaults to 18000 (5 hours). Changing this forces a new resource to be created.
name str: The name to use for this Network Packet Capture. Changing this forces a new resource to be created.
network_watcher_name str: The name of the Network Watcher. Changing this forces a new resource to be created.
resource_group_name str: The name of the resource group in which the Network Watcher exists. Changing this forces a new resource to be created.
storage_location Dict[NetworkPacketCaptureStorageLocation]: A storage_location block as defined below. Changing this forces a new resource to be created.
target_resource_id str: The ID of the Resource to capture packets from. Changing this forces a new resource to be created.

Supporting Types

NetworkPacketCaptureFilter

See the input and output API doc for this type.

Protocol string: The Protocol to be filtered on. Possible values include Any, TCP and UDP. Changing this forces a new resource to be created.
LocalIpAddress string: The 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. Changing this forces a new resource to be created.
LocalPort string: The 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. Changing this forces a new resource to be created.
RemoteIpAddress string: The remote 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.. Changing this forces a new resource to be created.
RemotePort string: The 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. Changing this forces a new resource to be created.

Protocol string: The Protocol to be filtered on. Possible values include Any, TCP and UDP. Changing this forces a new resource to be created.
LocalIpAddress string: The 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. Changing this forces a new resource to be created.
LocalPort string: The 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. Changing this forces a new resource to be created.
RemoteIpAddress string: The remote 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.. Changing this forces a new resource to be created.
RemotePort string: The 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. Changing this forces a new resource to be created.

protocol string: The Protocol to be filtered on. Possible values include Any, TCP and UDP. Changing this forces a new resource to be created.
localIpAddress string: The 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. Changing this forces a new resource to be created.
localPort string: The 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. Changing this forces a new resource to be created.
remoteIpAddress string: The remote 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.. Changing this forces a new resource to be created.
remotePort string: The 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. Changing this forces a new resource to be created.

protocol str: The Protocol to be filtered on. Possible values include Any, TCP and UDP. Changing this forces a new resource to be created.
localIpAddress str: The 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. Changing this forces a new resource to be created.
localPort str: The 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. Changing this forces a new resource to be created.
remoteIpAddress str: The remote 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.. Changing this forces a new resource to be created.
remotePort str: The 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. Changing this forces a new resource to be created.

NetworkPacketCaptureStorageLocation

See the input and output API doc for this type.

FilePath string: 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.
StorageAccountId string: The ID of the storage account to save the packet capture session
StoragePath string: The URI of the storage path to save the packet capture.

FilePath string: 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.
StorageAccountId string: The ID of the storage account to save the packet capture session
StoragePath string: The URI of the storage path to save the packet capture.

filePath string: 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.
storageAccountId string: The ID of the storage account to save the packet capture session
storagePath string: The URI of the storage path to save the packet capture.

file_path str: 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.
storagePath str: The URI of the storage path to save the packet capture.
storage_account_id str: The ID of the storage account to save the packet capture session

Package Details

Repository: https://github.com/pulumi/pulumi-azure
License: Apache-2.0
Notes: This Pulumi package is based on the azurerm Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud