Flow Logs - Get

Service:

Network Watcher

API Version:

2023-09-01

Obtém um recurso de registo de fluxo pelo nome.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/flowLogs/{flowLogName}?api-version=2023-09-01

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
flowLogName	path	True	string	O nome do recurso de registo de fluxo.
networkWatcherName	path	True	string	O nome do observador de rede.
resourceGroupName	path	True	string	O nome do grupo de recursos.
subscriptionId	path	True	string	As credenciais de subscrição que identificam exclusivamente a subscrição do Microsoft Azure. O ID da subscrição faz parte do URI para cada chamada de serviço.
api-version	query	True	string	Versão da API de Cliente.

Respostas

Name	Tipo	Description
200 OK	FlowLog	Pedido com êxito. A operação devolve um recurso de registo de fluxo.
Other Status Codes	ErrorResponse	Resposta de erro que descreve o motivo pela qual a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	representar a sua conta de utilizador

Exemplos

Get flow log

Sample Request

HTTP

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/flowLogs/flowLog1?api-version=2023-09-01

Java

/**
 * Samples for FlowLogs Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/NetworkWatcherFlowLogGet.json
     */
    /**
     * Sample code: Get flow log.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getFlowLog(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getFlowLogs().getWithResponse("rg1", "nw1", "flowLog1",
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.network import NetworkManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-network
# USAGE
    python network_watcher_flow_log_get.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = NetworkManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.flow_logs.get(
        resource_group_name="rg1",
        network_watcher_name="nw1",
        flow_log_name="flowLog1",
    )
    print(response)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/NetworkWatcherFlowLogGet.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armnetwork_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/network/armnetwork/v5"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d4205894880b989ede35d62d97c8e901ed14fb5a/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/NetworkWatcherFlowLogGet.json
func ExampleFlowLogsClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armnetwork.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewFlowLogsClient().Get(ctx, "rg1", "nw1", "flowLog1", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.FlowLog = armnetwork.FlowLog{
	// 	Name: to.Ptr("flowLog1"),
	// 	Type: to.Ptr("Microsoft.Network/networkWatchers/FlowLogs"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/тц1/FlowLogs/flowLog1"),
	// 	Location: to.Ptr("centraluseuap"),
	// 	Etag: to.Ptr("W/\"00000000-0000-0000-0000-000000000000\""),
	// 	Properties: &armnetwork.FlowLogPropertiesFormat{
	// 		Format: &armnetwork.FlowLogFormatParameters{
	// 			Type: to.Ptr(armnetwork.FlowLogFormatTypeJSON),
	// 			Version: to.Ptr[int32](2),
	// 		},
	// 		Enabled: to.Ptr(true),
	// 		FlowAnalyticsConfiguration: &armnetwork.TrafficAnalyticsProperties{
	// 			NetworkWatcherFlowAnalyticsConfiguration: &armnetwork.TrafficAnalyticsConfigurationProperties{
	// 				Enabled: to.Ptr(false),
	// 				TrafficAnalyticsInterval: to.Ptr[int32](60),
	// 				WorkspaceID: to.Ptr("-"),
	// 				WorkspaceRegion: to.Ptr("-"),
	// 			},
	// 		},
	// 		ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 		RetentionPolicy: &armnetwork.RetentionPolicyParameters{
	// 			Days: to.Ptr[int32](0),
	// 			Enabled: to.Ptr(false),
	// 		},
	// 		StorageID: to.Ptr("/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Storage/storageAccounts/wzstorage002"),
	// 		TargetResourceGUID: to.Ptr("00000000-0000-0000-0000-000000000000"),
	// 		TargetResourceID: to.Ptr("/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Network/networkSecurityGroups/vm5-nsg"),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { NetworkManagementClient } = require("@azure/arm-network");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets a flow log resource by name.
 *
 * @summary Gets a flow log resource by name.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/NetworkWatcherFlowLogGet.json
 */
async function getFlowLog() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const networkWatcherName = "nw1";
  const flowLogName = "flowLog1";
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.flowLogs.get(resourceGroupName, networkWatcherName, flowLogName);
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Network;
using Azure.ResourceManager.Network.Models;

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/NetworkWatcherFlowLogGet.json
// this example is just showing the usage of "FlowLogs_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this FlowLogResource created on azure
// for more information of creating FlowLogResource, please refer to the document of FlowLogResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string networkWatcherName = "nw1";
string flowLogName = "flowLog1";
ResourceIdentifier flowLogResourceId = FlowLogResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, networkWatcherName, flowLogName);
FlowLogResource flowLog = client.GetFlowLogResource(flowLogResourceId);

// invoke the operation
FlowLogResource result = await flowLog.GetAsync();

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
FlowLogData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

200

