FlowLogPropertiesFormat Class

Package:
com.azure.resourcemanager.network.fluent.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-network:2.59.0
  • java.lang.Object
    • com.azure.resourcemanager.network.fluent.models.FlowLogPropertiesFormat

Implements

JsonSerializable<FlowLogPropertiesFormat>

public final class FlowLogPropertiesFormat
implements JsonSerializable<FlowLogPropertiesFormat>

Parameters that define the configuration of flow log.

Constructor Summary

Constructor Description
FlowLogPropertiesFormat()

Creates an instance of FlowLogPropertiesFormat class.

Method Summary

Modifier and Type Method and Description
Boolean enabled()

Get the enabled property: Flag to enable/disable flow logging.
String enabledFilteringCriteria()

Get the enabledFilteringCriteria property: Optional field to filter network traffic logs based on SrcIP, SrcPort, DstIP, DstPort, Protocol, Encryption, Direction and Action.
TrafficAnalyticsProperties flowAnalyticsConfiguration()

Get the flowAnalyticsConfiguration property: Parameters that define the configuration of traffic analytics.
FlowLogFormatParameters format()

Get the format property: Parameters that define the flow log format.
static FlowLogPropertiesFormat fromJson(JsonReader jsonReader)

Reads an instance of FlowLogPropertiesFormat from the JsonReader.
ProvisioningState provisioningState()

Get the provisioningState property: The provisioning state of the flow log.
String recordTypes()

Get the recordTypes property: Optional field to filter network traffic logs based on flow states.
RetentionPolicyParameters retentionPolicy()

Get the retentionPolicy property: Parameters that define the retention policy for flow log.
String storageId()

Get the storageId property: ID of the storage account which is used to store the flow log.
String targetResourceGuid()

Get the targetResourceGuid property: Guid of network security group to which flow log will be applied.
String targetResourceId()

Get the targetResourceId property: ID of network security group to which flow log will be applied.
JsonWriter toJson(JsonWriter jsonWriter)
void validate()

Validates the instance.
FlowLogPropertiesFormat withEnabled(Boolean enabled)

Set the enabled property: Flag to enable/disable flow logging.
FlowLogPropertiesFormat withEnabledFilteringCriteria(String enabledFilteringCriteria)

Set the enabledFilteringCriteria property: Optional field to filter network traffic logs based on SrcIP, SrcPort, DstIP, DstPort, Protocol, Encryption, Direction and Action.
FlowLogPropertiesFormat withFlowAnalyticsConfiguration(TrafficAnalyticsProperties flowAnalyticsConfiguration)

Set the flowAnalyticsConfiguration property: Parameters that define the configuration of traffic analytics.
FlowLogPropertiesFormat withFormat(FlowLogFormatParameters format)

Set the format property: Parameters that define the flow log format.
FlowLogPropertiesFormat withRecordTypes(String recordTypes)

Set the recordTypes property: Optional field to filter network traffic logs based on flow states.
FlowLogPropertiesFormat withRetentionPolicy(RetentionPolicyParameters retentionPolicy)

Set the retentionPolicy property: Parameters that define the retention policy for flow log.
FlowLogPropertiesFormat withStorageId(String storageId)

Set the storageId property: ID of the storage account which is used to store the flow log.
FlowLogPropertiesFormat withTargetResourceId(String targetResourceId)

Set the targetResourceId property: ID of network security group to which flow log will be applied.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

FlowLogPropertiesFormat

public FlowLogPropertiesFormat()

Creates an instance of FlowLogPropertiesFormat class.

Method Details

enabled

public Boolean enabled()

Get the enabled property: Flag to enable/disable flow logging.

Returns:

the enabled value.

enabledFilteringCriteria

public String enabledFilteringCriteria()

Get the enabledFilteringCriteria property: 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.

Returns:

the enabledFilteringCriteria value.

flowAnalyticsConfiguration

