pulumi-azure-native-kotlin/com.pulumi.azurenative.network.kotlin/PacketCaptureArgs

PacketCaptureArgs

data class PacketCaptureArgs(val bytesToCapturePerPacket: Output<Double>? = null, val filters: Output<List<PacketCaptureFilterArgs>>? = null, val networkWatcherName: Output<String>? = null, val packetCaptureName: Output<String>? = null, val resourceGroupName: Output<String>? = null, val scope: Output<PacketCaptureMachineScopeArgs>? = null, val storageLocation: Output<PacketCaptureStorageLocationArgs>? = null, val target: Output<String>? = null, val targetType: Output<PacketCaptureTargetType>? = null, val timeLimitInSeconds: Output<Int>? = null, val totalBytesPerSession: Output<Double>? = null) : ConvertibleToJava<PacketCaptureArgs>

Information about packet capture session. Uses Azure REST API version 2023-02-01. In version 1.x of the Azure Native provider, it used API version 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,
    });
});
Content copied to clipboard
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
	})
}
Content copied to clipboard
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());
    }
}
Content copied to clipboard

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}
Content copied to clipboard

Constructors

Link copied to clipboard
constructor(bytesToCapturePerPacket: Output<Double>? = null, filters: Output<List<PacketCaptureFilterArgs>>? = null, networkWatcherName: Output<String>? = null, packetCaptureName: Output<String>? = null, resourceGroupName: Output<String>? = null, scope: Output<PacketCaptureMachineScopeArgs>? = null, storageLocation: Output<PacketCaptureStorageLocationArgs>? = null, target: Output<String>? = null, targetType: Output<PacketCaptureTargetType>? = null, timeLimitInSeconds: Output<Int>? = null, totalBytesPerSession: Output<Double>? = null)

Properties

Link copied to clipboard
val bytesToCapturePerPacket: Output<Double>? = null

Number of bytes captured per packet, the remaining bytes are truncated.

Link copied to clipboard
val filters: Output<List<PacketCaptureFilterArgs>>? = null

A list of packet capture filters.

Link copied to clipboard
val networkWatcherName: Output<String>? = null

The name of the network watcher.

Link copied to clipboard
val packetCaptureName: Output<String>? = null

The name of the packet capture session.

Link copied to clipboard
val resourceGroupName: Output<String>? = null

The name of the resource group.

Link copied to clipboard
val scope: Output<PacketCaptureMachineScopeArgs>? = null

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.

Link copied to clipboard
val storageLocation: Output<PacketCaptureStorageLocationArgs>? = null

The storage location for a packet capture session.

Link copied to clipboard
val target: Output<String>? = null

The ID of the targeted resource, only AzureVM and AzureVMSS as target type are currently supported.

Link copied to clipboard
val targetType: Output<PacketCaptureTargetType>? = null

Target type of the resource provided.

Link copied to clipboard
val timeLimitInSeconds: Output<Int>? = null

Maximum duration of the capture session in seconds.

Link copied to clipboard
val totalBytesPerSession: Output<Double>? = null

Maximum size of the capture output.

Functions

Link copied to clipboard
open override fun toJava(): PacketCaptureArgs