FlowLog interface

A flow log resource.

Extends

Properties

enabled

Flag to enable/disable flow logging.

enabledFilteringCriteria

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.

etag

A unique read-only string that changes whenever the resource is updated.

flowAnalyticsConfiguration

Parameters that define the configuration of traffic analytics.

format

Parameters that define the flow log format.

identity

FlowLog resource Managed Identity

provisioningState

The provisioning state of the flow log.

recordTypes

Optional field to filter network traffic logs based on flow states. Value of this field could be any comma separated combination string of letters B,C,E or D. B represents Begin, when a flow is created. C represents Continue for an ongoing flow generated at every five-minute interval. E represents End, when a flow is terminated. D represents Deny, when a flow is denied. If not specified, all network traffic will be logged.

retentionPolicy

Parameters that define the retention policy for flow log.

storageId

ID of the storage account which is used to store the flow log.

targetResourceGuid

Guid of network security group to which flow log will be applied.

targetResourceId

ID of network security group to which flow log will be applied.

Inherited Properties

id

Resource ID.

location

Resource location.

name

Resource name.

tags

Resource tags.

type

Resource type.

Property Details

enabled

Flag to enable/disable flow logging.

enabled?: boolean

Property Value

boolean

enabledFilteringCriteria

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?: string

Property Value

string

etag

A unique read-only string that changes whenever the resource is updated.

etag?: string

Property Value

string

flowAnalyticsConfiguration

Parameters that define the configuration of traffic analytics.

flowAnalyticsConfiguration?: TrafficAnalyticsProperties

Property Value

format

Parameters that define the flow log format.

format?: FlowLogFormatParameters

Property Value

identity

FlowLog resource Managed Identity

identity?: ManagedServiceIdentity

Property Value

provisioningState

The provisioning state of the flow log.

provisioningState?: string

Property Value

string

recordTypes

Optional field to filter network traffic logs based on flow states. Value of this field could be any comma separated combination string of letters B,C,E or D. B represents Begin, when a flow is created. C represents Continue for an ongoing flow generated at every five-minute interval. E represents End, when a flow is terminated. D represents Deny, when a flow is denied. If not specified, all network traffic will be logged.

recordTypes?: string

Property Value

string

retentionPolicy

Parameters that define the retention policy for flow log.

retentionPolicy?: RetentionPolicyParameters

Property Value

storageId

ID of the storage account which is used to store the flow log.

storageId?: string

Property Value

string

targetResourceGuid

Guid of network security group to which flow log will be applied.

targetResourceGuid?: string

Property Value

string

targetResourceId

ID of network security group to which flow log will be applied.

targetResourceId?: string

Property Value

string

Inherited Property Details

id

Resource ID.

id?: string

Property Value

string

Inherited From Resource.id

location

Resource location.

location?: string

Property Value

string

Inherited From Resource.location

name

Resource name.

name?: string

Property Value

string

Inherited From Resource.name

tags

Resource tags.

tags?: Record<string, string>

Property Value

Record<string, string>

Inherited From Resource.tags

type

Resource type.

type?: string

Property Value

string

Inherited From Resource.type