azure-native.network.getPacketCapture
Gets a packet capture session by name. API Version: 2020-11-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)
// Output-based functions aren't available in Java yet
fn::invoke:
function: azure-native:network:getPacketCapture
arguments:
# arguments dictionary
The following arguments are supported:
- Network
Watcher stringName The name of the network watcher.
- Packet
Capture stringName The name of the packet capture session.
- Resource
Group stringName The name of the resource group.
- Network
Watcher stringName The name of the network watcher.
- Packet
Capture stringName The name of the packet capture session.
- Resource
Group stringName The name of the resource group.
- network
Watcher StringName The name of the network watcher.
- packet
Capture StringName The name of the packet capture session.
- resource
Group StringName The name of the resource group.
- network
Watcher stringName The name of the network watcher.
- packet
Capture stringName The name of the packet capture session.
- resource
Group stringName The name of the resource group.
- network_
watcher_ strname The name of the network watcher.
- packet_
capture_ strname The name of the packet capture session.
- resource_
group_ strname The name of the resource group.
- network
Watcher StringName The name of the network watcher.
- packet
Capture StringName The name of the packet capture session.
- resource
Group StringName 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.
- Provisioning
State string The provisioning state of the packet capture session.
- Storage
Location Pulumi.Azure Native. Network. Outputs. Packet Capture Storage Location Response The storage location for a packet capture session.
- Target string
The ID of the targeted resource, only VM is currently supported.
- Bytes
To doubleCapture Per Packet Number of bytes captured per packet, the remaining bytes are truncated.
- Filters
List<Pulumi.
Azure Native. Network. Outputs. Packet Capture Filter Response> A list of packet capture filters.
- Time
Limit intIn Seconds Maximum duration of the capture session in seconds.
- Total
Bytes doublePer Session 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.
- Provisioning
State string The provisioning state of the packet capture session.
- Storage
Location PacketCapture Storage Location Response The storage location for a packet capture session.
- Target string
The ID of the targeted resource, only VM is currently supported.
- Bytes
To float64Capture Per Packet Number of bytes captured per packet, the remaining bytes are truncated.
- Filters
[]Packet
Capture Filter Response A list of packet capture filters.
- Time
Limit intIn Seconds Maximum duration of the capture session in seconds.
- Total
Bytes float64Per Session 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.
- provisioning
State String The provisioning state of the packet capture session.
- storage
Location PacketCapture Storage Location Response The storage location for a packet capture session.
- target String
The ID of the targeted resource, only VM is currently supported.
- bytes
To DoubleCapture Per Packet Number of bytes captured per packet, the remaining bytes are truncated.
- filters
List<Packet
Capture Filter Response> A list of packet capture filters.
- time
Limit IntegerIn Seconds Maximum duration of the capture session in seconds.
- total
Bytes DoublePer Session 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.
- provisioning
State string The provisioning state of the packet capture session.
- storage
Location PacketCapture Storage Location Response The storage location for a packet capture session.
- target string
The ID of the targeted resource, only VM is currently supported.
- bytes
To numberCapture Per Packet Number of bytes captured per packet, the remaining bytes are truncated.
- filters
Packet
Capture Filter Response[] A list of packet capture filters.
- time
Limit numberIn Seconds Maximum duration of the capture session in seconds.
- total
Bytes numberPer Session 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 PacketCapture Storage Location Response The storage location for a packet capture session.
- target str
The ID of the targeted resource, only VM is currently supported.
- bytes_
to_ floatcapture_ per_ packet Number of bytes captured per packet, the remaining bytes are truncated.
- filters
Sequence[Packet
Capture Filter Response] A list of packet capture filters.
- time_
limit_ intin_ seconds Maximum duration of the capture session in seconds.
- total_
bytes_ floatper_ session 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.
- provisioning
State String The provisioning state of the packet capture session.
- storage
Location Property Map The storage location for a packet capture session.
- target String
The ID of the targeted resource, only VM is currently supported.
- bytes
To NumberCapture Per Packet Number of bytes captured per packet, the remaining bytes are truncated.
- filters List<Property Map>
A list of packet capture filters.
- time
Limit NumberIn Seconds Maximum duration of the capture session in seconds.
- total
Bytes NumberPer Session Maximum size of the capture output.
Supporting Types
PacketCaptureFilterResponse
- Local
IPAddress 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.
- Local
Port 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.
- Remote
IPAddress 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.
- Remote
Port 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
IPAddress 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.
- Local
Port 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.
- Remote
IPAddress 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.
- Remote
Port 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
IPAddress 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.
- local
Port 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.
- remote
IPAddress 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.
- remote
Port 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
IPAddress 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.
- local
Port 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.
- remote
IPAddress 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.
- remote
Port 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_ straddress 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_ straddress 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.
- local
IPAddress 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.
- local
Port 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.
- remote
IPAddress 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.
- remote
Port 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.
PacketCaptureStorageLocationResponse
- File
Path 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.
- Storage
Id string The ID of the storage account to save the packet capture session. Required if no local file path is provided.
- Storage
Path 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 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.
- Storage
Id string The ID of the storage account to save the packet capture session. Required if no local file path is provided.
- Storage
Path 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 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.
- storage
Id String The ID of the storage account to save the packet capture session. Required if no local file path is provided.
- storage
Path 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 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.
- storage
Id string The ID of the storage account to save the packet capture session. Required if no local file path is provided.
- storage
Path 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.
- file
Path 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.
- storage
Id String The ID of the storage account to save the packet capture session. Required if no local file path is provided.
- storage
Path 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