ARM template resource definition
The networkWatchers/flowLogs resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log.
To create a Microsoft.Network/networkWatchers/flowLogs resource, add the following JSON to your template.
{
"type": "Microsoft.Network/networkWatchers/flowLogs",
"apiVersion": "2023-04-01",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"properties": {
"enabled": "bool",
"flowAnalyticsConfiguration": {
"networkWatcherFlowAnalyticsConfiguration": {
"enabled": "bool",
"trafficAnalyticsInterval": "int",
"workspaceId": "string",
"workspaceRegion": "string",
"workspaceResourceId": "string"
}
},
"format": {
"type": "JSON",
"version": "int"
},
"retentionPolicy": {
"days": "int",
"enabled": "bool"
},
"storageId": "string",
"targetResourceId": "string"
}
}
Property values
networkWatchers/flowLogs
Name |
Description |
Value |
type |
The resource type |
'Microsoft.Network/networkWatchers/flowLogs' |
apiVersion |
The resource api version |
'2023-04-01' |
name |
The resource name
See how to set names and types for child resources in JSON ARM templates. |
string (required) |
location |
Resource location. |
string |
tags |
Resource tags. |
Dictionary of tag names and values. See Tags in templates |
properties |
Properties of the flow log. |
FlowLogPropertiesFormat |
Name |
Description |
Value |
enabled |
Flag to enable/disable flow logging. |
bool |
flowAnalyticsConfiguration |
Parameters that define the configuration of traffic analytics. |
TrafficAnalyticsProperties |
format |
Parameters that define the flow log format. |
FlowLogFormatParameters |
retentionPolicy |
Parameters that define the retention policy for flow log. |
RetentionPolicyParameters |
storageId |
ID of the storage account which is used to store the flow log. |
string (required) |
targetResourceId |
ID of network security group to which flow log will be applied. |
string (required) |
TrafficAnalyticsProperties
TrafficAnalyticsConfigurationProperties
Name |
Description |
Value |
enabled |
Flag to enable/disable traffic analytics. |
bool |
trafficAnalyticsInterval |
The interval in minutes which would decide how frequently TA service should do flow analytics. |
int |
workspaceId |
The resource guid of the attached workspace. |
string |
workspaceRegion |
The location of the attached workspace. |
string |
workspaceResourceId |
Resource Id of the attached workspace. |
string |
Name |
Description |
Value |
type |
The file type of flow log. |
'JSON' |
version |
The version (revision) of the flow log. |
int |
RetentionPolicyParameters
Name |
Description |
Value |
days |
Number of days to retain flow log records. |
int |
enabled |
Flag to enable/disable retention. |
bool |
Quickstart templates
The following quickstart templates deploy this resource type.