@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 4.96 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* 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, 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 function getPacketCapture(args: GetPacketCaptureArgs, opts?: pulumi.InvokeOptions): Promise<GetPacketCaptureResult>;
export interface GetPacketCaptureArgs {
/**
* The name of the network watcher.
*/
networkWatcherName: string;
/**
* The name of the packet capture session.
*/
packetCaptureName: string;
/**
* The name of the resource group.
*/
resourceGroupName: string;
}
/**
* Information about packet capture session.
*/
export interface GetPacketCaptureResult {
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: string;
/**
* Number of bytes captured per packet, the remaining bytes are truncated.
*/
readonly bytesToCapturePerPacket?: number;
/**
* The capture setting holds the 'FileCount', 'FileSizeInBytes', 'SessionTimeLimitInSeconds' values.
*/
readonly captureSettings?: outputs.network.PacketCaptureSettingsResponse;
/**
* 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?: boolean;
/**
* A unique read-only string that changes whenever the resource is updated.
*/
readonly etag: string;
/**
* A list of packet capture filters.
*/
readonly filters?: outputs.network.PacketCaptureFilterResponse[];
/**
* ID of the packet capture operation.
*/
readonly id: string;
/**
* Name of the packet capture session.
*/
readonly name: string;
/**
* The provisioning state of the packet capture session.
*/
readonly provisioningState: 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?: outputs.network.PacketCaptureMachineScopeResponse;
/**
* The storage location for a packet capture session.
*/
readonly storageLocation: outputs.network.PacketCaptureStorageLocationResponse;
/**
* The ID of the targeted resource, only AzureVM and AzureVMSS as target type are currently supported.
*/
readonly target: string;
/**
* Target type of the resource provided.
*/
readonly targetType?: string;
/**
* Maximum duration of the capture session in seconds.
*/
readonly timeLimitInSeconds?: number;
/**
* Maximum size of the capture output.
*/
readonly totalBytesPerSession?: number;
}
/**
* 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, 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 function getPacketCaptureOutput(args: GetPacketCaptureOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetPacketCaptureResult>;
export interface GetPacketCaptureOutputArgs {
/**
* 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>;
}