@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 6.25 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* A flow log resource.
*
* 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: 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 FlowLog extends pulumi.CustomResource {
/**
* Get an existing FlowLog 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): FlowLog;
/**
* Returns true if the given object is an instance of FlowLog. 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 FlowLog;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: pulumi.Output<string>;
/**
* Flag to enable/disable flow logging.
*/
readonly enabled: pulumi.Output<boolean | undefined>;
/**
* Optional field to filter network traffic logs based on SrcIP, SrcPort, DstIP, DstPort, Protocol, Encryption, Direction and Action. If not specified, all network traffic will be logged.
*/
readonly enabledFilteringCriteria: pulumi.Output<string | undefined>;
/**
* A unique read-only string that changes whenever the resource is updated.
*/
readonly etag: pulumi.Output<string>;
/**
* Parameters that define the configuration of traffic analytics.
*/
readonly flowAnalyticsConfiguration: pulumi.Output<outputs.network.TrafficAnalyticsPropertiesResponse | undefined>;
/**
* Parameters that define the flow log format.
*/
readonly format: pulumi.Output<outputs.network.FlowLogFormatParametersResponse | undefined>;
/**
* FlowLog resource Managed Identity
*/
readonly identity: pulumi.Output<outputs.network.ManagedServiceIdentityResponse | undefined>;
/**
* Resource location.
*/
readonly location: pulumi.Output<string | undefined>;
/**
* Resource name.
*/
readonly name: pulumi.Output<string>;
/**
* The provisioning state of the flow log.
*/
readonly provisioningState: pulumi.Output<string>;
/**
* Parameters that define the retention policy for flow log.
*/
readonly retentionPolicy: pulumi.Output<outputs.network.RetentionPolicyParametersResponse | undefined>;
/**
* ID of the storage account which is used to store the flow log.
*/
readonly storageId: pulumi.Output<string>;
/**
* Resource tags.
*/
readonly tags: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* Guid of network security group to which flow log will be applied.
*/
readonly targetResourceGuid: pulumi.Output<string>;
/**
* ID of network security group to which flow log will be applied.
*/
readonly targetResourceId: pulumi.Output<string>;
/**
* Resource type.
*/
readonly type: pulumi.Output<string>;
/**
* Create a FlowLog 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: FlowLogArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a FlowLog resource.
*/
export interface FlowLogArgs {
/**
* Flag to enable/disable flow logging.
*/
enabled?: pulumi.Input<boolean>;
/**
* Optional field to filter network traffic logs based on SrcIP, SrcPort, DstIP, DstPort, Protocol, Encryption, Direction and Action. If not specified, all network traffic will be logged.
*/
enabledFilteringCriteria?: pulumi.Input<string>;
/**
* Parameters that define the configuration of traffic analytics.
*/
flowAnalyticsConfiguration?: pulumi.Input<inputs.network.TrafficAnalyticsPropertiesArgs>;
/**
* The name of the flow log.
*/
flowLogName?: pulumi.Input<string>;
/**
* Parameters that define the flow log format.
*/
format?: pulumi.Input<inputs.network.FlowLogFormatParametersArgs>;
/**
* Resource ID.
*/
id?: pulumi.Input<string>;
/**
* FlowLog resource Managed Identity
*/
identity?: pulumi.Input<inputs.network.ManagedServiceIdentityArgs>;
/**
* Resource location.
*/
location?: pulumi.Input<string>;
/**
* The name of the network watcher.
*/
networkWatcherName: pulumi.Input<string>;
/**
* The name of the resource group.
*/
resourceGroupName: pulumi.Input<string>;
/**
* Parameters that define the retention policy for flow log.
*/
retentionPolicy?: pulumi.Input<inputs.network.RetentionPolicyParametersArgs>;
/**
* ID of the storage account which is used to store the flow log.
*/
storageId: pulumi.Input<string>;
/**
* Resource tags.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* ID of network security group to which flow log will be applied.
*/
targetResourceId: pulumi.Input<string>;
}