NetworkWatcherFlowLog

Manages a Network Watcher Flow Log.

Create a NetworkWatcherFlowLog Resource

new NetworkWatcherFlowLog(name: string, args: NetworkWatcherFlowLogArgs, opts?: CustomResourceOptions);

def NetworkWatcherFlowLog(resource_name, opts=None, enabled=None, network_security_group_id=None, network_watcher_name=None, resource_group_name=None, retention_policy=None, storage_account_id=None, traffic_analytics=None, version=None, __props__=None);

func NewNetworkWatcherFlowLog(ctx *Context, name string, args NetworkWatcherFlowLogArgs, opts ...ResourceOption) (*NetworkWatcherFlowLog, error)

public NetworkWatcherFlowLog(string name, NetworkWatcherFlowLogArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args NetworkWatcherFlowLogArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args NetworkWatcherFlowLogArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args NetworkWatcherFlowLogArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

NetworkWatcherFlowLog Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The NetworkWatcherFlowLog resource accepts the following input properties:

Enabled bool: Boolean flag to enable/disable traffic analytics.
NetworkSecurityGroupId string: The ID of the Network Security Group for which to enable flow logs for. Changing this forces a new resource to be created.
NetworkWatcherName string: The name of the Network Watcher. Changing this forces a new resource to be created.
ResourceGroupName string: The name of the resource group in which the Network Watcher was deployed. Changing this forces a new resource to be created.
RetentionPolicy NetworkWatcherFlowLogRetentionPolicyArgs: A retention_policy block as documented below.
StorageAccountId string: The ID of the Storage Account where flow logs are stored.
TrafficAnalytics NetworkWatcherFlowLogTrafficAnalyticsArgs: A traffic_analytics block as documented below.
Version int: The version (revision) of the flow log. Possible values are 1 and 2.

Enabled bool: Boolean flag to enable/disable traffic analytics.
NetworkSecurityGroupId string: The ID of the Network Security Group for which to enable flow logs for. Changing this forces a new resource to be created.
NetworkWatcherName string: The name of the Network Watcher. Changing this forces a new resource to be created.
ResourceGroupName string: The name of the resource group in which the Network Watcher was deployed. Changing this forces a new resource to be created.
RetentionPolicy NetworkWatcherFlowLogRetentionPolicy: A retention_policy block as documented below.
StorageAccountId string: The ID of the Storage Account where flow logs are stored.
TrafficAnalytics NetworkWatcherFlowLogTrafficAnalytics: A traffic_analytics block as documented below.
Version int: The version (revision) of the flow log. Possible values are 1 and 2.

enabled boolean: Boolean flag to enable/disable traffic analytics.
networkSecurityGroupId string: The ID of the Network Security Group for which to enable flow logs for. Changing this forces a new resource to be created.
networkWatcherName string: The name of the Network Watcher. Changing this forces a new resource to be created.
resourceGroupName string: The name of the resource group in which the Network Watcher was deployed. Changing this forces a new resource to be created.
retentionPolicy NetworkWatcherFlowLogRetentionPolicy: A retention_policy block as documented below.
storageAccountId string: The ID of the Storage Account where flow logs are stored.
trafficAnalytics NetworkWatcherFlowLogTrafficAnalytics: A traffic_analytics block as documented below.
version number: The version (revision) of the flow log. Possible values are 1 and 2.

enabled bool: Boolean flag to enable/disable traffic analytics.
network_security_group_id str: The ID of the Network Security Group for which to enable flow logs for. Changing this forces a new resource to be created.
network_watcher_name str: The name of the Network Watcher. Changing this forces a new resource to be created.
resource_group_name str: The name of the resource group in which the Network Watcher was deployed. Changing this forces a new resource to be created.
retention_policy Dict[NetworkWatcherFlowLogRetentionPolicy]: A retention_policy block as documented below.
storage_account_id str: The ID of the Storage Account where flow logs are stored.
traffic_analytics Dict[NetworkWatcherFlowLogTrafficAnalytics]: A traffic_analytics block as documented below.
version float: The version (revision) of the flow log. Possible values are 1 and 2.

Outputs

All input properties are implicitly available as output properties. Additionally, the NetworkWatcherFlowLog resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

Look up an Existing NetworkWatcherFlowLog Resource

Get an existing NetworkWatcherFlowLog resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: NetworkWatcherFlowLogState, opts?: CustomResourceOptions): NetworkWatcherFlowLog

static get(resource_name, id, opts=None, enabled=None, network_security_group_id=None, network_watcher_name=None, resource_group_name=None, retention_policy=None, storage_account_id=None, traffic_analytics=None, version=None, __props__=None);

func GetNetworkWatcherFlowLog(ctx *Context, name string, id IDInput, state *NetworkWatcherFlowLogState, opts ...ResourceOption) (*NetworkWatcherFlowLog, error)

