Azure Native v1.102.0, May 2 23

azure-native.network.getFlowLog

Explore with Pulumi AI

Gets a flow log resource by name. API Version: 2020-11-01.

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>

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]

func LookupFlowLog(ctx *Context, args *LookupFlowLogArgs, opts ...InvokeOption) (*LookupFlowLogResult, error)
func LookupFlowLogOutput(ctx *Context, args *LookupFlowLogOutputArgs, opts ...InvokeOption) LookupFlowLogResultOutput

> 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)
}

public static CompletableFuture<GetFlowLogResult> getFlowLog(GetFlowLogArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: azure-native:network:getFlowLog
  arguments:
    # arguments dictionary

The following arguments are supported:

FlowLogName string: The name of the flow log resource.
NetworkWatcherName string: The name of the network watcher.
ResourceGroupName string: The name of the resource group.

FlowLogName string: The name of the flow log resource.
NetworkWatcherName string: The name of the network watcher.
ResourceGroupName string: The name of the resource group.

flowLogName String: The name of the flow log resource.
networkWatcherName String: The name of the network watcher.
resourceGroupName String: The name of the resource group.

flowLogName string: The name of the flow log resource.
networkWatcherName string: The name of the network watcher.
resourceGroupName string: The name of the resource group.

flow_log_name str: The name of the flow log resource.
network_watcher_name str: The name of the network watcher.
resource_group_name str: The name of the resource group.

flowLogName String: The name of the flow log resource.
networkWatcherName String: The name of the network watcher.
resourceGroupName String: The name of the resource group.

getFlowLog Result

The following output properties are available:

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.
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.
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.

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.
FlowAnalyticsConfiguration TrafficAnalyticsPropertiesResponse: Parameters that define the configuration of traffic analytics.
Format FlowLogFormatParametersResponse: Parameters that define the flow log format.
Id string: Resource ID.
Location string: Resource location.
RetentionPolicy RetentionPolicyParametersResponse: Parameters that define the retention policy for flow log.
Tags map[string]string: Resource tags.

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.
flowAnalyticsConfiguration TrafficAnalyticsPropertiesResponse: Parameters that define the configuration of traffic analytics.
format FlowLogFormatParametersResponse: Parameters that define the flow log format.
id String: Resource ID.
location String: Resource location.
retentionPolicy RetentionPolicyParametersResponse: Parameters that define the retention policy for flow log.
tags Map<String,String>: Resource tags.

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.
flowAnalyticsConfiguration TrafficAnalyticsPropertiesResponse: Parameters that define the configuration of traffic analytics.
format FlowLogFormatParametersResponse: Parameters that define the flow log format.
id string: Resource ID.
location string: Resource location.
retentionPolicy RetentionPolicyParametersResponse: Parameters that define the retention policy for flow log.
tags {[key: string]: string}: Resource tags.

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.
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.
location str: Resource location.
retention_policy RetentionPolicyParametersResponse: Parameters that define the retention policy for flow log.
tags Mapping[str, str]: Resource tags.

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.
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.
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.

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 Pulumi.AzureNative.Network.Inputs.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.

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