@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 6.82 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
import * as enums from "../types/enums";
/**
* Information about packet capture session.
*
* Uses Azure REST API version 2024-05-01. In version 2.x of the Azure Native provider, it used API version 2023-02-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, 2024-07-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](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare class PacketCapture extends pulumi.CustomResource {
/**
* Get an existing PacketCapture resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): PacketCapture;
/**
* Returns true if the given object is an instance of PacketCapture. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is PacketCapture;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: pulumi.Output<string>;
/**
* Number of bytes captured per packet, the remaining bytes are truncated.
*/
readonly bytesToCapturePerPacket: pulumi.Output<number | undefined>;
/**
* The capture setting holds the 'FileCount', 'FileSizeInBytes', 'SessionTimeLimitInSeconds' values.
*/
readonly captureSettings: pulumi.Output<outputs.network.PacketCaptureSettingsResponse | undefined>;
/**
* 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'.
*/
readonly continuousCapture: pulumi.Output<boolean | undefined>;
/**
* A unique read-only string that changes whenever the resource is updated.
*/
readonly etag: pulumi.Output<string>;
/**
* A list of packet capture filters.
*/
readonly filters: pulumi.Output<outputs.network.PacketCaptureFilterResponse[] | undefined>;
/**
* Name of the packet capture session.
*/
readonly name: pulumi.Output<string>;
/**
* The provisioning state of the packet capture session.
*/
readonly provisioningState: pulumi.Output<string>;
/**
* 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.
*/
readonly scope: pulumi.Output<outputs.network.PacketCaptureMachineScopeResponse | undefined>;
/**
* The storage location for a packet capture session.
*/
readonly storageLocation: pulumi.Output<outputs.network.PacketCaptureStorageLocationResponse>;
/**
* The ID of the targeted resource, only AzureVM and AzureVMSS as target type are currently supported.
*/
readonly target: pulumi.Output<string>;
/**
* Target type of the resource provided.
*/
readonly targetType: pulumi.Output<string | undefined>;
/**
* Maximum duration of the capture session in seconds.
*/
readonly timeLimitInSeconds: pulumi.Output<number | undefined>;
/**
* Maximum size of the capture output.
*/
readonly totalBytesPerSession: pulumi.Output<number | undefined>;
/**
* Create a PacketCapture resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: PacketCaptureArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a PacketCapture resource.
*/
export interface PacketCaptureArgs {
/**
* Number of bytes captured per packet, the remaining bytes are truncated.
*/
bytesToCapturePerPacket?: pulumi.Input<number>;
/**
* The capture setting holds the 'FileCount', 'FileSizeInBytes', 'SessionTimeLimitInSeconds' values.
*/
captureSettings?: pulumi.Input<inputs.network.PacketCaptureSettingsArgs>;
/**
* 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'.
*/
continuousCapture?: pulumi.Input<boolean>;
/**
* A list of packet capture filters.
*/
filters?: pulumi.Input<pulumi.Input<inputs.network.PacketCaptureFilterArgs>[]>;
/**
* The name of the network watcher.
*/
networkWatcherName: pulumi.Input<string>;
/**
* The name of the packet capture session.
*/
packetCaptureName?: pulumi.Input<string>;
/**
* The name of the resource group.
*/
resourceGroupName: pulumi.Input<string>;
/**
* 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.
*/
scope?: pulumi.Input<inputs.network.PacketCaptureMachineScopeArgs>;
/**
* The storage location for a packet capture session.
*/
storageLocation: pulumi.Input<inputs.network.PacketCaptureStorageLocationArgs>;
/**
* The ID of the targeted resource, only AzureVM and AzureVMSS as target type are currently supported.
*/
target: pulumi.Input<string>;
/**
* Target type of the resource provided.
*/
targetType?: pulumi.Input<enums.network.PacketCaptureTargetType>;
/**
* Maximum duration of the capture session in seconds.
*/
timeLimitInSeconds?: pulumi.Input<number>;
/**
* Maximum size of the capture output.
*/
totalBytesPerSession?: pulumi.Input<number>;
}