Docs Home Pulumi IaC Pulumi ESC 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 v1 docs if using the v1 version of this package.
Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.network.getPacketCapture

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi
pulumi/pulumi-azure-native

    Gets a packet capture session by name. Azure REST API version: 2023-02-01.

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

    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>
    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]
    func LookupPacketCapture(ctx *Context, args *LookupPacketCaptureArgs, opts ...InvokeOption) (*LookupPacketCaptureResult, error)
func LookupPacketCaptureOutput(ctx *Context, args *LookupPacketCaptureOutputArgs, opts ...InvokeOption) LookupPacketCaptureResultOutput

    > 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)
}
    public static CompletableFuture<GetPacketCaptureResult> getPacketCapture(GetPacketCaptureArgs args, InvokeOptions options)
public static Output<GetPacketCaptureResult> getPacketCapture(GetPacketCaptureArgs args, InvokeOptions options)

    fn::invoke:
  function: azure-native:network:getPacketCapture
  arguments:
    # arguments dictionary

    The following arguments are supported:

    NetworkWatcherName string
    The name of the network watcher.
    PacketCaptureName string
    The name of the packet capture session.
    ResourceGroupName string
    The name of the resource group.
    NetworkWatcherName string
    The name of the network watcher.
    PacketCaptureName string
    The name of the packet capture session.
    ResourceGroupName string
    The name of the resource group.
    networkWatcherName String
    The name of the network watcher.
    packetCaptureName String
    The name of the packet capture session.
    resourceGroupName String
    The name of the resource group.
    networkWatcherName string
    The name of the network watcher.
    packetCaptureName string
    The name of the packet capture session.
    resourceGroupName string
    The name of the resource group.
    network_watcher_name str
    The name of the network watcher.
    packet_capture_name str
    The name of the packet capture session.
    resource_group_name str
    The name of the resource group.
    networkWatcherName String
    The name of the network watcher.
    packetCaptureName String
    The name of the packet capture session.
    resourceGroupName String
    The name of the resource group.

    getPacketCapture Result

    The following output properties are available:

    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.
    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.
    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.
    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.
    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.
    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.
    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.
    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.
    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.
    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.
    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.
    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.

    PacketCaptureStorageLocationResponse

    FilePath string
    A valid local path on the targeting VM. Must include the name of the capture file (*.cap). For linux virtual machine it must start with /var/captures. Required if no storage ID is provided, otherwise optional.
    StorageId string
    The ID of the storage account to save the packet capture session. Required if no local file path is provided.
    StoragePath string
    The URI of the storage path to save the packet capture. Must be a well-formed URI describing the location to save the packet capture.
    FilePath string
    A valid local path on the targeting VM. Must include the name of the capture file (*.cap). For linux virtual machine it must start with /var/captures. Required if no storage ID is provided, otherwise optional.
    StorageId string
    The ID of the storage account to save the packet capture session. Required if no local file path is provided.
    StoragePath string
    The URI of the storage path to save the packet capture. Must be a well-formed URI describing the location to save the packet capture.
    filePath String
    A valid local path on the targeting VM. Must include the name of the capture file (*.cap). For linux virtual machine it must start with /var/captures. Required if no storage ID is provided, otherwise optional.
    storageId String
    The ID of the storage account to save the packet capture session. Required if no local file path is provided.
    storagePath String
    The URI of the storage path to save the packet capture. Must be a well-formed URI describing the location to save the packet capture.
    filePath string
    A valid local path on the targeting VM. Must include the name of the capture file (*.cap). For linux virtual machine it must start with /var/captures. Required if no storage ID is provided, otherwise optional.
    storageId string
    The ID of the storage account to save the packet capture session. Required if no local file path is provided.
    storagePath string
    The URI of the storage path to save the packet capture. Must be a well-formed URI describing the location to save the packet capture.
    file_path str
    A valid local path on the targeting VM. Must include the name of the capture file (*.cap). For linux virtual machine it must start with /var/captures. Required if no storage ID is provided, otherwise optional.
    storage_id str
    The ID of the storage account to save the packet capture session. Required if no local file path is provided.
    storage_path str
    The URI of the storage path to save the packet capture. Must be a well-formed URI describing the location to save the packet capture.
    filePath String
    A valid local path on the targeting VM. Must include the name of the capture file (*.cap). For linux virtual machine it must start with /var/captures. Required if no storage ID is provided, otherwise optional.
    storageId String
    The ID of the storage account to save the packet capture session. Required if no local file path is provided.
    storagePath String
    The URI of the storage path to save the packet capture. Must be a well-formed URI describing the location to save the packet capture.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi
    pulumi/pulumi-azure-native