Share via

FlowLog interface

  • Reference
Package:
@azure/arm-network

A flow log resource.

Extends
Resource

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. NOTE: This property will not be serialized. It can only be populated by the server.
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. NOTE: This property will not be serialized. It can only be populated by the server.
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. NOTE: This property will not be serialized. It can only be populated by the server.
targetResourceId

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

Inherited Properties

id

Resource ID.
location

Resource location.
name

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.
tags

Resource tags.
type

Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

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. NOTE: This property will not be serialized. It can only be populated by the server.

etag?: string

Property Value

string

flowAnalyticsConfiguration

Parameters that define the configuration of traffic analytics.

flowAnalyticsConfiguration?: TrafficAnalyticsProperties

Property Value

TrafficAnalyticsProperties

format

Parameters that define the flow log format.

format?: FlowLogFormatParameters

Property Value

FlowLogFormatParameters

identity

FlowLog resource Managed Identity

identity?: ManagedServiceIdentity

Property Value

ManagedServiceIdentity

provisioningState

The provisioning state of the flow log. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

retentionPolicy

Parameters that define the retention policy for flow log.

retentionPolicy?: RetentionPolicyParameters

Property Value

RetentionPolicyParameters

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. NOTE: This property will not be serialized. It can only be populated by the server.

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. NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From Resource.name

tags

Resource tags.

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

Inherited From Resource.tags

type

Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From Resource.type