Class PacketCapture

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

NOTE: This resource has been deprecated in favour of the azure.network.NetworkConnectionMonitor resource and will be removed in the next major version of the AzureRM Provider. The new resource shares the same fields as this one, and information on migrating across can be found in this guide.

Inheritance

System.Object

Resource

CustomResource

PacketCapture

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Azure.Network

Assembly: Pulumi.Azure.dll

Syntax

public class PacketCapture : CustomResource

Constructors

PacketCapture(String, PacketCaptureArgs, CustomResourceOptions)

Create a PacketCapture resource with the given unique name, arguments, and options.

Declaration

public PacketCapture(string name, PacketCaptureArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
PacketCaptureArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

Filters

One or more filter blocks as defined below. Changing this forces a new resource to be created.

Declaration

public Output<ImmutableArray<PacketCaptureFilter>> Filters { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<PacketCaptureFilter>>

MaximumBytesPerPacket

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.

Declaration

public Output<int?> MaximumBytesPerPacket { get; }

Property Value

Type	Description
Output<System.Nullable<System.Int32>>

MaximumBytesPerSession

Maximum size of the capture in Bytes. Defaults to 1073741824 (1GB). Changing this forces a new resource to be created.

Declaration

public Output<int?> MaximumBytesPerSession { get; }

Property Value

Type	Description
Output<System.Nullable<System.Int32>>

MaximumCaptureDuration

The maximum duration of the capture session in seconds. Defaults to 18000 (5 hours). Changing this forces a new resource to be created.

Declaration

public Output<int?> MaximumCaptureDuration { get; }

Property Value

Type	Description
Output<System.Nullable<System.Int32>>

Name

The name to use for this Packet Capture. Changing this forces a new resource to be created.

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

NetworkWatcherName

The name of the Network Watcher. Changing this forces a new resource to be created.

Declaration

public Output<string> NetworkWatcherName { get; }

Property Value

Type	Description
Output<System.String>

ResourceGroupName

The name of the resource group in which the Network Watcher exists. Changing this forces a new resource to be created.

Declaration

public Output<string> ResourceGroupName { get; }

Property Value

Type	Description
Output<System.String>

StorageLocation

A storage_location block as defined below. Changing this forces a new resource to be created.

Declaration

public Output<PacketCaptureStorageLocation> StorageLocation { get; }

Property Value

Type	Description
Output<PacketCaptureStorageLocation>

TargetResourceId

The ID of the Resource to capture packets from. Changing this forces a new resource to be created.

Declaration

public Output<string> TargetResourceId { get; }

Property Value

Type	Description
Output<System.String>

Methods

Get(String, Input<String>, PacketCaptureState, CustomResourceOptions)

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

Declaration

public static PacketCapture Get(string name, Input<string> id, PacketCaptureState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
PacketCaptureState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
PacketCapture