PacketCapture interface
Packet capture session resource.
- Extends
Properties
bytes |
Number of bytes captured per packet, the remaining bytes are truncated. The default "0" means the entire packet is captured. |
capture |
The start time of the packet capture session. NOTE: This property will not be serialized. It can only be populated by the server. |
network |
List of network interfaces to capture on. |
output |
The list of output files of a packet capture session. NOTE: This property will not be serialized. It can only be populated by the server. |
provisioning |
The provisioning state of the packet capture session resource. NOTE: This property will not be serialized. It can only be populated by the server. |
reason | The reason the current packet capture session state. NOTE: This property will not be serialized. It can only be populated by the server. |
status | The status of the packet capture session. NOTE: This property will not be serialized. It can only be populated by the server. |
time |
Maximum duration of the capture session in seconds. |
total |
Maximum size of the capture output. |
Inherited Properties
id | Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" NOTE: This property will not be serialized. It can only be populated by the server. |
name | The name of the resource NOTE: This property will not be serialized. It can only be populated by the server. |
system |
Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server. |
type | The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server. |
Property Details
bytesToCapturePerPacket
Number of bytes captured per packet, the remaining bytes are truncated. The default "0" means the entire packet is captured.
bytesToCapturePerPacket?: number
Property Value
number
captureStartTime
The start time of the packet capture session. NOTE: This property will not be serialized. It can only be populated by the server.
captureStartTime?: Date
Property Value
Date
networkInterfaces
List of network interfaces to capture on.
networkInterfaces?: string[]
Property Value
string[]
outputFiles
The list of output files of a packet capture session. NOTE: This property will not be serialized. It can only be populated by the server.
outputFiles?: string[]
Property Value
string[]
provisioningState
The provisioning state of the packet capture session resource. NOTE: This property will not be serialized. It can only be populated by the server.
provisioningState?: string
Property Value
string
reason
The reason the current packet capture session state. NOTE: This property will not be serialized. It can only be populated by the server.
reason?: string
Property Value
string
status
The status of the packet capture session. NOTE: This property will not be serialized. It can only be populated by the server.
status?: string
Property Value
string
timeLimitInSeconds
Maximum duration of the capture session in seconds.
timeLimitInSeconds?: number
Property Value
number
totalBytesPerSession
Maximum size of the capture output.
totalBytesPerSession?: number
Property Value
number
Inherited Property Details
id
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" NOTE: This property will not be serialized. It can only be populated by the server.
id?: string
Property Value
string
Inherited From ProxyResource.id
name
The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
name?: string
Property Value
string
Inherited From ProxyResource.name
systemData
Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.
systemData?: SystemData
Property Value
Inherited From ProxyResource.systemData
type
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.
type?: string
Property Value
string
Inherited From ProxyResource.type