public static NetworkWatcherFlowLog Get(string name, Input<string> id, NetworkWatcherFlowLogState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

Enabled bool: Boolean flag to enable/disable traffic analytics.
NetworkSecurityGroupId string: The ID of the Network Security Group for which to enable flow logs for. Changing this forces a new resource to be created.
NetworkWatcherName string: The name of the Network Watcher. Changing this forces a new resource to be created.
ResourceGroupName string: The name of the resource group in which the Network Watcher was deployed. Changing this forces a new resource to be created.
RetentionPolicy NetworkWatcherFlowLogRetentionPolicyArgs: A retention_policy block as documented below.
StorageAccountId string: The ID of the Storage Account where flow logs are stored.
TrafficAnalytics NetworkWatcherFlowLogTrafficAnalyticsArgs: A traffic_analytics block as documented below.
Version int: The version (revision) of the flow log. Possible values are 1 and 2.

Enabled bool: Boolean flag to enable/disable traffic analytics.
NetworkSecurityGroupId string: The ID of the Network Security Group for which to enable flow logs for. Changing this forces a new resource to be created.
NetworkWatcherName string: The name of the Network Watcher. Changing this forces a new resource to be created.
ResourceGroupName string: The name of the resource group in which the Network Watcher was deployed. Changing this forces a new resource to be created.
RetentionPolicy NetworkWatcherFlowLogRetentionPolicy: A retention_policy block as documented below.
StorageAccountId string: The ID of the Storage Account where flow logs are stored.
TrafficAnalytics NetworkWatcherFlowLogTrafficAnalytics: A traffic_analytics block as documented below.
Version int: The version (revision) of the flow log. Possible values are 1 and 2.

enabled boolean: Boolean flag to enable/disable traffic analytics.
networkSecurityGroupId string: The ID of the Network Security Group for which to enable flow logs for. Changing this forces a new resource to be created.
networkWatcherName string: The name of the Network Watcher. Changing this forces a new resource to be created.
resourceGroupName string: The name of the resource group in which the Network Watcher was deployed. Changing this forces a new resource to be created.
retentionPolicy NetworkWatcherFlowLogRetentionPolicy: A retention_policy block as documented below.
storageAccountId string: The ID of the Storage Account where flow logs are stored.
trafficAnalytics NetworkWatcherFlowLogTrafficAnalytics: A traffic_analytics block as documented below.
version number: The version (revision) of the flow log. Possible values are 1 and 2.

enabled bool: Boolean flag to enable/disable traffic analytics.
network_security_group_id str: The ID of the Network Security Group for which to enable flow logs for. Changing this forces a new resource to be created.
network_watcher_name str: The name of the Network Watcher. Changing this forces a new resource to be created.
resource_group_name str: The name of the resource group in which the Network Watcher was deployed. Changing this forces a new resource to be created.
retention_policy Dict[NetworkWatcherFlowLogRetentionPolicy]: A retention_policy block as documented below.
storage_account_id str: The ID of the Storage Account where flow logs are stored.
traffic_analytics Dict[NetworkWatcherFlowLogTrafficAnalytics]: A traffic_analytics block as documented below.
version float: The version (revision) of the flow log. Possible values are 1 and 2.

Supporting Types

NetworkWatcherFlowLogRetentionPolicy

See the input and output API doc for this type.

Days int: The number of days to retain flow log records.
Enabled bool: Boolean flag to enable/disable traffic analytics.

Days int: The number of days to retain flow log records.
Enabled bool: Boolean flag to enable/disable traffic analytics.

days number: The number of days to retain flow log records.
enabled boolean: Boolean flag to enable/disable traffic analytics.

days float: The number of days to retain flow log records.
enabled bool: Boolean flag to enable/disable traffic analytics.

NetworkWatcherFlowLogTrafficAnalytics

See the input and output API doc for this type.

Enabled bool: Boolean flag to enable/disable traffic analytics.
WorkspaceId string: The resource guid of the attached workspace.
WorkspaceRegion string: The location of the attached workspace.
WorkspaceResourceId string: The resource ID of the attached workspace.
IntervalInMinutes int: How frequently service should do flow analytics in minutes.

Enabled bool: Boolean flag to enable/disable traffic analytics.
WorkspaceId string: The resource guid of the attached workspace.
WorkspaceRegion string: The location of the attached workspace.
WorkspaceResourceId string: The resource ID of the attached workspace.
IntervalInMinutes int: How frequently service should do flow analytics in minutes.

enabled boolean: Boolean flag to enable/disable traffic analytics.
workspaceId string: The resource guid of the attached workspace.
workspaceRegion string: The location of the attached workspace.
workspaceResourceId string: The resource ID of the attached workspace.
intervalInMinutes number: How frequently service should do flow analytics in minutes.

enabled bool: Boolean flag to enable/disable traffic analytics.
workspaceRegion str: The location of the attached workspace.
workspace_id str: The resource guid of the attached workspace.
workspace_resource_id str: The resource ID of the attached workspace.
intervalInMinutes float: How frequently service should do flow analytics in minutes.

Package Details

Repository: https://github.com/pulumi/pulumi-azure
License: Apache-2.0
Notes: This Pulumi package is based on the azurerm Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud