Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. network
  5. getPacketCapture
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.0.1 published on Monday, Apr 7, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.network.getPacketCapture

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.0.1 published on Monday, Apr 7, 2025 by Pulumi
pulumi/pulumi-azure-native

Gets a packet capture session by name.

Uses Azure REST API version 2024-05-01.

Other available API versions: 2018-06-01, 2018-07-01, 2018-08-01, 2018-10-01, 2018-11-01, 2018-12-01, 2019-02-01, 2019-04-01, 2019-06-01, 2019-07-01, 2019-08-01, 2019-09-01, 2019-11-01, 2019-12-01, 2020-03-01, 2020-04-01, 2020-05-01, 2020-06-01, 2020-07-01, 2020-08-01, 2020-11-01, 2021-02-01, 2021-03-01, 2021-05-01, 2021-08-01, 2022-01-01, 2022-05-01, 2022-07-01, 2022-09-01, 2022-11-01, 2023-02-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native network [ApiVersion]. See the version guide for details.

Using getPacketCapture

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getPacketCapture(args: GetPacketCaptureArgs, opts?: InvokeOptions): Promise<GetPacketCaptureResult>
function getPacketCaptureOutput(args: GetPacketCaptureOutputArgs, opts?: InvokeOptions): Output<GetPacketCaptureResult>
Copy
def get_packet_capture(network_watcher_name: Optional[str] = None,
                       packet_capture_name: Optional[str] = None,
                       resource_group_name: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetPacketCaptureResult
def get_packet_capture_output(network_watcher_name: Optional[pulumi.Input[str]] = None,
                       packet_capture_name: Optional[pulumi.Input[str]] = None,
                       resource_group_name: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetPacketCaptureResult]
Copy
func LookupPacketCapture(ctx *Context, args *LookupPacketCaptureArgs, opts ...InvokeOption) (*LookupPacketCaptureResult, error)
func LookupPacketCaptureOutput(ctx *Context, args *LookupPacketCaptureOutputArgs, opts ...InvokeOption) LookupPacketCaptureResultOutput
Copy

> Note: This function is named LookupPacketCapture in the Go SDK.

public static class GetPacketCapture 
{
    public static Task<GetPacketCaptureResult> InvokeAsync(GetPacketCaptureArgs args, InvokeOptions? opts = null)
    public static Output<GetPacketCaptureResult> Invoke(GetPacketCaptureInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetPacketCaptureResult> getPacketCapture(GetPacketCaptureArgs args, InvokeOptions options)
public static Output<GetPacketCaptureResult> getPacketCapture(GetPacketCaptureArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:network:getPacketCapture
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

NetworkWatcherName
This property is required.
Changes to this property will trigger replacement.
string
The name of the network watcher.
PacketCaptureName
This property is required.
Changes to this property will trigger replacement.
string
The name of the packet capture session.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
NetworkWatcherName
This property is required.
Changes to this property will trigger replacement.
string
The name of the network watcher.
PacketCaptureName
This property is required.
Changes to this property will trigger replacement.
string
The name of the packet capture session.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
networkWatcherName
This property is required.
Changes to this property will trigger replacement.
String
The name of the network watcher.
packetCaptureName
This property is required.
Changes to this property will trigger replacement.
String
The name of the packet capture session.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
networkWatcherName
This property is required.
Changes to this property will trigger replacement.
string
The name of the network watcher.
packetCaptureName
This property is required.
Changes to this property will trigger replacement.
string
The name of the packet capture session.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
network_watcher_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the network watcher.
packet_capture_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the packet capture session.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group.
networkWatcherName
This property is required.
Changes to this property will trigger replacement.
String
The name of the network watcher.
packetCaptureName
This property is required.
Changes to this property will trigger replacement.
String
The name of the packet capture session.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.

getPacketCapture Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
Etag string
A unique read-only string that changes whenever the resource is updated.
Id string
ID of the packet capture operation.
Name string
Name of the packet capture session.
ProvisioningState string
The provisioning state of the packet capture session.
StorageLocation Pulumi.AzureNative.Network.Outputs.PacketCaptureStorageLocationResponse
The storage location for a packet capture session.
Target 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.
CaptureSettings Pulumi.AzureNative.Network.Outputs.PacketCaptureSettingsResponse
The capture setting holds the 'FileCount', 'FileSizeInBytes', 'SessionTimeLimitInSeconds' values.
ContinuousCapture bool
This continuous capture is a nullable boolean, which can hold 'null', 'true' or 'false' value. If we do not pass this parameter, it would be consider as 'null', default value is 'null'.
Filters List<Pulumi.AzureNative.Network.Outputs.PacketCaptureFilterResponse>
A list of packet capture filters.
Scope Pulumi.AzureNative.Network.Outputs.PacketCaptureMachineScopeResponse
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 string
Target type of the resource provided.
TimeLimitInSeconds int
Maximum duration of the capture session in seconds.
TotalBytesPerSession double
Maximum size of the capture output.
AzureApiVersion string
The Azure API version of the resource.
Etag string
A unique read-only string that changes whenever the resource is updated.
Id string
ID of the packet capture operation.
Name string
Name of the packet capture session.
ProvisioningState string
The provisioning state of the packet capture session.
StorageLocation PacketCaptureStorageLocationResponse
The storage location for a packet capture session.
Target 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.
CaptureSettings PacketCaptureSettingsResponse
The capture setting holds the 'FileCount', 'FileSizeInBytes', 'SessionTimeLimitInSeconds' values.
ContinuousCapture bool
This continuous capture is a nullable boolean, which can hold 'null', 'true' or 'false' value. If we do not pass this parameter, it would be consider as 'null', default value is 'null'.
Filters []PacketCaptureFilterResponse
A list of packet capture filters.
Scope PacketCaptureMachineScopeResponse
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 string
Target type of the resource provided.
TimeLimitInSeconds int
Maximum duration of the capture session in seconds.
TotalBytesPerSession float64
Maximum size of the capture output.
azureApiVersion String
The Azure API version of the resource.
etag String
A unique read-only string that changes whenever the resource is updated.
id String
ID of the packet capture operation.
name String
Name of the packet capture session.
provisioningState String
The provisioning state of the packet capture session.
storageLocation PacketCaptureStorageLocationResponse
The storage location for a packet capture session.
target 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.
captureSettings PacketCaptureSettingsResponse
The capture setting holds the 'FileCount', 'FileSizeInBytes', 'SessionTimeLimitInSeconds' values.
continuousCapture Boolean
This continuous capture is a nullable boolean, which can hold 'null', 'true' or 'false' value. If we do not pass this parameter, it would be consider as 'null', default value is 'null'.
filters List<PacketCaptureFilterResponse>
A list of packet capture filters.
scope PacketCaptureMachineScopeResponse
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 String
Target type of the resource provided.
timeLimitInSeconds Integer
Maximum duration of the capture session in seconds.
totalBytesPerSession Double
Maximum size of the capture output.
azureApiVersion string
The Azure API version of the resource.
etag string
A unique read-only string that changes whenever the resource is updated.
id string
ID of the packet capture operation.
name string
Name of the packet capture session.
provisioningState string
The provisioning state of the packet capture session.
storageLocation PacketCaptureStorageLocationResponse
The storage location for a packet capture session.
target 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.
captureSettings PacketCaptureSettingsResponse
The capture setting holds the 'FileCount', 'FileSizeInBytes', 'SessionTimeLimitInSeconds' values.
continuousCapture boolean
This continuous capture is a nullable boolean, which can hold 'null', 'true' or 'false' value. If we do not pass this parameter, it would be consider as 'null', default value is 'null'.
filters PacketCaptureFilterResponse[]
A list of packet capture filters.
scope PacketCaptureMachineScopeResponse
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 string
Target type of the resource provided.
timeLimitInSeconds number
Maximum duration of the capture session in seconds.
totalBytesPerSession number
Maximum size of the capture output.
azure_api_version str
The Azure API version of the resource.
etag str
A unique read-only string that changes whenever the resource is updated.
id str
ID of the packet capture operation.
name str
Name of the packet capture session.
provisioning_state str
The provisioning state of the packet capture session.
storage_location PacketCaptureStorageLocationResponse
The storage location for a packet capture session.
target 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.
capture_settings PacketCaptureSettingsResponse
The capture setting holds the 'FileCount', 'FileSizeInBytes', 'SessionTimeLimitInSeconds' values.
continuous_capture bool
This continuous capture is a nullable boolean, which can hold 'null', 'true' or 'false' value. If we do not pass this parameter, it would be consider as 'null', default value is 'null'.
filters Sequence[PacketCaptureFilterResponse]
A list of packet capture filters.
scope PacketCaptureMachineScopeResponse
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 str
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.
azureApiVersion String
The Azure API version of the resource.
etag String
A unique read-only string that changes whenever the resource is updated.
id String
ID of the packet capture operation.
name String
Name of the packet capture session.
provisioningState String
The provisioning state of the packet capture session.
storageLocation Property Map
The storage location for a packet capture session.
target 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.
captureSettings Property Map
The capture setting holds the 'FileCount', 'FileSizeInBytes', 'SessionTimeLimitInSeconds' values.
continuousCapture Boolean
This continuous capture is a nullable boolean, which can hold 'null', 'true' or 'false' value. If we do not pass this parameter, it would be consider as 'null', default value is 'null'.
filters List<Property Map>
A list of packet capture filters.
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 String
Target type of the resource provided.
timeLimitInSeconds Number
Maximum duration of the capture session in seconds.
totalBytesPerSession Number
Maximum size of the capture output.

Supporting Types

PacketCaptureFilterResponse

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.

PacketCaptureMachineScopeResponse

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.

PacketCaptureSettingsResponse

FileCount int
Number of file count. Default value of count is 10 and maximum number is 10000.
FileSizeInBytes double
Number of bytes captured per packet. Default value in bytes 104857600 (100MB) and maximum in bytes 4294967295 (4GB).
SessionTimeLimitInSeconds int
Maximum duration of the capture session in seconds is 604800s (7 days) for a file. Default value in second 86400s (1 day).
FileCount int
Number of file count. Default value of count is 10 and maximum number is 10000.
FileSizeInBytes float64
Number of bytes captured per packet. Default value in bytes 104857600 (100MB) and maximum in bytes 4294967295 (4GB).
SessionTimeLimitInSeconds int
Maximum duration of the capture session in seconds is 604800s (7 days) for a file. Default value in second 86400s (1 day).
fileCount Integer
Number of file count. Default value of count is 10 and maximum number is 10000.
fileSizeInBytes Double
Number of bytes captured per packet. Default value in bytes 104857600 (100MB) and maximum in bytes 4294967295 (4GB).
sessionTimeLimitInSeconds Integer
Maximum duration of the capture session in seconds is 604800s (7 days) for a file. Default value in second 86400s (1 day).
fileCount number
Number of file count. Default value of count is 10 and maximum number is 10000.
fileSizeInBytes number
Number of bytes captured per packet. Default value in bytes 104857600 (100MB) and maximum in bytes 4294967295 (4GB).
sessionTimeLimitInSeconds number
Maximum duration of the capture session in seconds is 604800s (7 days) for a file. Default value in second 86400s (1 day).
file_count int
Number of file count. Default value of count is 10 and maximum number is 10000.
file_size_in_bytes float
Number of bytes captured per packet. Default value in bytes 104857600 (100MB) and maximum in bytes 4294967295 (4GB).
session_time_limit_in_seconds int
Maximum duration of the capture session in seconds is 604800s (7 days) for a file. Default value in second 86400s (1 day).
fileCount Number
Number of file count. Default value of count is 10 and maximum number is 10000.
fileSizeInBytes Number
Number of bytes captured per packet. Default value in bytes 104857600 (100MB) and maximum in bytes 4294967295 (4GB).
sessionTimeLimitInSeconds Number
Maximum duration of the capture session in seconds is 604800s (7 days) for a file. Default value in second 86400s (1 day).

PacketCaptureStorageLocationResponse

FilePath string
This path is invalid if 'Continuous Capture' is provided with 'true' or 'false'. 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.
LocalPath string
This path is valid if 'Continuous Capture' is provided with 'true' or 'false' and required if no storage ID is provided, otherwise optional. Must include the name of the capture file (*.cap). For linux virtual machine it must start with /var/captures.
StorageId string
The ID of the storage account to save the packet capture session. Required if no localPath or filePath 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
This path is invalid if 'Continuous Capture' is provided with 'true' or 'false'. 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.
LocalPath string
This path is valid if 'Continuous Capture' is provided with 'true' or 'false' and required if no storage ID is provided, otherwise optional. Must include the name of the capture file (*.cap). For linux virtual machine it must start with /var/captures.
StorageId string
The ID of the storage account to save the packet capture session. Required if no localPath or filePath 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
This path is invalid if 'Continuous Capture' is provided with 'true' or 'false'. 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.
localPath String
This path is valid if 'Continuous Capture' is provided with 'true' or 'false' and required if no storage ID is provided, otherwise optional. Must include the name of the capture file (*.cap). For linux virtual machine it must start with /var/captures.
storageId String
The ID of the storage account to save the packet capture session. Required if no localPath or filePath 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
This path is invalid if 'Continuous Capture' is provided with 'true' or 'false'. 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.
localPath string
This path is valid if 'Continuous Capture' is provided with 'true' or 'false' and required if no storage ID is provided, otherwise optional. Must include the name of the capture file (*.cap). For linux virtual machine it must start with /var/captures.
storageId string
The ID of the storage account to save the packet capture session. Required if no localPath or filePath 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
This path is invalid if 'Continuous Capture' is provided with 'true' or 'false'. 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.
local_path str
This path is valid if 'Continuous Capture' is provided with 'true' or 'false' and required if no storage ID is provided, otherwise optional. Must include the name of the capture file (*.cap). For linux virtual machine it must start with /var/captures.
storage_id str
The ID of the storage account to save the packet capture session. Required if no localPath or filePath 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
This path is invalid if 'Continuous Capture' is provided with 'true' or 'false'. 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.
localPath String
This path is valid if 'Continuous Capture' is provided with 'true' or 'false' and required if no storage ID is provided, otherwise optional. Must include the name of the capture file (*.cap). For linux virtual machine it must start with /var/captures.
storageId String
The ID of the storage account to save the packet capture session. Required if no localPath or filePath 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.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.0.1 published on Monday, Apr 7, 2025 by Pulumi
pulumi/pulumi-azure-native