Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. network
  5. PacketCapture
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.network.PacketCapture

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Information about packet capture session. Azure REST API version: 2023-02-01. Prior API version in Azure Native 1.x: 2020-11-01.

Other available API versions: 2020-06-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

Example Usage

Create packet capture

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var packetCapture = new AzureNative.Network.PacketCapture("packetCapture", new()
    {
        BytesToCapturePerPacket = 10000,
        Filters = new[]
        {
            new AzureNative.Network.Inputs.PacketCaptureFilterArgs
            {
                LocalIPAddress = "10.0.0.4",
                LocalPort = "80",
                Protocol = AzureNative.Network.PcProtocol.TCP,
            },
        },
        NetworkWatcherName = "nw1",
        PacketCaptureName = "pc1",
        ResourceGroupName = "rg1",
        StorageLocation = new AzureNative.Network.Inputs.PacketCaptureStorageLocationArgs
        {
            FilePath = "D:\\capture\\pc1.cap",
            StorageId = "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Storage/storageAccounts/pcstore",
            StoragePath = "https://mytestaccountname.blob.core.windows.net/capture/pc1.cap",
        },
        Target = "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1",
        TimeLimitInSeconds = 100,
        TotalBytesPerSession = 100000,
    });

});
Copy
package main

import (
	network "github.com/pulumi/pulumi-azure-native-sdk/network/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := network.NewPacketCapture(ctx, "packetCapture", &network.PacketCaptureArgs{
			BytesToCapturePerPacket: pulumi.Float64(10000),
			Filters: network.PacketCaptureFilterArray{
				&network.PacketCaptureFilterArgs{
					LocalIPAddress: pulumi.String("10.0.0.4"),
					LocalPort:      pulumi.String("80"),
					Protocol:       pulumi.String(network.PcProtocolTCP),
				},
			},
			NetworkWatcherName: pulumi.String("nw1"),
			PacketCaptureName:  pulumi.String("pc1"),
			ResourceGroupName:  pulumi.String("rg1"),
			StorageLocation: &network.PacketCaptureStorageLocationArgs{
				FilePath:    pulumi.String("D:\\capture\\pc1.cap"),
				StorageId:   pulumi.String("/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Storage/storageAccounts/pcstore"),
				StoragePath: pulumi.String("https://mytestaccountname.blob.core.windows.net/capture/pc1.cap"),
			},
			Target:               pulumi.String("/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1"),
			TimeLimitInSeconds:   pulumi.Int(100),
			TotalBytesPerSession: pulumi.Float64(100000),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.network.PacketCapture;
import com.pulumi.azurenative.network.PacketCaptureArgs;
import com.pulumi.azurenative.network.inputs.PacketCaptureFilterArgs;
import com.pulumi.azurenative.network.inputs.PacketCaptureStorageLocationArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var packetCapture = new PacketCapture("packetCapture", PacketCaptureArgs.builder()
            .bytesToCapturePerPacket(10000)
            .filters(PacketCaptureFilterArgs.builder()
                .localIPAddress("10.0.0.4")
                .localPort("80")
                .protocol("TCP")
                .build())
            .networkWatcherName("nw1")
            .packetCaptureName("pc1")
            .resourceGroupName("rg1")
            .storageLocation(PacketCaptureStorageLocationArgs.builder()
                .filePath("D:\\capture\\pc1.cap")
                .storageId("/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Storage/storageAccounts/pcstore")
                .storagePath("https://mytestaccountname.blob.core.windows.net/capture/pc1.cap")
                .build())
            .target("/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1")
            .timeLimitInSeconds(100)
            .totalBytesPerSession(100000)
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const packetCapture = new azure_native.network.PacketCapture("packetCapture", {
    bytesToCapturePerPacket: 10000,
    filters: [{
        localIPAddress: "10.0.0.4",
        localPort: "80",
        protocol: azure_native.network.PcProtocol.TCP,
    }],
    networkWatcherName: "nw1",
    packetCaptureName: "pc1",
    resourceGroupName: "rg1",
    storageLocation: {
        filePath: "D:\\capture\\pc1.cap",
        storageId: "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Storage/storageAccounts/pcstore",
        storagePath: "https://mytestaccountname.blob.core.windows.net/capture/pc1.cap",
    },
    target: "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1",
    timeLimitInSeconds: 100,
    totalBytesPerSession: 100000,
});
Copy
import pulumi
import pulumi_azure_native as azure_native

packet_capture = azure_native.network.PacketCapture("packetCapture",
    bytes_to_capture_per_packet=10000,
    filters=[{
        "local_ip_address": "10.0.0.4",
        "local_port": "80",
        "protocol": azure_native.network.PcProtocol.TCP,
    }],
    network_watcher_name="nw1",
    packet_capture_name="pc1",
    resource_group_name="rg1",
    storage_location={
        "file_path": "D:\\capture\\pc1.cap",
        "storage_id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Storage/storageAccounts/pcstore",
        "storage_path": "https://mytestaccountname.blob.core.windows.net/capture/pc1.cap",
    },
    target="/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1",
    time_limit_in_seconds=100,
    total_bytes_per_session=100000)
Copy
resources:
  packetCapture:
    type: azure-native:network:PacketCapture
    properties:
      bytesToCapturePerPacket: 10000
      filters:
        - localIPAddress: 10.0.0.4
          localPort: '80'
          protocol: TCP
      networkWatcherName: nw1
      packetCaptureName: pc1
      resourceGroupName: rg1
      storageLocation:
        filePath: D:\capture\pc1.cap
        storageId: /subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Storage/storageAccounts/pcstore
        storagePath: https://mytestaccountname.blob.core.windows.net/capture/pc1.cap
      target: /subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1
      timeLimitInSeconds: 100
      totalBytesPerSession: 100000
Copy

Create PacketCapture Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new PacketCapture(name: string, args: PacketCaptureArgs, opts?: CustomResourceOptions);
@overload
def PacketCapture(resource_name: str,
                  args: PacketCaptureArgs,
                  opts: Optional[ResourceOptions] = None)

@overload
def PacketCapture(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  network_watcher_name: Optional[str] = None,
                  resource_group_name: Optional[str] = None,
                  storage_location: Optional[PacketCaptureStorageLocationArgs] = None,
                  target: Optional[str] = None,
                  bytes_to_capture_per_packet: Optional[float] = None,
                  filters: Optional[Sequence[PacketCaptureFilterArgs]] = None,
                  packet_capture_name: Optional[str] = None,
                  scope: Optional[PacketCaptureMachineScopeArgs] = None,
                  target_type: Optional[PacketCaptureTargetType] = None,
                  time_limit_in_seconds: Optional[int] = None,
                  total_bytes_per_session: Optional[float] = None)
func NewPacketCapture(ctx *Context, name string, args PacketCaptureArgs, opts ...ResourceOption) (*PacketCapture, error)
public PacketCapture(string name, PacketCaptureArgs args, CustomResourceOptions? opts = null)
public PacketCapture(String name, PacketCaptureArgs args)
public PacketCapture(String name, PacketCaptureArgs args, CustomResourceOptions options)

type: azure-native:network:PacketCapture
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. PacketCaptureArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. PacketCaptureArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. PacketCaptureArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. PacketCaptureArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. PacketCaptureArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var azure_nativePacketCaptureResource = new AzureNative.Network.PacketCapture("azure-nativePacketCaptureResource", new()
{
    NetworkWatcherName = "string",
    ResourceGroupName = "string",
    StorageLocation = 
    {
        { "filePath", "string" },
        { "storageId", "string" },
        { "storagePath", "string" },
    },
    Target = "string",
    BytesToCapturePerPacket = 0,
    Filters = new[]
    {
        
        {
            { "localIPAddress", "string" },
            { "localPort", "string" },
            { "protocol", "string" },
            { "remoteIPAddress", "string" },
            { "remotePort", "string" },
        },
    },
    PacketCaptureName = "string",
    Scope = 
    {
        { "exclude", new[]
        {
            "string",
        } },
        { "include", new[]
        {
            "string",
        } },
    },
    TargetType = "AzureVM",
    TimeLimitInSeconds = 0,
    TotalBytesPerSession = 0,
});
Copy
example, err := network.NewPacketCapture(ctx, "azure-nativePacketCaptureResource", &network.PacketCaptureArgs{
	NetworkWatcherName: "string",
	ResourceGroupName:  "string",
	StorageLocation: map[string]interface{}{
		"filePath":    "string",
		"storageId":   "string",
		"storagePath": "string",
	},
	Target:                  "string",
	BytesToCapturePerPacket: 0,
	Filters: []map[string]interface{}{
		map[string]interface{}{
			"localIPAddress":  "string",
			"localPort":       "string",
			"protocol":        "string",
			"remoteIPAddress": "string",
			"remotePort":      "string",
		},
	},
	PacketCaptureName: "string",
	Scope: map[string]interface{}{
		"exclude": []string{
			"string",
		},
		"include": []string{
			"string",
		},
	},
	TargetType:           "AzureVM",
	TimeLimitInSeconds:   0,
	TotalBytesPerSession: 0,
})
Copy
var azure_nativePacketCaptureResource = new PacketCapture("azure-nativePacketCaptureResource", PacketCaptureArgs.builder()
    .networkWatcherName("string")
    .resourceGroupName("string")
    .storageLocation(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .target("string")
    .bytesToCapturePerPacket(0)
    .filters(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .packetCaptureName("string")
    .scope(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .targetType("AzureVM")
    .timeLimitInSeconds(0)
    .totalBytesPerSession(0)
    .build());
Copy
azure_native_packet_capture_resource = azure_native.network.PacketCapture("azure-nativePacketCaptureResource",
    network_watcher_name=string,
    resource_group_name=string,
    storage_location={
        filePath: string,
        storageId: string,
        storagePath: string,
    },
    target=string,
    bytes_to_capture_per_packet=0,
    filters=[{
        localIPAddress: string,
        localPort: string,
        protocol: string,
        remoteIPAddress: string,
        remotePort: string,
    }],
    packet_capture_name=string,
    scope={
        exclude: [string],
        include: [string],
    },
    target_type=AzureVM,
    time_limit_in_seconds=0,
    total_bytes_per_session=0)
Copy
const azure_nativePacketCaptureResource = new azure_native.network.PacketCapture("azure-nativePacketCaptureResource", {
    networkWatcherName: "string",
    resourceGroupName: "string",
    storageLocation: {
        filePath: "string",
        storageId: "string",
        storagePath: "string",
    },
    target: "string",
    bytesToCapturePerPacket: 0,
    filters: [{
        localIPAddress: "string",
        localPort: "string",
        protocol: "string",
        remoteIPAddress: "string",
        remotePort: "string",
    }],
    packetCaptureName: "string",
    scope: {
        exclude: ["string"],
        include: ["string"],
    },
    targetType: "AzureVM",
    timeLimitInSeconds: 0,
    totalBytesPerSession: 0,
});
Copy
type: azure-native:network:PacketCapture
properties:
    bytesToCapturePerPacket: 0
    filters:
        - localIPAddress: string
          localPort: string
          protocol: string
          remoteIPAddress: string
          remotePort: string
    networkWatcherName: string
    packetCaptureName: string
    resourceGroupName: string
    scope:
        exclude:
            - string
        include:
            - string
    storageLocation:
        filePath: string
        storageId: string
        storagePath: string
    target: string
    targetType: AzureVM
    timeLimitInSeconds: 0
    totalBytesPerSession: 0
Copy

PacketCapture Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The PacketCapture resource accepts the following input properties:

NetworkWatcherName
This property is required.
Changes to this property will trigger replacement.
string
The name of the network watcher.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
StorageLocation This property is required. Pulumi.AzureNative.Network.Inputs.PacketCaptureStorageLocation
The storage location for a packet capture session.
Target This property is required. string
The ID of the targeted resource, only AzureVM and AzureVMSS as target type are currently supported.
BytesToCapturePerPacket double
Number of bytes captured per packet, the remaining bytes are truncated.
Filters List<Pulumi.AzureNative.Network.Inputs.PacketCaptureFilter>
A list of packet capture filters.
PacketCaptureName Changes to this property will trigger replacement. string
The name of the packet capture session.
Scope Pulumi.AzureNative.Network.Inputs.PacketCaptureMachineScope
A list of AzureVMSS instances which can be included or excluded to run packet capture. If both included and excluded are empty, then the packet capture will run on all instances of AzureVMSS.
TargetType Pulumi.AzureNative.Network.PacketCaptureTargetType
Target type of the resource provided.
TimeLimitInSeconds int
Maximum duration of the capture session in seconds.
TotalBytesPerSession double
Maximum size of the capture output.
NetworkWatcherName
This property is required.
Changes to this property will trigger replacement.
string
The name of the network watcher.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
StorageLocation This property is required. PacketCaptureStorageLocationArgs
The storage location for a packet capture session.
Target This property is required. string
The ID of the targeted resource, only AzureVM and AzureVMSS as target type are currently supported.
BytesToCapturePerPacket float64
Number of bytes captured per packet, the remaining bytes are truncated.
Filters []PacketCaptureFilterArgs
A list of packet capture filters.
PacketCaptureName Changes to this property will trigger replacement. string
The name of the packet capture session.
Scope PacketCaptureMachineScopeArgs
A list of AzureVMSS instances which can be included or excluded to run packet capture. If both included and excluded are empty, then the packet capture will run on all instances of AzureVMSS.
TargetType PacketCaptureTargetType
Target type of the resource provided.
TimeLimitInSeconds int
Maximum duration of the capture session in seconds.
TotalBytesPerSession float64
Maximum size of the capture output.
networkWatcherName
This property is required.
Changes to this property will trigger replacement.
String
The name of the network watcher.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
storageLocation This property is required. PacketCaptureStorageLocation
The storage location for a packet capture session.
target This property is required. String
The ID of the targeted resource, only AzureVM and AzureVMSS as target type are currently supported.
bytesToCapturePerPacket Double
Number of bytes captured per packet, the remaining bytes are truncated.
filters List<PacketCaptureFilter>
A list of packet capture filters.
packetCaptureName Changes to this property will trigger replacement. String
The name of the packet capture session.
scope PacketCaptureMachineScope
A list of AzureVMSS instances which can be included or excluded to run packet capture. If both included and excluded are empty, then the packet capture will run on all instances of AzureVMSS.
targetType PacketCaptureTargetType
Target type of the resource provided.
timeLimitInSeconds Integer
Maximum duration of the capture session in seconds.
totalBytesPerSession Double
Maximum size of the capture output.
networkWatcherName
This property is required.
Changes to this property will trigger replacement.
string
The name of the network watcher.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
storageLocation This property is required. PacketCaptureStorageLocation
The storage location for a packet capture session.
target This property is required. string
The ID of the targeted resource, only AzureVM and AzureVMSS as target type are currently supported.
bytesToCapturePerPacket number
Number of bytes captured per packet, the remaining bytes are truncated.
filters PacketCaptureFilter[]
A list of packet capture filters.
packetCaptureName Changes to this property will trigger replacement. string
The name of the packet capture session.
scope PacketCaptureMachineScope
A list of AzureVMSS instances which can be included or excluded to run packet capture. If both included and excluded are empty, then the packet capture will run on all instances of AzureVMSS.
targetType PacketCaptureTargetType
Target type of the resource provided.
timeLimitInSeconds number
Maximum duration of the capture session in seconds.
totalBytesPerSession number
Maximum size of the capture output.
network_watcher_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the network watcher.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group.
storage_location This property is required. PacketCaptureStorageLocationArgs
The storage location for a packet capture session.
target This property is required. str
The ID of the targeted resource, only AzureVM and AzureVMSS as target type are currently supported.
bytes_to_capture_per_packet float
Number of bytes captured per packet, the remaining bytes are truncated.
filters Sequence[PacketCaptureFilterArgs]
A list of packet capture filters.
packet_capture_name Changes to this property will trigger replacement. str
The name of the packet capture session.
scope PacketCaptureMachineScopeArgs
A list of AzureVMSS instances which can be included or excluded to run packet capture. If both included and excluded are empty, then the packet capture will run on all instances of AzureVMSS.
target_type PacketCaptureTargetType
Target type of the resource provided.
time_limit_in_seconds int
Maximum duration of the capture session in seconds.
total_bytes_per_session float
Maximum size of the capture output.
networkWatcherName
This property is required.
Changes to this property will trigger replacement.
String
The name of the network watcher.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
storageLocation This property is required. Property Map
The storage location for a packet capture session.
target This property is required. String
The ID of the targeted resource, only AzureVM and AzureVMSS as target type are currently supported.
bytesToCapturePerPacket Number
Number of bytes captured per packet, the remaining bytes are truncated.
filters List<Property Map>
A list of packet capture filters.
packetCaptureName Changes to this property will trigger replacement. String
The name of the packet capture session.
scope Property Map
A list of AzureVMSS instances which can be included or excluded to run packet capture. If both included and excluded are empty, then the packet capture will run on all instances of AzureVMSS.
targetType "AzureVM" | "AzureVMSS"
Target type of the resource provided.
timeLimitInSeconds Number
Maximum duration of the capture session in seconds.
totalBytesPerSession Number
Maximum size of the capture output.

Outputs

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

Etag string
A unique read-only string that changes whenever the resource is updated.
Id string
The provider-assigned unique ID for this managed resource.
Name string
Name of the packet capture session.
ProvisioningState string
The provisioning state of the packet capture session.
Etag string
A unique read-only string that changes whenever the resource is updated.
Id string
The provider-assigned unique ID for this managed resource.
Name string
Name of the packet capture session.
ProvisioningState string
The provisioning state of the packet capture session.
etag String
A unique read-only string that changes whenever the resource is updated.
id String
The provider-assigned unique ID for this managed resource.
name String
Name of the packet capture session.
provisioningState String
The provisioning state of the packet capture session.
etag string
A unique read-only string that changes whenever the resource is updated.
id string
The provider-assigned unique ID for this managed resource.
name string
Name of the packet capture session.
provisioningState string
The provisioning state of the packet capture session.
etag str
A unique read-only string that changes whenever the resource is updated.
id str
The provider-assigned unique ID for this managed resource.
name str
Name of the packet capture session.
provisioning_state str
The provisioning state of the packet capture session.
etag String
A unique read-only string that changes whenever the resource is updated.
id String
The provider-assigned unique ID for this managed resource.
name String
Name of the packet capture session.
provisioningState String
The provisioning state of the packet capture session.

Supporting Types

PacketCaptureFilter
, PacketCaptureFilterArgs

LocalIPAddress string
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.
LocalPort string
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.
Protocol string | Pulumi.AzureNative.Network.PcProtocol
Protocol to be filtered on.
RemoteIPAddress string
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.
RemotePort string
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.
LocalIPAddress string
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.
LocalPort string
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.
Protocol string | PcProtocol
Protocol to be filtered on.
RemoteIPAddress string
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.
RemotePort string
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.
localIPAddress String
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.
localPort String
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.
protocol String | PcProtocol
Protocol to be filtered on.
remoteIPAddress String
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.
remotePort String
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.
localIPAddress string
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.
localPort string
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.
protocol string | PcProtocol
Protocol to be filtered on.
remoteIPAddress string
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.
remotePort string
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.
local_ip_address str
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.
local_port str
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.
protocol str | PcProtocol
Protocol to be filtered on.
remote_ip_address str
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.
remote_port str
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.
localIPAddress String
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.
localPort String
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.
protocol String | "TCP" | "UDP" | "Any"
Protocol to be filtered on.
remoteIPAddress String
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.
remotePort String
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.

PacketCaptureFilterResponse
, PacketCaptureFilterResponseArgs

LocalIPAddress string
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.
LocalPort string
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.
Protocol string
Protocol to be filtered on.
RemoteIPAddress string
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.
RemotePort string
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.
LocalIPAddress string
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.
LocalPort string
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.
Protocol string
Protocol to be filtered on.
RemoteIPAddress string
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.
RemotePort string
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.
localIPAddress String
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.
localPort String
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.
protocol String
Protocol to be filtered on.
remoteIPAddress String
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.
remotePort String
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.
localIPAddress string
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.
localPort string
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.
protocol string
Protocol to be filtered on.
remoteIPAddress string
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.
remotePort string
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.
local_ip_address str
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.
local_port str
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.
protocol str
Protocol to be filtered on.
remote_ip_address str
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.
remote_port str
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.
localIPAddress String
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.
localPort String
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.
protocol String
Protocol to be filtered on.
remoteIPAddress String
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.
remotePort String
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.

PacketCaptureMachineScope
, PacketCaptureMachineScopeArgs

Exclude List<string>
List of AzureVMSS instances which has to be excluded from the AzureVMSS from running packet capture.
Include List<string>
List of AzureVMSS instances to run packet capture on.
Exclude []string
List of AzureVMSS instances which has to be excluded from the AzureVMSS from running packet capture.
Include []string
List of AzureVMSS instances to run packet capture on.
exclude List<String>
List of AzureVMSS instances which has to be excluded from the AzureVMSS from running packet capture.
include List<String>
List of AzureVMSS instances to run packet capture on.
exclude string[]
List of AzureVMSS instances which has to be excluded from the AzureVMSS from running packet capture.
include string[]
List of AzureVMSS instances to run packet capture on.
exclude Sequence[str]
List of AzureVMSS instances which has to be excluded from the AzureVMSS from running packet capture.
include Sequence[str]
List of AzureVMSS instances to run packet capture on.
exclude List<String>
List of AzureVMSS instances which has to be excluded from the AzureVMSS from running packet capture.
include List<String>
List of AzureVMSS instances to run packet capture on.

PacketCaptureMachineScopeResponse
, PacketCaptureMachineScopeResponseArgs

Exclude List<string>
List of AzureVMSS instances which has to be excluded from the AzureVMSS from running packet capture.
Include List<string>
List of AzureVMSS instances to run packet capture on.
Exclude []string
List of AzureVMSS instances which has to be excluded from the AzureVMSS from running packet capture.
Include []string
List of AzureVMSS instances to run packet capture on.
exclude List<String>
List of AzureVMSS instances which has to be excluded from the AzureVMSS from running packet capture.
include List<String>
List of AzureVMSS instances to run packet capture on.
exclude string[]
List of AzureVMSS instances which has to be excluded from the AzureVMSS from running packet capture.
include string[]
List of AzureVMSS instances to run packet capture on.
exclude Sequence[str]
List of AzureVMSS instances which has to be excluded from the AzureVMSS from running packet capture.
include Sequence[str]
List of AzureVMSS instances to run packet capture on.
exclude List<String>
List of AzureVMSS instances which has to be excluded from the AzureVMSS from running packet capture.
include List<String>
List of AzureVMSS instances to run packet capture on.

PacketCaptureStorageLocation
, PacketCaptureStorageLocationArgs

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. Required if no storage ID is provided, otherwise optional.
StorageId string
The ID of the storage account to save the packet capture session. Required if no local file path is provided.
StoragePath string
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.
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. Required if no storage ID is provided, otherwise optional.
StorageId string
The ID of the storage account to save the packet capture session. Required if no local file path is provided.
StoragePath string
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.
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. Required if no storage ID is provided, otherwise optional.
storageId String
The ID of the storage account to save the packet capture session. Required if no local file path is provided.
storagePath String
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.
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. Required if no storage ID is provided, otherwise optional.
storageId string
The ID of the storage account to save the packet capture session. Required if no local file path is provided.
storagePath string
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.
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. Required if no storage ID is provided, otherwise optional.
storage_id str
The ID of the storage account to save the packet capture session. Required if no local file path is provided.
storage_path str
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.
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. Required if no storage ID is provided, otherwise optional.
storageId String
The ID of the storage account to save the packet capture session. Required if no local file path is provided.
storagePath String
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.

PacketCaptureStorageLocationResponse
, PacketCaptureStorageLocationResponseArgs

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. Required if no storage ID is provided, otherwise optional.
StorageId string
The ID of the storage account to save the packet capture session. Required if no local file path is provided.
StoragePath string
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.
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. Required if no storage ID is provided, otherwise optional.
StorageId string
The ID of the storage account to save the packet capture session. Required if no local file path is provided.
StoragePath string
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.
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. Required if no storage ID is provided, otherwise optional.
storageId String
The ID of the storage account to save the packet capture session. Required if no local file path is provided.
storagePath String
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.
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. Required if no storage ID is provided, otherwise optional.
storageId string
The ID of the storage account to save the packet capture session. Required if no local file path is provided.
storagePath string
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.
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. Required if no storage ID is provided, otherwise optional.
storage_id str
The ID of the storage account to save the packet capture session. Required if no local file path is provided.
storage_path str
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.
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. Required if no storage ID is provided, otherwise optional.
storageId String
The ID of the storage account to save the packet capture session. Required if no local file path is provided.
storagePath String
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.

PacketCaptureTargetType
, PacketCaptureTargetTypeArgs

AzureVM
AzureVM
AzureVMSS
AzureVMSS
PacketCaptureTargetTypeAzureVM
AzureVM
PacketCaptureTargetTypeAzureVMSS
AzureVMSS
AzureVM
AzureVM
AzureVMSS
AzureVMSS
AzureVM
AzureVM
AzureVMSS
AzureVMSS
AZURE_VM
AzureVM
AZURE_VMSS
AzureVMSS
"AzureVM"
AzureVM
"AzureVMSS"
AzureVMSS

PcProtocol
, PcProtocolArgs

TCP
TCP
UDP
UDP
Any
Any
PcProtocolTCP
TCP
PcProtocolUDP
UDP
PcProtocolAny
Any
TCP
TCP
UDP
UDP
Any
Any
TCP
TCP
UDP
UDP
Any
Any
TCP
TCP
UDP
UDP
ANY
Any
"TCP"
TCP
"UDP"
UDP
"Any"
Any

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:network:PacketCapture pc1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/packetCaptures/{packetCaptureName}
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native