1. Packages
  2. Azure Classic
  3. API Docs
  4. compute
  5. ScaleSetPacketCapture

We recommend using Azure Native.

Azure Classic v5.80.0 published on Monday, Jun 10, 2024 by Pulumi

azure.compute.ScaleSetPacketCapture

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.80.0 published on Monday, Jun 10, 2024 by Pulumi

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

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    
    const example = new azure.core.ResourceGroup("example", {
        name: "example-resources",
        location: "West Europe",
    });
    const exampleNetworkWatcher = new azure.network.NetworkWatcher("example", {
        name: "example-nw",
        location: example.location,
        resourceGroupName: example.name,
    });
    const exampleVirtualNetwork = new azure.network.VirtualNetwork("example", {
        name: "example-vn",
        addressSpaces: ["10.0.0.0/16"],
        location: example.location,
        resourceGroupName: example.name,
    });
    const exampleSubnet = new azure.network.Subnet("example", {
        name: "internal",
        resourceGroupName: example.name,
        virtualNetworkName: exampleVirtualNetwork.name,
        addressPrefixes: ["10.0.2.0/24"],
    });
    const exampleLinuxVirtualMachineScaleSet = new azure.compute.LinuxVirtualMachineScaleSet("example", {
        name: "example-vmss",
        resourceGroupName: example.name,
        location: example.location,
        sku: "Standard_F2",
        instances: 4,
        adminUsername: "adminuser",
        adminPassword: "P@ssword1234!",
        computerNamePrefix: "my-linux-computer-name-prefix",
        upgradeMode: "Automatic",
        disablePasswordAuthentication: false,
        sourceImageReference: {
            publisher: "Canonical",
            offer: "0001-com-ubuntu-server-jammy",
            sku: "22_04-lts",
            version: "latest",
        },
        osDisk: {
            storageAccountType: "Standard_LRS",
            caching: "ReadWrite",
        },
        networkInterfaces: [{
            name: "example",
            primary: true,
            ipConfigurations: [{
                name: "internal",
                primary: true,
                subnetId: exampleSubnet.id,
            }],
        }],
    });
    const exampleVirtualMachineScaleSetExtension = new azure.compute.VirtualMachineScaleSetExtension("example", {
        name: "network-watcher",
        virtualMachineScaleSetId: exampleLinuxVirtualMachineScaleSet.id,
        publisher: "Microsoft.Azure.NetworkWatcher",
        type: "NetworkWatcherAgentLinux",
        typeHandlerVersion: "1.4",
        autoUpgradeMinorVersion: true,
        automaticUpgradeEnabled: true,
    });
    const exampleScaleSetPacketCapture = new azure.compute.ScaleSetPacketCapture("example", {
        name: "example-pc",
        networkWatcherId: exampleNetworkWatcher.id,
        virtualMachineScaleSetId: exampleLinuxVirtualMachineScaleSet.id,
        storageLocation: {
            filePath: "/var/captures/packet.cap",
        },
        machineScope: {
            includeInstanceIds: ["0"],
            excludeInstanceIds: ["1"],
        },
    }, {
        dependsOn: [exampleVirtualMachineScaleSetExtension],
    });
    
    import pulumi
    import pulumi_azure as azure
    
    example = azure.core.ResourceGroup("example",
        name="example-resources",
        location="West Europe")
    example_network_watcher = azure.network.NetworkWatcher("example",
        name="example-nw",
        location=example.location,
        resource_group_name=example.name)
    example_virtual_network = azure.network.VirtualNetwork("example",
        name="example-vn",
        address_spaces=["10.0.0.0/16"],
        location=example.location,
        resource_group_name=example.name)
    example_subnet = azure.network.Subnet("example",
        name="internal",
        resource_group_name=example.name,
        virtual_network_name=example_virtual_network.name,
        address_prefixes=["10.0.2.0/24"])
    example_linux_virtual_machine_scale_set = azure.compute.LinuxVirtualMachineScaleSet("example",
        name="example-vmss",
        resource_group_name=example.name,
        location=example.location,
        sku="Standard_F2",
        instances=4,
        admin_username="adminuser",
        admin_password="P@ssword1234!",
        computer_name_prefix="my-linux-computer-name-prefix",
        upgrade_mode="Automatic",
        disable_password_authentication=False,
        source_image_reference=azure.compute.LinuxVirtualMachineScaleSetSourceImageReferenceArgs(
            publisher="Canonical",
            offer="0001-com-ubuntu-server-jammy",
            sku="22_04-lts",
            version="latest",
        ),
        os_disk=azure.compute.LinuxVirtualMachineScaleSetOsDiskArgs(
            storage_account_type="Standard_LRS",
            caching="ReadWrite",
        ),
        network_interfaces=[azure.compute.LinuxVirtualMachineScaleSetNetworkInterfaceArgs(
            name="example",
            primary=True,
            ip_configurations=[azure.compute.LinuxVirtualMachineScaleSetNetworkInterfaceIpConfigurationArgs(
                name="internal",
                primary=True,
                subnet_id=example_subnet.id,
            )],
        )])
    example_virtual_machine_scale_set_extension = azure.compute.VirtualMachineScaleSetExtension("example",
        name="network-watcher",
        virtual_machine_scale_set_id=example_linux_virtual_machine_scale_set.id,
        publisher="Microsoft.Azure.NetworkWatcher",
        type="NetworkWatcherAgentLinux",
        type_handler_version="1.4",
        auto_upgrade_minor_version=True,
        automatic_upgrade_enabled=True)
    example_scale_set_packet_capture = azure.compute.ScaleSetPacketCapture("example",
        name="example-pc",
        network_watcher_id=example_network_watcher.id,
        virtual_machine_scale_set_id=example_linux_virtual_machine_scale_set.id,
        storage_location=azure.compute.ScaleSetPacketCaptureStorageLocationArgs(
            file_path="/var/captures/packet.cap",
        ),
        machine_scope=azure.compute.ScaleSetPacketCaptureMachineScopeArgs(
            include_instance_ids=["0"],
            exclude_instance_ids=["1"],
        ),
        opts=pulumi.ResourceOptions(depends_on=[example_virtual_machine_scale_set_extension]))
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/compute"
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/network"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
    			Name:     pulumi.String("example-resources"),
    			Location: pulumi.String("West Europe"),
    		})
    		if err != nil {
    			return err
    		}
    		exampleNetworkWatcher, err := network.NewNetworkWatcher(ctx, "example", &network.NetworkWatcherArgs{
    			Name:              pulumi.String("example-nw"),
    			Location:          example.Location,
    			ResourceGroupName: example.Name,
    		})
    		if err != nil {
    			return err
    		}
    		exampleVirtualNetwork, err := network.NewVirtualNetwork(ctx, "example", &network.VirtualNetworkArgs{
    			Name: pulumi.String("example-vn"),
    			AddressSpaces: pulumi.StringArray{
    				pulumi.String("10.0.0.0/16"),
    			},
    			Location:          example.Location,
    			ResourceGroupName: example.Name,
    		})
    		if err != nil {
    			return err
    		}
    		exampleSubnet, err := network.NewSubnet(ctx, "example", &network.SubnetArgs{
    			Name:               pulumi.String("internal"),
    			ResourceGroupName:  example.Name,
    			VirtualNetworkName: exampleVirtualNetwork.Name,
    			AddressPrefixes: pulumi.StringArray{
    				pulumi.String("10.0.2.0/24"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		exampleLinuxVirtualMachineScaleSet, err := compute.NewLinuxVirtualMachineScaleSet(ctx, "example", &compute.LinuxVirtualMachineScaleSetArgs{
    			Name:                          pulumi.String("example-vmss"),
    			ResourceGroupName:             example.Name,
    			Location:                      example.Location,
    			Sku:                           pulumi.String("Standard_F2"),
    			Instances:                     pulumi.Int(4),
    			AdminUsername:                 pulumi.String("adminuser"),
    			AdminPassword:                 pulumi.String("P@ssword1234!"),
    			ComputerNamePrefix:            pulumi.String("my-linux-computer-name-prefix"),
    			UpgradeMode:                   pulumi.String("Automatic"),
    			DisablePasswordAuthentication: pulumi.Bool(false),
    			SourceImageReference: &compute.LinuxVirtualMachineScaleSetSourceImageReferenceArgs{
    				Publisher: pulumi.String("Canonical"),
    				Offer:     pulumi.String("0001-com-ubuntu-server-jammy"),
    				Sku:       pulumi.String("22_04-lts"),
    				Version:   pulumi.String("latest"),
    			},
    			OsDisk: &compute.LinuxVirtualMachineScaleSetOsDiskArgs{
    				StorageAccountType: pulumi.String("Standard_LRS"),
    				Caching:            pulumi.String("ReadWrite"),
    			},
    			NetworkInterfaces: compute.LinuxVirtualMachineScaleSetNetworkInterfaceArray{
    				&compute.LinuxVirtualMachineScaleSetNetworkInterfaceArgs{
    					Name:    pulumi.String("example"),
    					Primary: pulumi.Bool(true),
    					IpConfigurations: compute.LinuxVirtualMachineScaleSetNetworkInterfaceIpConfigurationArray{
    						&compute.LinuxVirtualMachineScaleSetNetworkInterfaceIpConfigurationArgs{
    							Name:     pulumi.String("internal"),
    							Primary:  pulumi.Bool(true),
    							SubnetId: exampleSubnet.ID(),
    						},
    					},
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		exampleVirtualMachineScaleSetExtension, err := compute.NewVirtualMachineScaleSetExtension(ctx, "example", &compute.VirtualMachineScaleSetExtensionArgs{
    			Name:                     pulumi.String("network-watcher"),
    			VirtualMachineScaleSetId: exampleLinuxVirtualMachineScaleSet.ID(),
    			Publisher:                pulumi.String("Microsoft.Azure.NetworkWatcher"),
    			Type:                     pulumi.String("NetworkWatcherAgentLinux"),
    			TypeHandlerVersion:       pulumi.String("1.4"),
    			AutoUpgradeMinorVersion:  pulumi.Bool(true),
    			AutomaticUpgradeEnabled:  pulumi.Bool(true),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = compute.NewScaleSetPacketCapture(ctx, "example", &compute.ScaleSetPacketCaptureArgs{
    			Name:                     pulumi.String("example-pc"),
    			NetworkWatcherId:         exampleNetworkWatcher.ID(),
    			VirtualMachineScaleSetId: exampleLinuxVirtualMachineScaleSet.ID(),
    			StorageLocation: &compute.ScaleSetPacketCaptureStorageLocationArgs{
    				FilePath: pulumi.String("/var/captures/packet.cap"),
    			},
    			MachineScope: &compute.ScaleSetPacketCaptureMachineScopeArgs{
    				IncludeInstanceIds: pulumi.StringArray{
    					pulumi.String("0"),
    				},
    				ExcludeInstanceIds: pulumi.StringArray{
    					pulumi.String("1"),
    				},
    			},
    		}, pulumi.DependsOn([]pulumi.Resource{
    			exampleVirtualMachineScaleSetExtension,
    		}))
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Azure = Pulumi.Azure;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Azure.Core.ResourceGroup("example", new()
        {
            Name = "example-resources",
            Location = "West Europe",
        });
    
        var exampleNetworkWatcher = new Azure.Network.NetworkWatcher("example", new()
        {
            Name = "example-nw",
            Location = example.Location,
            ResourceGroupName = example.Name,
        });
    
        var exampleVirtualNetwork = new Azure.Network.VirtualNetwork("example", new()
        {
            Name = "example-vn",
            AddressSpaces = new[]
            {
                "10.0.0.0/16",
            },
            Location = example.Location,
            ResourceGroupName = example.Name,
        });
    
        var exampleSubnet = new Azure.Network.Subnet("example", new()
        {
            Name = "internal",
            ResourceGroupName = example.Name,
            VirtualNetworkName = exampleVirtualNetwork.Name,
            AddressPrefixes = new[]
            {
                "10.0.2.0/24",
            },
        });
    
        var exampleLinuxVirtualMachineScaleSet = new Azure.Compute.LinuxVirtualMachineScaleSet("example", new()
        {
            Name = "example-vmss",
            ResourceGroupName = example.Name,
            Location = example.Location,
            Sku = "Standard_F2",
            Instances = 4,
            AdminUsername = "adminuser",
            AdminPassword = "P@ssword1234!",
            ComputerNamePrefix = "my-linux-computer-name-prefix",
            UpgradeMode = "Automatic",
            DisablePasswordAuthentication = false,
            SourceImageReference = new Azure.Compute.Inputs.LinuxVirtualMachineScaleSetSourceImageReferenceArgs
            {
                Publisher = "Canonical",
                Offer = "0001-com-ubuntu-server-jammy",
                Sku = "22_04-lts",
                Version = "latest",
            },
            OsDisk = new Azure.Compute.Inputs.LinuxVirtualMachineScaleSetOsDiskArgs
            {
                StorageAccountType = "Standard_LRS",
                Caching = "ReadWrite",
            },
            NetworkInterfaces = new[]
            {
                new Azure.Compute.Inputs.LinuxVirtualMachineScaleSetNetworkInterfaceArgs
                {
                    Name = "example",
                    Primary = true,
                    IpConfigurations = new[]
                    {
                        new Azure.Compute.Inputs.LinuxVirtualMachineScaleSetNetworkInterfaceIpConfigurationArgs
                        {
                            Name = "internal",
                            Primary = true,
                            SubnetId = exampleSubnet.Id,
                        },
                    },
                },
            },
        });
    
        var exampleVirtualMachineScaleSetExtension = new Azure.Compute.VirtualMachineScaleSetExtension("example", new()
        {
            Name = "network-watcher",
            VirtualMachineScaleSetId = exampleLinuxVirtualMachineScaleSet.Id,
            Publisher = "Microsoft.Azure.NetworkWatcher",
            Type = "NetworkWatcherAgentLinux",
            TypeHandlerVersion = "1.4",
            AutoUpgradeMinorVersion = true,
            AutomaticUpgradeEnabled = true,
        });
    
        var exampleScaleSetPacketCapture = new Azure.Compute.ScaleSetPacketCapture("example", new()
        {
            Name = "example-pc",
            NetworkWatcherId = exampleNetworkWatcher.Id,
            VirtualMachineScaleSetId = exampleLinuxVirtualMachineScaleSet.Id,
            StorageLocation = new Azure.Compute.Inputs.ScaleSetPacketCaptureStorageLocationArgs
            {
                FilePath = "/var/captures/packet.cap",
            },
            MachineScope = new Azure.Compute.Inputs.ScaleSetPacketCaptureMachineScopeArgs
            {
                IncludeInstanceIds = new[]
                {
                    "0",
                },
                ExcludeInstanceIds = new[]
                {
                    "1",
                },
            },
        }, new CustomResourceOptions
        {
            DependsOn =
            {
                exampleVirtualMachineScaleSetExtension,
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azure.core.ResourceGroup;
    import com.pulumi.azure.core.ResourceGroupArgs;
    import com.pulumi.azure.network.NetworkWatcher;
    import com.pulumi.azure.network.NetworkWatcherArgs;
    import com.pulumi.azure.network.VirtualNetwork;
    import com.pulumi.azure.network.VirtualNetworkArgs;
    import com.pulumi.azure.network.Subnet;
    import com.pulumi.azure.network.SubnetArgs;
    import com.pulumi.azure.compute.LinuxVirtualMachineScaleSet;
    import com.pulumi.azure.compute.LinuxVirtualMachineScaleSetArgs;
    import com.pulumi.azure.compute.inputs.LinuxVirtualMachineScaleSetSourceImageReferenceArgs;
    import com.pulumi.azure.compute.inputs.LinuxVirtualMachineScaleSetOsDiskArgs;
    import com.pulumi.azure.compute.inputs.LinuxVirtualMachineScaleSetNetworkInterfaceArgs;
    import com.pulumi.azure.compute.VirtualMachineScaleSetExtension;
    import com.pulumi.azure.compute.VirtualMachineScaleSetExtensionArgs;
    import com.pulumi.azure.compute.ScaleSetPacketCapture;
    import com.pulumi.azure.compute.ScaleSetPacketCaptureArgs;
    import com.pulumi.azure.compute.inputs.ScaleSetPacketCaptureStorageLocationArgs;
    import com.pulumi.azure.compute.inputs.ScaleSetPacketCaptureMachineScopeArgs;
    import com.pulumi.resources.CustomResourceOptions;
    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 example = new ResourceGroup("example", ResourceGroupArgs.builder()
                .name("example-resources")
                .location("West Europe")
                .build());
    
            var exampleNetworkWatcher = new NetworkWatcher("exampleNetworkWatcher", NetworkWatcherArgs.builder()
                .name("example-nw")
                .location(example.location())
                .resourceGroupName(example.name())
                .build());
    
            var exampleVirtualNetwork = new VirtualNetwork("exampleVirtualNetwork", VirtualNetworkArgs.builder()
                .name("example-vn")
                .addressSpaces("10.0.0.0/16")
                .location(example.location())
                .resourceGroupName(example.name())
                .build());
    
            var exampleSubnet = new Subnet("exampleSubnet", SubnetArgs.builder()
                .name("internal")
                .resourceGroupName(example.name())
                .virtualNetworkName(exampleVirtualNetwork.name())
                .addressPrefixes("10.0.2.0/24")
                .build());
    
            var exampleLinuxVirtualMachineScaleSet = new LinuxVirtualMachineScaleSet("exampleLinuxVirtualMachineScaleSet", LinuxVirtualMachineScaleSetArgs.builder()
                .name("example-vmss")
                .resourceGroupName(example.name())
                .location(example.location())
                .sku("Standard_F2")
                .instances(4)
                .adminUsername("adminuser")
                .adminPassword("P@ssword1234!")
                .computerNamePrefix("my-linux-computer-name-prefix")
                .upgradeMode("Automatic")
                .disablePasswordAuthentication(false)
                .sourceImageReference(LinuxVirtualMachineScaleSetSourceImageReferenceArgs.builder()
                    .publisher("Canonical")
                    .offer("0001-com-ubuntu-server-jammy")
                    .sku("22_04-lts")
                    .version("latest")
                    .build())
                .osDisk(LinuxVirtualMachineScaleSetOsDiskArgs.builder()
                    .storageAccountType("Standard_LRS")
                    .caching("ReadWrite")
                    .build())
                .networkInterfaces(LinuxVirtualMachineScaleSetNetworkInterfaceArgs.builder()
                    .name("example")
                    .primary(true)
                    .ipConfigurations(LinuxVirtualMachineScaleSetNetworkInterfaceIpConfigurationArgs.builder()
                        .name("internal")
                        .primary(true)
                        .subnetId(exampleSubnet.id())
                        .build())
                    .build())
                .build());
    
            var exampleVirtualMachineScaleSetExtension = new VirtualMachineScaleSetExtension("exampleVirtualMachineScaleSetExtension", VirtualMachineScaleSetExtensionArgs.builder()
                .name("network-watcher")
                .virtualMachineScaleSetId(exampleLinuxVirtualMachineScaleSet.id())
                .publisher("Microsoft.Azure.NetworkWatcher")
                .type("NetworkWatcherAgentLinux")
                .typeHandlerVersion("1.4")
                .autoUpgradeMinorVersion(true)
                .automaticUpgradeEnabled(true)
                .build());
    
            var exampleScaleSetPacketCapture = new ScaleSetPacketCapture("exampleScaleSetPacketCapture", ScaleSetPacketCaptureArgs.builder()
                .name("example-pc")
                .networkWatcherId(exampleNetworkWatcher.id())
                .virtualMachineScaleSetId(exampleLinuxVirtualMachineScaleSet.id())
                .storageLocation(ScaleSetPacketCaptureStorageLocationArgs.builder()
                    .filePath("/var/captures/packet.cap")
                    .build())
                .machineScope(ScaleSetPacketCaptureMachineScopeArgs.builder()
                    .includeInstanceIds("0")
                    .excludeInstanceIds("1")
                    .build())
                .build(), CustomResourceOptions.builder()
                    .dependsOn(exampleVirtualMachineScaleSetExtension)
                    .build());
    
        }
    }
    
    resources:
      example:
        type: azure:core:ResourceGroup
        properties:
          name: example-resources
          location: West Europe
      exampleNetworkWatcher:
        type: azure:network:NetworkWatcher
        name: example
        properties:
          name: example-nw
          location: ${example.location}
          resourceGroupName: ${example.name}
      exampleVirtualNetwork:
        type: azure:network:VirtualNetwork
        name: example
        properties:
          name: example-vn
          addressSpaces:
            - 10.0.0.0/16
          location: ${example.location}
          resourceGroupName: ${example.name}
      exampleSubnet:
        type: azure:network:Subnet
        name: example
        properties:
          name: internal
          resourceGroupName: ${example.name}
          virtualNetworkName: ${exampleVirtualNetwork.name}
          addressPrefixes:
            - 10.0.2.0/24
      exampleLinuxVirtualMachineScaleSet:
        type: azure:compute:LinuxVirtualMachineScaleSet
        name: example
        properties:
          name: example-vmss
          resourceGroupName: ${example.name}
          location: ${example.location}
          sku: Standard_F2
          instances: 4
          adminUsername: adminuser
          adminPassword: P@ssword1234!
          computerNamePrefix: my-linux-computer-name-prefix
          upgradeMode: Automatic
          disablePasswordAuthentication: false
          sourceImageReference:
            publisher: Canonical
            offer: 0001-com-ubuntu-server-jammy
            sku: 22_04-lts
            version: latest
          osDisk:
            storageAccountType: Standard_LRS
            caching: ReadWrite
          networkInterfaces:
            - name: example
              primary: true
              ipConfigurations:
                - name: internal
                  primary: true
                  subnetId: ${exampleSubnet.id}
      exampleVirtualMachineScaleSetExtension:
        type: azure:compute:VirtualMachineScaleSetExtension
        name: example
        properties:
          name: network-watcher
          virtualMachineScaleSetId: ${exampleLinuxVirtualMachineScaleSet.id}
          publisher: Microsoft.Azure.NetworkWatcher
          type: NetworkWatcherAgentLinux
          typeHandlerVersion: '1.4'
          autoUpgradeMinorVersion: true
          automaticUpgradeEnabled: true
      exampleScaleSetPacketCapture:
        type: azure:compute:ScaleSetPacketCapture
        name: example
        properties:
          name: example-pc
          networkWatcherId: ${exampleNetworkWatcher.id}
          virtualMachineScaleSetId: ${exampleLinuxVirtualMachineScaleSet.id}
          storageLocation:
            filePath: /var/captures/packet.cap
          machineScope:
            includeInstanceIds:
              - '0'
            excludeInstanceIds:
              - '1'
        options:
          dependson:
            - ${exampleVirtualMachineScaleSetExtension}
    

    NOTE: This Resource requires that the Network Watcher Extension is installed on the Virtual Machine Scale Set before capturing can be enabled which can be installed via the azure.compute.VirtualMachineScaleSetExtension resource.

    Create ScaleSetPacketCapture Resource

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

    Constructor syntax

    new ScaleSetPacketCapture(name: string, args: ScaleSetPacketCaptureArgs, opts?: CustomResourceOptions);
    @overload
    def ScaleSetPacketCapture(resource_name: str,
                              args: ScaleSetPacketCaptureArgs,
                              opts: Optional[ResourceOptions] = None)
    
    @overload
    def ScaleSetPacketCapture(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              network_watcher_id: Optional[str] = None,
                              storage_location: Optional[ScaleSetPacketCaptureStorageLocationArgs] = None,
                              virtual_machine_scale_set_id: Optional[str] = None,
                              filters: Optional[Sequence[ScaleSetPacketCaptureFilterArgs]] = None,
                              machine_scope: Optional[ScaleSetPacketCaptureMachineScopeArgs] = None,
                              maximum_bytes_per_packet: Optional[int] = None,
                              maximum_bytes_per_session: Optional[int] = None,
                              maximum_capture_duration_in_seconds: Optional[int] = None,
                              name: Optional[str] = None)
    func NewScaleSetPacketCapture(ctx *Context, name string, args ScaleSetPacketCaptureArgs, opts ...ResourceOption) (*ScaleSetPacketCapture, error)
    public ScaleSetPacketCapture(string name, ScaleSetPacketCaptureArgs args, CustomResourceOptions? opts = null)
    public ScaleSetPacketCapture(String name, ScaleSetPacketCaptureArgs args)
    public ScaleSetPacketCapture(String name, ScaleSetPacketCaptureArgs args, CustomResourceOptions options)
    
    type: azure:compute:ScaleSetPacketCapture
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

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

    Example

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

    var scaleSetPacketCaptureResource = new Azure.Compute.ScaleSetPacketCapture("scaleSetPacketCaptureResource", new()
    {
        NetworkWatcherId = "string",
        StorageLocation = new Azure.Compute.Inputs.ScaleSetPacketCaptureStorageLocationArgs
        {
            FilePath = "string",
            StorageAccountId = "string",
            StoragePath = "string",
        },
        VirtualMachineScaleSetId = "string",
        Filters = new[]
        {
            new Azure.Compute.Inputs.ScaleSetPacketCaptureFilterArgs
            {
                Protocol = "string",
                LocalIpAddress = "string",
                LocalPort = "string",
                RemoteIpAddress = "string",
                RemotePort = "string",
            },
        },
        MachineScope = new Azure.Compute.Inputs.ScaleSetPacketCaptureMachineScopeArgs
        {
            ExcludeInstanceIds = new[]
            {
                "string",
            },
            IncludeInstanceIds = new[]
            {
                "string",
            },
        },
        MaximumBytesPerPacket = 0,
        MaximumBytesPerSession = 0,
        MaximumCaptureDurationInSeconds = 0,
        Name = "string",
    });
    
    example, err := compute.NewScaleSetPacketCapture(ctx, "scaleSetPacketCaptureResource", &compute.ScaleSetPacketCaptureArgs{
    	NetworkWatcherId: pulumi.String("string"),
    	StorageLocation: &compute.ScaleSetPacketCaptureStorageLocationArgs{
    		FilePath:         pulumi.String("string"),
    		StorageAccountId: pulumi.String("string"),
    		StoragePath:      pulumi.String("string"),
    	},
    	VirtualMachineScaleSetId: pulumi.String("string"),
    	Filters: compute.ScaleSetPacketCaptureFilterArray{
    		&compute.ScaleSetPacketCaptureFilterArgs{
    			Protocol:        pulumi.String("string"),
    			LocalIpAddress:  pulumi.String("string"),
    			LocalPort:       pulumi.String("string"),
    			RemoteIpAddress: pulumi.String("string"),
    			RemotePort:      pulumi.String("string"),
    		},
    	},
    	MachineScope: &compute.ScaleSetPacketCaptureMachineScopeArgs{
    		ExcludeInstanceIds: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    		IncludeInstanceIds: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    	},
    	MaximumBytesPerPacket:           pulumi.Int(0),
    	MaximumBytesPerSession:          pulumi.Int(0),
    	MaximumCaptureDurationInSeconds: pulumi.Int(0),
    	Name:                            pulumi.String("string"),
    })
    
    var scaleSetPacketCaptureResource = new ScaleSetPacketCapture("scaleSetPacketCaptureResource", ScaleSetPacketCaptureArgs.builder()
        .networkWatcherId("string")
        .storageLocation(ScaleSetPacketCaptureStorageLocationArgs.builder()
            .filePath("string")
            .storageAccountId("string")
            .storagePath("string")
            .build())
        .virtualMachineScaleSetId("string")
        .filters(ScaleSetPacketCaptureFilterArgs.builder()
            .protocol("string")
            .localIpAddress("string")
            .localPort("string")
            .remoteIpAddress("string")
            .remotePort("string")
            .build())
        .machineScope(ScaleSetPacketCaptureMachineScopeArgs.builder()
            .excludeInstanceIds("string")
            .includeInstanceIds("string")
            .build())
        .maximumBytesPerPacket(0)
        .maximumBytesPerSession(0)
        .maximumCaptureDurationInSeconds(0)
        .name("string")
        .build());
    
    scale_set_packet_capture_resource = azure.compute.ScaleSetPacketCapture("scaleSetPacketCaptureResource",
        network_watcher_id="string",
        storage_location=azure.compute.ScaleSetPacketCaptureStorageLocationArgs(
            file_path="string",
            storage_account_id="string",
            storage_path="string",
        ),
        virtual_machine_scale_set_id="string",
        filters=[azure.compute.ScaleSetPacketCaptureFilterArgs(
            protocol="string",
            local_ip_address="string",
            local_port="string",
            remote_ip_address="string",
            remote_port="string",
        )],
        machine_scope=azure.compute.ScaleSetPacketCaptureMachineScopeArgs(
            exclude_instance_ids=["string"],
            include_instance_ids=["string"],
        ),
        maximum_bytes_per_packet=0,
        maximum_bytes_per_session=0,
        maximum_capture_duration_in_seconds=0,
        name="string")
    
    const scaleSetPacketCaptureResource = new azure.compute.ScaleSetPacketCapture("scaleSetPacketCaptureResource", {
        networkWatcherId: "string",
        storageLocation: {
            filePath: "string",
            storageAccountId: "string",
            storagePath: "string",
        },
        virtualMachineScaleSetId: "string",
        filters: [{
            protocol: "string",
            localIpAddress: "string",
            localPort: "string",
            remoteIpAddress: "string",
            remotePort: "string",
        }],
        machineScope: {
            excludeInstanceIds: ["string"],
            includeInstanceIds: ["string"],
        },
        maximumBytesPerPacket: 0,
        maximumBytesPerSession: 0,
        maximumCaptureDurationInSeconds: 0,
        name: "string",
    });
    
    type: azure:compute:ScaleSetPacketCapture
    properties:
        filters:
            - localIpAddress: string
              localPort: string
              protocol: string
              remoteIpAddress: string
              remotePort: string
        machineScope:
            excludeInstanceIds:
                - string
            includeInstanceIds:
                - string
        maximumBytesPerPacket: 0
        maximumBytesPerSession: 0
        maximumCaptureDurationInSeconds: 0
        name: string
        networkWatcherId: string
        storageLocation:
            filePath: string
            storageAccountId: string
            storagePath: string
        virtualMachineScaleSetId: string
    

    ScaleSetPacketCapture Resource Properties

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

    Inputs

    The ScaleSetPacketCapture resource accepts the following input properties:

    NetworkWatcherId string
    The resource ID of the Network Watcher. Changing this forces a new resource to be created.
    StorageLocation ScaleSetPacketCaptureStorageLocation
    A storage_location block as defined below. Changing this forces a new resource to be created.
    VirtualMachineScaleSetId string
    The resource ID of the Virtual Machine Scale Set to capture packets from. Changing this forces a new resource to be created.
    Filters List<ScaleSetPacketCaptureFilter>
    One or more filter blocks as defined below. Changing this forces a new resource to be created.
    MachineScope ScaleSetPacketCaptureMachineScope
    A machine_scope block 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.
    MaximumCaptureDurationInSeconds 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.
    NetworkWatcherId string
    The resource ID of the Network Watcher. Changing this forces a new resource to be created.
    StorageLocation ScaleSetPacketCaptureStorageLocationArgs
    A storage_location block as defined below. Changing this forces a new resource to be created.
    VirtualMachineScaleSetId string
    The resource ID of the Virtual Machine Scale Set to capture packets from. Changing this forces a new resource to be created.
    Filters []ScaleSetPacketCaptureFilterArgs
    One or more filter blocks as defined below. Changing this forces a new resource to be created.
    MachineScope ScaleSetPacketCaptureMachineScopeArgs
    A machine_scope block 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.
    MaximumCaptureDurationInSeconds 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.
    networkWatcherId String
    The resource ID of the Network Watcher. Changing this forces a new resource to be created.
    storageLocation ScaleSetPacketCaptureStorageLocation
    A storage_location block as defined below. Changing this forces a new resource to be created.
    virtualMachineScaleSetId String
    The resource ID of the Virtual Machine Scale Set to capture packets from. Changing this forces a new resource to be created.
    filters List<ScaleSetPacketCaptureFilter>
    One or more filter blocks as defined below. Changing this forces a new resource to be created.
    machineScope ScaleSetPacketCaptureMachineScope
    A machine_scope block as defined below. Changing this forces a new resource to be created.
    maximumBytesPerPacket Integer
    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 Integer
    Maximum size of the capture in Bytes. Defaults to 1073741824 (1GB). Changing this forces a new resource to be created.
    maximumCaptureDurationInSeconds Integer
    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.
    networkWatcherId string
    The resource ID of the Network Watcher. Changing this forces a new resource to be created.
    storageLocation ScaleSetPacketCaptureStorageLocation
    A storage_location block as defined below. Changing this forces a new resource to be created.
    virtualMachineScaleSetId string
    The resource ID of the Virtual Machine Scale Set to capture packets from. Changing this forces a new resource to be created.
    filters ScaleSetPacketCaptureFilter[]
    One or more filter blocks as defined below. Changing this forces a new resource to be created.
    machineScope ScaleSetPacketCaptureMachineScope
    A machine_scope block 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.
    maximumCaptureDurationInSeconds 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_id str
    The resource ID of the Network Watcher. Changing this forces a new resource to be created.
    storage_location ScaleSetPacketCaptureStorageLocationArgs
    A storage_location block as defined below. Changing this forces a new resource to be created.
    virtual_machine_scale_set_id str
    The resource ID of the Virtual Machine Scale Set to capture packets from. Changing this forces a new resource to be created.
    filters Sequence[ScaleSetPacketCaptureFilterArgs]
    One or more filter blocks as defined below. Changing this forces a new resource to be created.
    machine_scope ScaleSetPacketCaptureMachineScopeArgs
    A machine_scope block as defined below. Changing this forces a new resource to be created.
    maximum_bytes_per_packet 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.
    maximum_bytes_per_session int
    Maximum size of the capture in Bytes. Defaults to 1073741824 (1GB). Changing this forces a new resource to be created.
    maximum_capture_duration_in_seconds 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 str
    The name to use for this Network Packet Capture. Changing this forces a new resource to be created.
    networkWatcherId String
    The resource ID of the Network Watcher. Changing this forces a new resource to be created.
    storageLocation Property Map
    A storage_location block as defined below. Changing this forces a new resource to be created.
    virtualMachineScaleSetId String
    The resource ID of the Virtual Machine Scale Set to capture packets from. Changing this forces a new resource to be created.
    filters List<Property Map>
    One or more filter blocks as defined below. Changing this forces a new resource to be created.
    machineScope Property Map
    A machine_scope block 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.
    maximumCaptureDurationInSeconds 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.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ScaleSetPacketCapture 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 string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing ScaleSetPacketCapture Resource

    Get an existing ScaleSetPacketCapture 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?: ScaleSetPacketCaptureState, opts?: CustomResourceOptions): ScaleSetPacketCapture
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            filters: Optional[Sequence[ScaleSetPacketCaptureFilterArgs]] = None,
            machine_scope: Optional[ScaleSetPacketCaptureMachineScopeArgs] = None,
            maximum_bytes_per_packet: Optional[int] = None,
            maximum_bytes_per_session: Optional[int] = None,
            maximum_capture_duration_in_seconds: Optional[int] = None,
            name: Optional[str] = None,
            network_watcher_id: Optional[str] = None,
            storage_location: Optional[ScaleSetPacketCaptureStorageLocationArgs] = None,
            virtual_machine_scale_set_id: Optional[str] = None) -> ScaleSetPacketCapture
    func GetScaleSetPacketCapture(ctx *Context, name string, id IDInput, state *ScaleSetPacketCaptureState, opts ...ResourceOption) (*ScaleSetPacketCapture, error)
    public static ScaleSetPacketCapture Get(string name, Input<string> id, ScaleSetPacketCaptureState? state, CustomResourceOptions? opts = null)
    public static ScaleSetPacketCapture get(String name, Output<String> id, ScaleSetPacketCaptureState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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.
    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<ScaleSetPacketCaptureFilter>
    One or more filter blocks as defined below. Changing this forces a new resource to be created.
    MachineScope ScaleSetPacketCaptureMachineScope
    A machine_scope block 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.
    MaximumCaptureDurationInSeconds 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.
    NetworkWatcherId string
    The resource ID of the Network Watcher. Changing this forces a new resource to be created.
    StorageLocation ScaleSetPacketCaptureStorageLocation
    A storage_location block as defined below. Changing this forces a new resource to be created.
    VirtualMachineScaleSetId string
    The resource ID of the Virtual Machine Scale Set to capture packets from. Changing this forces a new resource to be created.
    Filters []ScaleSetPacketCaptureFilterArgs
    One or more filter blocks as defined below. Changing this forces a new resource to be created.
    MachineScope ScaleSetPacketCaptureMachineScopeArgs
    A machine_scope block 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.
    MaximumCaptureDurationInSeconds 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.
    NetworkWatcherId string
    The resource ID of the Network Watcher. Changing this forces a new resource to be created.
    StorageLocation ScaleSetPacketCaptureStorageLocationArgs
    A storage_location block as defined below. Changing this forces a new resource to be created.
    VirtualMachineScaleSetId string
    The resource ID of the Virtual Machine Scale Set to capture packets from. Changing this forces a new resource to be created.
    filters List<ScaleSetPacketCaptureFilter>
    One or more filter blocks as defined below. Changing this forces a new resource to be created.
    machineScope ScaleSetPacketCaptureMachineScope
    A machine_scope block as defined below. Changing this forces a new resource to be created.
    maximumBytesPerPacket Integer
    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 Integer
    Maximum size of the capture in Bytes. Defaults to 1073741824 (1GB). Changing this forces a new resource to be created.
    maximumCaptureDurationInSeconds Integer
    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.
    networkWatcherId String
    The resource ID of the Network Watcher. Changing this forces a new resource to be created.
    storageLocation ScaleSetPacketCaptureStorageLocation
    A storage_location block as defined below. Changing this forces a new resource to be created.
    virtualMachineScaleSetId String
    The resource ID of the Virtual Machine Scale Set to capture packets from. Changing this forces a new resource to be created.
    filters ScaleSetPacketCaptureFilter[]
    One or more filter blocks as defined below. Changing this forces a new resource to be created.
    machineScope ScaleSetPacketCaptureMachineScope
    A machine_scope block 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.
    maximumCaptureDurationInSeconds 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.
    networkWatcherId string
    The resource ID of the Network Watcher. Changing this forces a new resource to be created.
    storageLocation ScaleSetPacketCaptureStorageLocation
    A storage_location block as defined below. Changing this forces a new resource to be created.
    virtualMachineScaleSetId string
    The resource ID of the Virtual Machine Scale Set to capture packets from. Changing this forces a new resource to be created.
    filters Sequence[ScaleSetPacketCaptureFilterArgs]
    One or more filter blocks as defined below. Changing this forces a new resource to be created.
    machine_scope ScaleSetPacketCaptureMachineScopeArgs
    A machine_scope block as defined below. Changing this forces a new resource to be created.
    maximum_bytes_per_packet 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.
    maximum_bytes_per_session int
    Maximum size of the capture in Bytes. Defaults to 1073741824 (1GB). Changing this forces a new resource to be created.
    maximum_capture_duration_in_seconds 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 str
    The name to use for this Network Packet Capture. Changing this forces a new resource to be created.
    network_watcher_id str
    The resource ID of the Network Watcher. Changing this forces a new resource to be created.
    storage_location ScaleSetPacketCaptureStorageLocationArgs
    A storage_location block as defined below. Changing this forces a new resource to be created.
    virtual_machine_scale_set_id str
    The resource ID of the Virtual Machine Scale Set to capture packets from. Changing this forces a new resource to be created.
    filters List<Property Map>
    One or more filter blocks as defined below. Changing this forces a new resource to be created.
    machineScope Property Map
    A machine_scope block 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.
    maximumCaptureDurationInSeconds 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.
    networkWatcherId String
    The resource ID of the Network Watcher. Changing this forces a new resource to be created.
    storageLocation Property Map
    A storage_location block as defined below. Changing this forces a new resource to be created.
    virtualMachineScaleSetId String
    The resource ID of the Virtual Machine Scale Set to capture packets from. Changing this forces a new resource to be created.

    Supporting Types

    ScaleSetPacketCaptureFilter, ScaleSetPacketCaptureFilterArgs

    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. Specify 127.0.0.1 for a single address entry, 127.0.0.1-127.0.0.255 for a range and 127.0.0.1;127.0.0.5 for multiple entries. Multiple ranges and mixing ranges with multiple entries are currently not supported. Changing this forces a new resource to be created.
    LocalPort string
    The local port to be filtered on. Specify 80 for single port entry, 80-85 for a range and 80;443; for multiple entries. Multiple ranges and mixing ranges with multiple entries are currently not supported. Changing this forces a new resource to be created.
    RemoteIpAddress string
    The remote IP Address to be filtered on. Specify 127.0.0.1 for a single address entry, 127.0.0.1-127.0.0.255 for a range and 127.0.0.1;127.0.0.5 for multiple entries. Multiple ranges and mixing ranges with multiple entries are currently not supported. Changing this forces a new resource to be created.
    RemotePort string
    The remote port to be filtered on. Specify 80 for single port entry, 80-85 for a range and 80;443; for multiple entries. Multiple ranges and mixing ranges with multiple entries are currently not 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. Specify 127.0.0.1 for a single address entry, 127.0.0.1-127.0.0.255 for a range and 127.0.0.1;127.0.0.5 for multiple entries. Multiple ranges and mixing ranges with multiple entries are currently not supported. Changing this forces a new resource to be created.
    LocalPort string
    The local port to be filtered on. Specify 80 for single port entry, 80-85 for a range and 80;443; for multiple entries. Multiple ranges and mixing ranges with multiple entries are currently not supported. Changing this forces a new resource to be created.
    RemoteIpAddress string
    The remote IP Address to be filtered on. Specify 127.0.0.1 for a single address entry, 127.0.0.1-127.0.0.255 for a range and 127.0.0.1;127.0.0.5 for multiple entries. Multiple ranges and mixing ranges with multiple entries are currently not supported. Changing this forces a new resource to be created.
    RemotePort string
    The remote port to be filtered on. Specify 80 for single port entry, 80-85 for a range and 80;443; for multiple entries. Multiple ranges and mixing ranges with multiple entries are currently not 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. Specify 127.0.0.1 for a single address entry, 127.0.0.1-127.0.0.255 for a range and 127.0.0.1;127.0.0.5 for multiple entries. Multiple ranges and mixing ranges with multiple entries are currently not supported. Changing this forces a new resource to be created.
    localPort String
    The local port to be filtered on. Specify 80 for single port entry, 80-85 for a range and 80;443; for multiple entries. Multiple ranges and mixing ranges with multiple entries are currently not supported. Changing this forces a new resource to be created.
    remoteIpAddress String
    The remote IP Address to be filtered on. Specify 127.0.0.1 for a single address entry, 127.0.0.1-127.0.0.255 for a range and 127.0.0.1;127.0.0.5 for multiple entries. Multiple ranges and mixing ranges with multiple entries are currently not supported. Changing this forces a new resource to be created.
    remotePort String
    The remote port to be filtered on. Specify 80 for single port entry, 80-85 for a range and 80;443; for multiple entries. Multiple ranges and mixing ranges with multiple entries are currently not 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. Specify 127.0.0.1 for a single address entry, 127.0.0.1-127.0.0.255 for a range and 127.0.0.1;127.0.0.5 for multiple entries. Multiple ranges and mixing ranges with multiple entries are currently not supported. Changing this forces a new resource to be created.
    localPort string
    The local port to be filtered on. Specify 80 for single port entry, 80-85 for a range and 80;443; for multiple entries. Multiple ranges and mixing ranges with multiple entries are currently not supported. Changing this forces a new resource to be created.
    remoteIpAddress string
    The remote IP Address to be filtered on. Specify 127.0.0.1 for a single address entry, 127.0.0.1-127.0.0.255 for a range and 127.0.0.1;127.0.0.5 for multiple entries. Multiple ranges and mixing ranges with multiple entries are currently not supported. Changing this forces a new resource to be created.
    remotePort string
    The remote port to be filtered on. Specify 80 for single port entry, 80-85 for a range and 80;443; for multiple entries. Multiple ranges and mixing ranges with multiple entries are currently not 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.
    local_ip_address str
    The local IP Address to be filtered on. Specify 127.0.0.1 for a single address entry, 127.0.0.1-127.0.0.255 for a range and 127.0.0.1;127.0.0.5 for multiple entries. Multiple ranges and mixing ranges with multiple entries are currently not supported. Changing this forces a new resource to be created.
    local_port str
    The local port to be filtered on. Specify 80 for single port entry, 80-85 for a range and 80;443; for multiple entries. Multiple ranges and mixing ranges with multiple entries are currently not supported. Changing this forces a new resource to be created.
    remote_ip_address str
    The remote IP Address to be filtered on. Specify 127.0.0.1 for a single address entry, 127.0.0.1-127.0.0.255 for a range and 127.0.0.1;127.0.0.5 for multiple entries. Multiple ranges and mixing ranges with multiple entries are currently not supported. Changing this forces a new resource to be created.
    remote_port str
    The remote port to be filtered on. Specify 80 for single port entry, 80-85 for a range and 80;443; for multiple entries. Multiple ranges and mixing ranges with multiple entries are currently not 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. Specify 127.0.0.1 for a single address entry, 127.0.0.1-127.0.0.255 for a range and 127.0.0.1;127.0.0.5 for multiple entries. Multiple ranges and mixing ranges with multiple entries are currently not supported. Changing this forces a new resource to be created.
    localPort String
    The local port to be filtered on. Specify 80 for single port entry, 80-85 for a range and 80;443; for multiple entries. Multiple ranges and mixing ranges with multiple entries are currently not supported. Changing this forces a new resource to be created.
    remoteIpAddress String
    The remote IP Address to be filtered on. Specify 127.0.0.1 for a single address entry, 127.0.0.1-127.0.0.255 for a range and 127.0.0.1;127.0.0.5 for multiple entries. Multiple ranges and mixing ranges with multiple entries are currently not supported. Changing this forces a new resource to be created.
    remotePort String
    The remote port to be filtered on. Specify 80 for single port entry, 80-85 for a range and 80;443; for multiple entries. Multiple ranges and mixing ranges with multiple entries are currently not supported. Changing this forces a new resource to be created.

    ScaleSetPacketCaptureMachineScope, ScaleSetPacketCaptureMachineScopeArgs

    ExcludeInstanceIds List<string>
    A list of Virtual Machine Scale Set instance IDs which should be excluded from running Packet Capture, e.g. ["0", "2"]. Changing this forces a new resource to be created.
    IncludeInstanceIds List<string>
    A list of Virtual Machine Scale Set instance IDs which should be included for Packet Capture, e.g. ["1", "3"]. Changing this forces a new resource to be created.
    ExcludeInstanceIds []string
    A list of Virtual Machine Scale Set instance IDs which should be excluded from running Packet Capture, e.g. ["0", "2"]. Changing this forces a new resource to be created.
    IncludeInstanceIds []string
    A list of Virtual Machine Scale Set instance IDs which should be included for Packet Capture, e.g. ["1", "3"]. Changing this forces a new resource to be created.
    excludeInstanceIds List<String>
    A list of Virtual Machine Scale Set instance IDs which should be excluded from running Packet Capture, e.g. ["0", "2"]. Changing this forces a new resource to be created.
    includeInstanceIds List<String>
    A list of Virtual Machine Scale Set instance IDs which should be included for Packet Capture, e.g. ["1", "3"]. Changing this forces a new resource to be created.
    excludeInstanceIds string[]
    A list of Virtual Machine Scale Set instance IDs which should be excluded from running Packet Capture, e.g. ["0", "2"]. Changing this forces a new resource to be created.
    includeInstanceIds string[]
    A list of Virtual Machine Scale Set instance IDs which should be included for Packet Capture, e.g. ["1", "3"]. Changing this forces a new resource to be created.
    exclude_instance_ids Sequence[str]
    A list of Virtual Machine Scale Set instance IDs which should be excluded from running Packet Capture, e.g. ["0", "2"]. Changing this forces a new resource to be created.
    include_instance_ids Sequence[str]
    A list of Virtual Machine Scale Set instance IDs which should be included for Packet Capture, e.g. ["1", "3"]. Changing this forces a new resource to be created.
    excludeInstanceIds List<String>
    A list of Virtual Machine Scale Set instance IDs which should be excluded from running Packet Capture, e.g. ["0", "2"]. Changing this forces a new resource to be created.
    includeInstanceIds List<String>
    A list of Virtual Machine Scale Set instance IDs which should be included for Packet Capture, e.g. ["1", "3"]. Changing this forces a new resource to be created.

    ScaleSetPacketCaptureStorageLocation, ScaleSetPacketCaptureStorageLocationArgs

    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

    NOTE: At least one of file_path or storage_account_id must be specified.

    StoragePath string
    The URI of the storage path where the packet capture sessions are saved to.
    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

    NOTE: At least one of file_path or storage_account_id must be specified.

    StoragePath string
    The URI of the storage path where the packet capture sessions are saved to.
    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

    NOTE: At least one of file_path or storage_account_id must be specified.

    storagePath String
    The URI of the storage path where the packet capture sessions are saved to.
    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

    NOTE: At least one of file_path or storage_account_id must be specified.

    storagePath string
    The URI of the storage path where the packet capture sessions are saved to.
    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.
    storage_account_id str

    The ID of the storage account to save the packet capture session

    NOTE: At least one of file_path or storage_account_id must be specified.

    storage_path str
    The URI of the storage path where the packet capture sessions are saved to.
    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

    NOTE: At least one of file_path or storage_account_id must be specified.

    storagePath String
    The URI of the storage path where the packet capture sessions are saved to.

    Import

    Virtual Machine Scale Set Packet Captures can be imported using the resource id, e.g.

    $ pulumi import azure:compute/scaleSetPacketCapture:ScaleSetPacketCapture capture1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.Network/networkWatchers/watcher1/packetCaptures/capture1
    

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

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Azure Classic v5.80.0 published on Monday, Jun 10, 2024 by Pulumi