FlowLog Class
A flow log resource.
Variables are only populated by the server, and will be ignored when sending a request.
Constructor
FlowLog(*, id: str | None = None, location: str | None = None, tags: dict[str, str] | None = None, identity: _models.ManagedServiceIdentity | None = None, target_resource_id: str | None = None, storage_id: str | None = None, enabled_filtering_criteria: str | None = None, record_types: str | None = None, enabled: bool | None = None, retention_policy: _models.RetentionPolicyParameters | None = None, format: _models.FlowLogFormatParameters | None = None, flow_analytics_configuration: _models.TrafficAnalyticsProperties | None = None, **kwargs: Any)Keyword-Only Parameters
| Name | Description |
|---|---|
|
id
|
Resource ID. Default value: None
|
|
location
|
Resource location. Default value: None
|
|
tags
|
Resource tags. Default value: None
|
|
identity
|
FlowLog resource Managed Identity. Default value: None
|
|
target_resource_id
|
ID of network security group to which flow log will be applied. Default value: None
|
|
storage_id
|
ID of the storage account which is used to store the flow log. Default value: 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. Default value: 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. Default value: None
|
|
enabled
|
Flag to enable/disable flow logging. Default value: None
|
|
retention_policy
|
Parameters that define the retention policy for flow log. Default value: None
|
|
format
|
Parameters that define the flow log format. Default value: None
|
|
flow_analytics_configuration
|
Parameters that define the configuration of traffic analytics. Default value: None
|
Variables
| Name | Description |
|---|---|
|
id
|
Resource ID. |
|
name
|
Resource name. |
|
type
|
Resource type. |
|
location
|
Resource location. |
|
tags
|
Resource tags. |
|
etag
|
A unique read-only string that changes whenever the resource is updated. |
|
identity
|
FlowLog resource Managed Identity. |
|
target_resource_id
|
ID of network security group to which flow log will be applied. |
|
target_resource_guid
|
Guid of network security group to which flow log will be applied. |
|
storage_id
|
ID of the storage account which is used to store the flow log. |
|
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. |
|
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. |
|
enabled
|
Flag to enable/disable flow logging. |
|
retention_policy
|
Parameters that define the retention policy for flow log. |
|
format
|
Parameters that define the flow log format. |
|
flow_analytics_configuration
|
Parameters that define the configuration of traffic analytics. |
|
provisioning_state
|
The provisioning state of the flow log. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". |
