FlowLogInner Class

Package:

com.azure.resourcemanager.network.fluent.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-network:2.57.0

• java.lang.Object
• • com.azure.core.management.ProxyResource
  • • com.azure.core.management.Resource
    • • com.azure.resourcemanager.network.fluent.models.FlowLogInner

public final class FlowLogInner
extends Resource

A flow log resource.

Constructor Summary

Constructor	Description
FlowLogInner()	Creates an instance of FlowLogInner 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.
String	etag() Get the etag property: A unique read-only string that changes whenever the resource is updated.
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 FlowLogInner	fromJson(JsonReader jsonReader) Reads an instance of FlowLogInner from the JsonReader.
String	id() Get the id property: Resource ID.
ManagedServiceIdentity	identity() Get the identity property: FlowLog resource Managed Identity.
String	name() Get the name property: The name of the resource.
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)
String	type() Get the type property: The type of the resource.
void	validate() Validates the instance.
FlowLogInner	withEnabled(Boolean enabled) Set the enabled property: Flag to enable/disable flow logging.
FlowLogInner	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.
FlowLogInner	withFlowAnalyticsConfiguration(TrafficAnalyticsProperties flowAnalyticsConfiguration) Set the flowAnalyticsConfiguration property: Parameters that define the configuration of traffic analytics.
FlowLogInner	withFormat(FlowLogFormatParameters format) Set the format property: Parameters that define the flow log format.
FlowLogInner	withId(String id) Set the id property: Resource ID.
FlowLogInner	withIdentity(ManagedServiceIdentity identity) Set the identity property: FlowLog resource Managed Identity.
FlowLogInner	withLocation(String location)
FlowLogInner	withRecordTypes(String recordTypes) Set the recordTypes property: Optional field to filter network traffic logs based on flow states.
FlowLogInner	withRetentionPolicy(RetentionPolicyParameters retentionPolicy) Set the retentionPolicy property: Parameters that define the retention policy for flow log.
FlowLogInner	withStorageId(String storageId) Set the storageId property: ID of the storage account which is used to store the flow log.
FlowLogInner	withTags(Map<String,String> tags)
FlowLogInner	withTargetResourceId(String targetResourceId) Set the targetResourceId property: ID of network security group to which flow log will be applied.

Methods inherited from ProxyResource

id name type

Methods inherited from Resource

fromJson location tags toJson withLocation withTags

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

FlowLogInner

public FlowLogInner()

Creates an instance of FlowLogInner 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.

etag

public String etag()

Get the etag property: A unique read-only string that changes whenever the resource is updated.

Returns:

the etag 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 FlowLogInner fromJson(JsonReader jsonReader)

Reads an instance of FlowLogInner from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of FlowLogInner 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.

id

public String id()

Get the id property: Resource ID.

Overrides:

FlowLogInner.id()

Returns:

the id value.

identity

public ManagedServiceIdentity identity()

Get the identity property: FlowLog resource Managed Identity.

Returns:

the identity value.

name

public String name()

Get the name property: The name of the resource.

Overrides:

FlowLogInner.name()

Returns:

the name value.

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)

Overrides:

FlowLogInner.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

type

public String type()

Get the type property: The type of the resource.

Overrides:

FlowLogInner.type()

Returns:

the type value.

validate

public void validate()

Validates the instance.

withEnabled

public FlowLogInner withEnabled(Boolean enabled)

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

Parameters:

enabled - the enabled value to set.

Returns:

the FlowLogInner object itself.

withEnabledFilteringCriteria

public FlowLogInner 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 FlowLogInner object itself.

withFlowAnalyticsConfiguration

public FlowLogInner withFlowAnalyticsConfiguration(TrafficAnalyticsProperties flowAnalyticsConfiguration)

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

Parameters:

flowAnalyticsConfiguration - the flowAnalyticsConfiguration value to set.

Returns:

the FlowLogInner object itself.

withFormat

public FlowLogInner withFormat(FlowLogFormatParameters format)

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

Parameters:

format - the format value to set.

Returns:

the FlowLogInner object itself.

withId

public FlowLogInner withId(String id)

Set the id property: Resource ID.

Parameters:

id - the id value to set.

Returns:

the FlowLogInner object itself.

withIdentity

public FlowLogInner withIdentity(ManagedServiceIdentity identity)

Set the identity property: FlowLog resource Managed Identity.

Parameters:

identity - the identity value to set.

Returns:

the FlowLogInner object itself.

withLocation

public FlowLogInner withLocation(String location)

Overrides:

FlowLogInner.withLocation(String location)

Parameters:

location

withRecordTypes

public FlowLogInner 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 FlowLogInner object itself.

withRetentionPolicy

public FlowLogInner 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 FlowLogInner object itself.

withStorageId

public FlowLogInner 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 FlowLogInner object itself.

withTags

public FlowLogInner withTags(Map<String,String> tags)

Overrides:

FlowLogInner.withTags(Map<String,String> tags)

Parameters:

tags

withTargetResourceId

public FlowLogInner 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 FlowLogInner object itself.