FlowLogPropertiesFormat Class

Parameters that define the configuration of flow log.

Constructor

FlowLogPropertiesFormat(*args: Any, **kwargs: Any)

Variables

Name	Description
target_resource_id	str ID of network security group to which flow log will be applied. Required.
target_resource_guid	str Guid of network security group to which flow log will be applied.
storage_id	str ID of the storage account which is used to store the flow log. Required.
enabled_filtering_criteria	str 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.
record_types	str 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.
enabled	bool Flag to enable/disable flow logging.
retention_policy	RetentionPolicyParameters Parameters that define the retention policy for flow log.
format	FlowLogFormatParameters Parameters that define the flow log format.
flow_analytics_configuration	TrafficAnalyticsProperties Parameters that define the configuration of traffic analytics.
provisioning_state	str or ProvisioningState The provisioning state of the flow log. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting".

Attributes

enabled

Flag to enable/disable flow logging.

enabled: bool | None

enabled_filtering_criteria

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.

enabled_filtering_criteria: str | None

flow_analytics_configuration

Parameters that define the configuration of traffic analytics.

flow_analytics_configuration: _models.TrafficAnalyticsProperties | None

format

Parameters that define the flow log format.

format: _models.FlowLogFormatParameters | None

provisioning_state

"Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting".

provisioning_state: str | _models.ProvisioningState | None

record_types

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.

record_types: str | None

retention_policy

Parameters that define the retention policy for flow log.

retention_policy: _models.RetentionPolicyParameters | None

storage_id

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

storage_id: str

target_resource_guid

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

target_resource_guid: str | None

target_resource_id

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

target_resource_id: str