Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. network
  5. getFlowLog
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.network.getFlowLog

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

Gets a flow log resource by name.

Uses Azure REST API version 2024-05-01.

Other available API versions: 2019-11-01, 2019-12-01, 2020-03-01, 2020-04-01, 2020-05-01, 2020-06-01, 2020-07-01, 2020-08-01, 2020-11-01, 2021-02-01, 2021-03-01, 2021-05-01, 2021-08-01, 2022-01-01, 2022-05-01, 2022-07-01, 2022-09-01, 2022-11-01, 2023-02-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native network [ApiVersion]. See the version guide for details.

Using getFlowLog

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getFlowLog(args: GetFlowLogArgs, opts?: InvokeOptions): Promise<GetFlowLogResult>
function getFlowLogOutput(args: GetFlowLogOutputArgs, opts?: InvokeOptions): Output<GetFlowLogResult>
Copy
def get_flow_log(flow_log_name: Optional[str] = None,
                 network_watcher_name: Optional[str] = None,
                 resource_group_name: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetFlowLogResult
def get_flow_log_output(flow_log_name: Optional[pulumi.Input[str]] = None,
                 network_watcher_name: Optional[pulumi.Input[str]] = None,
                 resource_group_name: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetFlowLogResult]
Copy
func LookupFlowLog(ctx *Context, args *LookupFlowLogArgs, opts ...InvokeOption) (*LookupFlowLogResult, error)
func LookupFlowLogOutput(ctx *Context, args *LookupFlowLogOutputArgs, opts ...InvokeOption) LookupFlowLogResultOutput
Copy

> Note: This function is named LookupFlowLog in the Go SDK.

public static class GetFlowLog 
{
    public static Task<GetFlowLogResult> InvokeAsync(GetFlowLogArgs args, InvokeOptions? opts = null)
    public static Output<GetFlowLogResult> Invoke(GetFlowLogInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetFlowLogResult> getFlowLog(GetFlowLogArgs args, InvokeOptions options)
public static Output<GetFlowLogResult> getFlowLog(GetFlowLogArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:network:getFlowLog
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

FlowLogName
This property is required.
Changes to this property will trigger replacement.
string
The name of the flow log resource.
NetworkWatcherName
This property is required.
Changes to this property will trigger replacement.
string
The name of the network watcher.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
FlowLogName
This property is required.
Changes to this property will trigger replacement.
string
The name of the flow log resource.
NetworkWatcherName
This property is required.
Changes to this property will trigger replacement.
string
The name of the network watcher.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
flowLogName
This property is required.
Changes to this property will trigger replacement.
String
The name of the flow log resource.
networkWatcherName
This property is required.
Changes to this property will trigger replacement.
String
The name of the network watcher.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
flowLogName
This property is required.
Changes to this property will trigger replacement.
string
The name of the flow log resource.
networkWatcherName
This property is required.
Changes to this property will trigger replacement.
string
The name of the network watcher.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
flow_log_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the flow log resource.
network_watcher_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the network watcher.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group.
flowLogName
This property is required.
Changes to this property will trigger replacement.
String
The name of the flow log resource.
networkWatcherName
This property is required.
Changes to this property will trigger replacement.
String
The name of the network watcher.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.

getFlowLog Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
Etag string
A unique read-only string that changes whenever the resource is updated.
Name string
Resource name.
ProvisioningState string
The provisioning state of the flow log.
StorageId string
ID of the storage account which is used to store the flow log.
TargetResourceGuid string
Guid of network security group to which flow log will be applied.
TargetResourceId string
ID of network security group to which flow log will be applied.
Type string
Resource type.
Enabled bool
Flag to enable/disable flow logging.
EnabledFilteringCriteria string
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.
FlowAnalyticsConfiguration Pulumi.AzureNative.Network.Outputs.TrafficAnalyticsPropertiesResponse
Parameters that define the configuration of traffic analytics.
Format Pulumi.AzureNative.Network.Outputs.FlowLogFormatParametersResponse
Parameters that define the flow log format.
Id string
Resource ID.
Identity Pulumi.AzureNative.Network.Outputs.ManagedServiceIdentityResponse
FlowLog resource Managed Identity
Location string
Resource location.
RetentionPolicy Pulumi.AzureNative.Network.Outputs.RetentionPolicyParametersResponse
Parameters that define the retention policy for flow log.
Tags Dictionary<string, string>
Resource tags.
AzureApiVersion string
The Azure API version of the resource.
Etag string
A unique read-only string that changes whenever the resource is updated.
Name string
Resource name.
ProvisioningState string
The provisioning state of the flow log.
StorageId string
ID of the storage account which is used to store the flow log.
TargetResourceGuid string
Guid of network security group to which flow log will be applied.
TargetResourceId string
ID of network security group to which flow log will be applied.
Type string
Resource type.
Enabled bool
Flag to enable/disable flow logging.
EnabledFilteringCriteria string
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.
FlowAnalyticsConfiguration TrafficAnalyticsPropertiesResponse
Parameters that define the configuration of traffic analytics.
Format FlowLogFormatParametersResponse
Parameters that define the flow log format.
Id string
Resource ID.
Identity ManagedServiceIdentityResponse
FlowLog resource Managed Identity
Location string
Resource location.
RetentionPolicy RetentionPolicyParametersResponse
Parameters that define the retention policy for flow log.
Tags map[string]string
Resource tags.
azureApiVersion String
The Azure API version of the resource.
etag String
A unique read-only string that changes whenever the resource is updated.
name String
Resource name.
provisioningState String
The provisioning state of the flow log.
storageId String
ID of the storage account which is used to store the flow log.
targetResourceGuid String
Guid of network security group to which flow log will be applied.
targetResourceId String
ID of network security group to which flow log will be applied.
type String
Resource type.
enabled Boolean
Flag to enable/disable flow logging.
enabledFilteringCriteria String
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.
flowAnalyticsConfiguration TrafficAnalyticsPropertiesResponse
Parameters that define the configuration of traffic analytics.
format FlowLogFormatParametersResponse
Parameters that define the flow log format.
id String
Resource ID.
identity ManagedServiceIdentityResponse
FlowLog resource Managed Identity
location String
Resource location.
retentionPolicy RetentionPolicyParametersResponse
Parameters that define the retention policy for flow log.
tags Map<String,String>
Resource tags.
azureApiVersion string
The Azure API version of the resource.
etag string
A unique read-only string that changes whenever the resource is updated.
name string
Resource name.
provisioningState string
The provisioning state of the flow log.
storageId string
ID of the storage account which is used to store the flow log.
targetResourceGuid string
Guid of network security group to which flow log will be applied.
targetResourceId string
ID of network security group to which flow log will be applied.
type string
Resource type.
enabled boolean
Flag to enable/disable flow logging.
enabledFilteringCriteria string
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.
flowAnalyticsConfiguration TrafficAnalyticsPropertiesResponse
Parameters that define the configuration of traffic analytics.
format FlowLogFormatParametersResponse
Parameters that define the flow log format.
id string
Resource ID.
identity ManagedServiceIdentityResponse
FlowLog resource Managed Identity
location string
Resource location.
retentionPolicy RetentionPolicyParametersResponse
Parameters that define the retention policy for flow log.
tags {[key: string]: string}
Resource tags.
azure_api_version str
The Azure API version of the resource.
etag str
A unique read-only string that changes whenever the resource is updated.
name str
Resource name.
provisioning_state str
The provisioning state of the flow log.
storage_id str
ID of the storage account which is used to store the flow log.
target_resource_guid str
Guid of network security group to which flow log will be applied.
target_resource_id str
ID of network security group to which flow log will be applied.
type str
Resource type.
enabled bool
Flag to enable/disable flow logging.
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.
flow_analytics_configuration TrafficAnalyticsPropertiesResponse
Parameters that define the configuration of traffic analytics.
format FlowLogFormatParametersResponse
Parameters that define the flow log format.
id str
Resource ID.
identity ManagedServiceIdentityResponse
FlowLog resource Managed Identity
location str
Resource location.
retention_policy RetentionPolicyParametersResponse
Parameters that define the retention policy for flow log.
tags Mapping[str, str]
Resource tags.
azureApiVersion String
The Azure API version of the resource.
etag String
A unique read-only string that changes whenever the resource is updated.
name String
Resource name.
provisioningState String
The provisioning state of the flow log.
storageId String
ID of the storage account which is used to store the flow log.
targetResourceGuid String
Guid of network security group to which flow log will be applied.
targetResourceId String
ID of network security group to which flow log will be applied.
type String
Resource type.
enabled Boolean
Flag to enable/disable flow logging.
enabledFilteringCriteria String
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.
flowAnalyticsConfiguration Property Map
Parameters that define the configuration of traffic analytics.
format Property Map
Parameters that define the flow log format.
id String
Resource ID.
identity Property Map
FlowLog resource Managed Identity
location String
Resource location.
retentionPolicy Property Map
Parameters that define the retention policy for flow log.
tags Map<String>
Resource tags.

Supporting Types

FlowLogFormatParametersResponse

Type string
The file type of flow log.
Version int
The version (revision) of the flow log.
Type string
The file type of flow log.
Version int
The version (revision) of the flow log.
type String
The file type of flow log.
version Integer
The version (revision) of the flow log.
type string
The file type of flow log.
version number
The version (revision) of the flow log.
type str
The file type of flow log.
version int
The version (revision) of the flow log.
type String
The file type of flow log.
version Number
The version (revision) of the flow log.

ManagedServiceIdentityResponse

PrincipalId This property is required. string
The principal id of the system assigned identity. This property will only be provided for a system assigned identity.
TenantId This property is required. string
The tenant id of the system assigned identity. This property will only be provided for a system assigned identity.
Type string
The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine.
UserAssignedIdentities Dictionary<string, Pulumi.AzureNative.Network.Inputs.ManagedServiceIdentityResponseUserAssignedIdentities>
The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
PrincipalId This property is required. string
The principal id of the system assigned identity. This property will only be provided for a system assigned identity.
TenantId This property is required. string
The tenant id of the system assigned identity. This property will only be provided for a system assigned identity.
Type string
The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine.
UserAssignedIdentities map[string]ManagedServiceIdentityResponseUserAssignedIdentities
The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
principalId This property is required. String
The principal id of the system assigned identity. This property will only be provided for a system assigned identity.
tenantId This property is required. String
The tenant id of the system assigned identity. This property will only be provided for a system assigned identity.
type String
The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine.
userAssignedIdentities Map<String,ManagedServiceIdentityResponseUserAssignedIdentities>
The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
principalId This property is required. string
The principal id of the system assigned identity. This property will only be provided for a system assigned identity.
tenantId This property is required. string
The tenant id of the system assigned identity. This property will only be provided for a system assigned identity.
type string
The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine.
userAssignedIdentities {[key: string]: ManagedServiceIdentityResponseUserAssignedIdentities}
The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
principal_id This property is required. str
The principal id of the system assigned identity. This property will only be provided for a system assigned identity.
tenant_id This property is required. str
The tenant id of the system assigned identity. This property will only be provided for a system assigned identity.
type str
The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine.
user_assigned_identities Mapping[str, ManagedServiceIdentityResponseUserAssignedIdentities]
The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
principalId This property is required. String
The principal id of the system assigned identity. This property will only be provided for a system assigned identity.
tenantId This property is required. String
The tenant id of the system assigned identity. This property will only be provided for a system assigned identity.
type String
The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine.
userAssignedIdentities Map<Property Map>
The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

ManagedServiceIdentityResponseUserAssignedIdentities

ClientId This property is required. string
The client id of user assigned identity.
PrincipalId This property is required. string
The principal id of user assigned identity.
ClientId This property is required. string
The client id of user assigned identity.
PrincipalId This property is required. string
The principal id of user assigned identity.
clientId This property is required. String
The client id of user assigned identity.
principalId This property is required. String
The principal id of user assigned identity.
clientId This property is required. string
The client id of user assigned identity.
principalId This property is required. string
The principal id of user assigned identity.
client_id This property is required. str
The client id of user assigned identity.
principal_id This property is required. str
The principal id of user assigned identity.
clientId This property is required. String
The client id of user assigned identity.
principalId This property is required. String
The principal id of user assigned identity.

RetentionPolicyParametersResponse

Days int
Number of days to retain flow log records.
Enabled bool
Flag to enable/disable retention.
Days int
Number of days to retain flow log records.
Enabled bool
Flag to enable/disable retention.
days Integer
Number of days to retain flow log records.
enabled Boolean
Flag to enable/disable retention.
days number
Number of days to retain flow log records.
enabled boolean
Flag to enable/disable retention.
days int
Number of days to retain flow log records.
enabled bool
Flag to enable/disable retention.
days Number
Number of days to retain flow log records.
enabled Boolean
Flag to enable/disable retention.

TrafficAnalyticsConfigurationPropertiesResponse

Enabled bool
Flag to enable/disable traffic analytics.
TrafficAnalyticsInterval int
The interval in minutes which would decide how frequently TA service should do flow analytics.
WorkspaceId string
The resource guid of the attached workspace.
WorkspaceRegion string
The location of the attached workspace.
WorkspaceResourceId string
Resource Id of the attached workspace.
Enabled bool
Flag to enable/disable traffic analytics.
TrafficAnalyticsInterval int
The interval in minutes which would decide how frequently TA service should do flow analytics.
WorkspaceId string
The resource guid of the attached workspace.
WorkspaceRegion string
The location of the attached workspace.
WorkspaceResourceId string
Resource Id of the attached workspace.
enabled Boolean
Flag to enable/disable traffic analytics.
trafficAnalyticsInterval Integer
The interval in minutes which would decide how frequently TA service should do flow analytics.
workspaceId String
The resource guid of the attached workspace.
workspaceRegion String
The location of the attached workspace.
workspaceResourceId String
Resource Id of the attached workspace.
enabled boolean
Flag to enable/disable traffic analytics.
trafficAnalyticsInterval number
The interval in minutes which would decide how frequently TA service should do flow analytics.
workspaceId string
The resource guid of the attached workspace.
workspaceRegion string
The location of the attached workspace.
workspaceResourceId string
Resource Id of the attached workspace.
enabled bool
Flag to enable/disable traffic analytics.
traffic_analytics_interval int
The interval in minutes which would decide how frequently TA service should do flow analytics.
workspace_id str
The resource guid of the attached workspace.
workspace_region str
The location of the attached workspace.
workspace_resource_id str
Resource Id of the attached workspace.
enabled Boolean
Flag to enable/disable traffic analytics.
trafficAnalyticsInterval Number
The interval in minutes which would decide how frequently TA service should do flow analytics.
workspaceId String
The resource guid of the attached workspace.
workspaceRegion String
The location of the attached workspace.
workspaceResourceId String
Resource Id of the attached workspace.

TrafficAnalyticsPropertiesResponse

NetworkWatcherFlowAnalyticsConfiguration TrafficAnalyticsConfigurationPropertiesResponse
Parameters that define the configuration of traffic analytics.
networkWatcherFlowAnalyticsConfiguration TrafficAnalyticsConfigurationPropertiesResponse
Parameters that define the configuration of traffic analytics.
networkWatcherFlowAnalyticsConfiguration TrafficAnalyticsConfigurationPropertiesResponse
Parameters that define the configuration of traffic analytics.
network_watcher_flow_analytics_configuration TrafficAnalyticsConfigurationPropertiesResponse
Parameters that define the configuration of traffic analytics.
networkWatcherFlowAnalyticsConfiguration Property Map
Parameters that define the configuration of traffic analytics.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native