{
  "name": "flowLog1",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/тц1/FlowLogs/flowLog1",
  "etag": "W/\"00000000-0000-0000-0000-000000000000\"",
  "properties": {
    "provisioningState": "Succeeded",
    "targetResourceId": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Network/networkSecurityGroups/vm5-nsg",
    "targetResourceGuid": "00000000-0000-0000-0000-000000000000",
    "storageId": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Storage/storageAccounts/wzstorage002",
    "enabled": true,
    "flowAnalyticsConfiguration": {
      "networkWatcherFlowAnalyticsConfiguration": {
        "enabled": false,
        "workspaceId": "-",
        "workspaceRegion": "-",
        "trafficAnalyticsInterval": 60
      }
    },
    "retentionPolicy": {
      "days": 0,
      "enabled": false
    },
    "format": {
      "type": "JSON",
      "version": 2
    }
  },
  "location": "centraluseuap",
  "type": "Microsoft.Network/networkWatchers/FlowLogs"
}

Definições

Name	Description
ErrorDetails	Representação de detalhes de erros comuns.
ErrorResponse	O objeto de erro.
FlowLog	Um recurso de registo de fluxo.
FlowLogFormatParameters	Parâmetros que definem o formato de registo de fluxo.
FlowLogFormatType	O tipo de ficheiro do registo de fluxo.
ProvisioningState	O estado de aprovisionamento atual.
RetentionPolicyParameters	Parâmetros que definem a política de retenção para o registo de fluxo.
TrafficAnalyticsConfigurationProperties	Parâmetros que definem a configuração da análise de tráfego.
TrafficAnalyticsProperties	Parâmetros que definem a configuração da análise de tráfego.

ErrorDetails

Representação de detalhes de erros comuns.

Name	Tipo	Description
code	string	Código de erro.
message	string	Mensagem de erro.
target	string	Destino do erro.

ErrorResponse

O objeto de erro.

Name	Tipo	Description
error	ErrorDetails	Erro O objeto de detalhes do erro.

FlowLog

Um recurso de registo de fluxo.

Name	Tipo	Description
etag	string	Uma cadeia só de leitura exclusiva que é alterada sempre que o recurso é atualizado.
id	string	ID do Recurso.
location	string	Localização do recurso.
name	string	Nome do recurso.
properties.enabled	boolean	Sinalizar para ativar/desativar o registo de fluxos.
properties.flowAnalyticsConfiguration	TrafficAnalyticsProperties	Parâmetros que definem a configuração da análise de tráfego.
properties.format	FlowLogFormatParameters	Parâmetros que definem o formato de registo de fluxo.
properties.provisioningState	ProvisioningState	O estado de aprovisionamento do registo de fluxo.
properties.retentionPolicy	RetentionPolicyParameters	Parâmetros que definem a política de retenção para o registo de fluxo.
properties.storageId	string	ID da conta de armazenamento que é utilizada para armazenar o registo de fluxo.
properties.targetResourceGuid	string	Guid do grupo de segurança de rede ao qual o registo de fluxo será aplicado.
properties.targetResourceId	string	ID do grupo de segurança de rede ao qual o registo de fluxo será aplicado.
tags	object	Etiquetas de recursos.
type	string	Tipo de recurso.

FlowLogFormatParameters

Parâmetros que definem o formato de registo de fluxo.

Name	Tipo	Valor Predefinido	Description
type	FlowLogFormatType		O tipo de ficheiro do registo de fluxo.
version	integer	0	A versão (revisão) do registo de fluxo.

FlowLogFormatType

O tipo de ficheiro do registo de fluxo.

Name	Tipo	Description
JSON	string

ProvisioningState

O estado de aprovisionamento atual.

Name	Tipo	Description
Deleting	string
Failed	string
Succeeded	string
Updating	string

RetentionPolicyParameters

Parâmetros que definem a política de retenção para o registo de fluxo.

Name	Tipo	Valor Predefinido	Description
days	integer	0	Número de dias para reter registos de fluxo.
enabled	boolean	False	Sinalizar para ativar/desativar a retenção.

TrafficAnalyticsConfigurationProperties

Parâmetros que definem a configuração da análise de tráfego.

Name	Tipo	Description
enabled	boolean	Sinalizar para ativar/desativar a análise de tráfego.
trafficAnalyticsInterval	integer	O intervalo em minutos que decidiria a frequência com que o serviço TA deve fazer a análise de fluxos.
workspaceId	string	O guid do recurso da área de trabalho anexada.
workspaceRegion	string	A localização da área de trabalho anexada.
workspaceResourceId	string	ID do recurso da área de trabalho anexada.

TrafficAnalyticsProperties

Parâmetros que definem a configuração da análise de tráfego.

Name	Tipo	Description
networkWatcherFlowAnalyticsConfiguration	TrafficAnalyticsConfigurationProperties	Parâmetros que definem a configuração da análise de tráfego.