public TrafficAnalyticsProperties flowAnalyticsConfiguration()

Get the flowAnalyticsConfiguration property: Parameters that define the configuration of traffic analytics.

Returns:

the flowAnalyticsConfiguration value.

format

public FlowLogFormatParameters format()

Get the format property: Parameters that define the flow log format.

Returns:

the format value.

fromJson

public static FlowLogPropertiesFormat fromJson(JsonReader jsonReader)

Reads an instance of FlowLogPropertiesFormat from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of FlowLogPropertiesFormat if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

 - If the deserialized JSON object was missing any required properties.

provisioningState

public ProvisioningState provisioningState()

Get the provisioningState property: The provisioning state of the flow log.

Returns:

the provisioningState value.

recordTypes

public String recordTypes()

Get the recordTypes property: 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.

Returns:

the recordTypes value.

retentionPolicy

public RetentionPolicyParameters retentionPolicy()

Get the retentionPolicy property: Parameters that define the retention policy for flow log.

Returns:

the retentionPolicy value.

storageId

public String storageId()

Get the storageId property: ID of the storage account which is used to store the flow log.

Returns:

the storageId value.

targetResourceGuid

public String targetResourceGuid()

Get the targetResourceGuid property: Guid of network security group to which flow log will be applied.

Returns:

the targetResourceGuid value.

targetResourceId

public String targetResourceId()

Get the targetResourceId property: ID of network security group to which flow log will be applied.

Returns:

the targetResourceId value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

validate

public void validate()

Validates the instance.

withEnabled

public FlowLogPropertiesFormat withEnabled(Boolean enabled)

Set the enabled property: Flag to enable/disable flow logging.

Parameters:

enabled - the enabled value to set.

Returns:

the FlowLogPropertiesFormat object itself.

withEnabledFilteringCriteria

public FlowLogPropertiesFormat withEnabledFilteringCriteria(String enabledFilteringCriteria)

Set the enabledFilteringCriteria property: 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.

Parameters:

enabledFilteringCriteria - the enabledFilteringCriteria value to set.

Returns:

the FlowLogPropertiesFormat object itself.

withFlowAnalyticsConfiguration

public FlowLogPropertiesFormat withFlowAnalyticsConfiguration(TrafficAnalyticsProperties flowAnalyticsConfiguration)

Set the flowAnalyticsConfiguration property: Parameters that define the configuration of traffic analytics.

Parameters:

flowAnalyticsConfiguration - the flowAnalyticsConfiguration value to set.

Returns:

the FlowLogPropertiesFormat object itself.

withFormat

public FlowLogPropertiesFormat withFormat(FlowLogFormatParameters format)

Set the format property: Parameters that define the flow log format.

Parameters:

format - the format value to set.

Returns:

the FlowLogPropertiesFormat object itself.

withRecordTypes

public FlowLogPropertiesFormat withRecordTypes(String recordTypes)

Set the recordTypes property: 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.

Parameters:

recordTypes - the recordTypes value to set.

Returns:

the FlowLogPropertiesFormat object itself.

withRetentionPolicy

public FlowLogPropertiesFormat withRetentionPolicy(RetentionPolicyParameters retentionPolicy)

Set the retentionPolicy property: Parameters that define the retention policy for flow log.

Parameters:

retentionPolicy - the retentionPolicy value to set.

Returns:

the FlowLogPropertiesFormat object itself.

withStorageId

public FlowLogPropertiesFormat withStorageId(String storageId)

Set the storageId property: ID of the storage account which is used to store the flow log.

Parameters:

storageId - the storageId value to set.

Returns:

the FlowLogPropertiesFormat object itself.

withTargetResourceId

public FlowLogPropertiesFormat withTargetResourceId(String targetResourceId)

Set the targetResourceId property: ID of network security group to which flow log will be applied.

Parameters:

targetResourceId - the targetResourceId value to set.

Returns:

the FlowLogPropertiesFormat object itself.

Applies to