Network Watchers - Set Flow Log Configuration

Service:

Network Watcher

API Version:

2023-09-01

Configura o registo de fluxo e a análise de tráfego (opcional) num recurso especificado.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
networkWatcherName	path	True	string	O nome do recurso do observador de rede.
resourceGroupName	path	True	string	O nome do grupo de recursos do observador de rede.
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.

Corpo do Pedido

Name	Necessário	Tipo	Description
properties.enabled	True	boolean	Sinalizar para ativar/desativar o registo de fluxos.
properties.storageId	True	string	ID da conta de armazenamento que é utilizada para armazenar o registo de fluxo.
targetResourceId	True	string	O ID do recurso a configurar para o registo de fluxo e a análise de tráfego (opcional) .
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.retentionPolicy		RetentionPolicyParameters	Parâmetros que definem a política de retenção para o registo de fluxo.

Respostas

Name	Tipo	Description
200 OK	FlowLogInformation	Pedido bem-sucedido para definir o registo de fluxo e a configuração da análise de tráfego (opcional).
202 Accepted	FlowLogInformation	Aceite e a operação será concluída de forma assíncrona.
Other Status Codes	ErrorResponse	Resposta de erro que descreve a razão 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

Configure flow log

Sample Request

HTTP

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

{
  "targetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1",
  "properties": {
    "storageId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/st1",
    "enabled": true
  }
}

Java

import com.azure.resourcemanager.network.fluent.models.FlowLogInformationInner;

/**
 * Samples for NetworkWatchers SetFlowLogConfiguration.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/
     * NetworkWatcherFlowLogConfigure.json
     */
    /**
     * Sample code: Configure flow log.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void configureFlowLog(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getNetworkWatchers().setFlowLogConfiguration("rg1", "nw1",
            new FlowLogInformationInner()
                .withTargetResourceId(
                    "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1")
                .withStorageId(
                    "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/st1")
                .withEnabled(true),
            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_configure.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.network_watchers.begin_set_flow_log_configuration(
        resource_group_name="rg1",
        network_watcher_name="nw1",
        parameters={
            "properties": {
                "enabled": True,
                "storageId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/st1",
            },
            "targetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1",
        },
    ).result()
    print(response)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/NetworkWatcherFlowLogConfigure.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/azcore/to"
	"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/NetworkWatcherFlowLogConfigure.json
func ExampleWatchersClient_BeginSetFlowLogConfiguration() {
	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)
	}
	poller, err := clientFactory.NewWatchersClient().BeginSetFlowLogConfiguration(ctx, "rg1", "nw1", armnetwork.FlowLogInformation{
		Properties: &armnetwork.FlowLogProperties{
			Enabled:   to.Ptr(true),
			StorageID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/st1"),
		},
		TargetResourceID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1"),
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %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.FlowLogInformation = armnetwork.FlowLogInformation{
	// 	Properties: &armnetwork.FlowLogProperties{
	// 		Enabled: to.Ptr(true),
	// 		StorageID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/st1"),
	// 	},
	// 	TargetResourceID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1"),
	// }
}

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 Configures flow log and traffic analytics (optional) on a specified resource.
 *
 * @summary Configures flow log and traffic analytics (optional) on a specified resource.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/NetworkWatcherFlowLogConfigure.json
 */
async function configureFlowLog() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const networkWatcherName = "nw1";
  const parameters = {
    enabled: true,
    storageId:
      "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/st1",
    targetResourceId:
      "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1",
  };
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.networkWatchers.beginSetFlowLogConfigurationAndWait(
    resourceGroupName,
    networkWatcherName,
    parameters,
  );
  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;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/NetworkWatcherFlowLogConfigure.json
// this example is just showing the usage of "NetworkWatchers_SetFlowLogConfiguration" 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 NetworkWatcherResource created on azure
// for more information of creating NetworkWatcherResource, please refer to the document of NetworkWatcherResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string networkWatcherName = "nw1";
ResourceIdentifier networkWatcherResourceId = NetworkWatcherResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, networkWatcherName);
NetworkWatcherResource networkWatcher = client.GetNetworkWatcherResource(networkWatcherResourceId);

// invoke the operation
FlowLogInformation flowLogInformation = new FlowLogInformation(new ResourceIdentifier("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1"), new ResourceIdentifier("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/st1"), true);
ArmOperation<FlowLogInformation> lro = await networkWatcher.SetFlowLogConfigurationAsync(WaitUntil.Completed, flowLogInformation);
FlowLogInformation result = lro.Value;

Console.WriteLine($"Succeeded: {result}");

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

{
  "targetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1",
  "properties": {
    "storageId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/st1",
    "enabled": true
  }
}

Status code:

202

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

Response Body

{
  "targetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1",
  "properties": {
    "storageId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/st1",
    "enabled": true
  }
}

Definições

Name	Description
ErrorDetails	Representação de detalhes de erros comuns.
ErrorResponse	O objeto de erro.
FlowLogFormatParameters	Parâmetros que definem o formato de registo de fluxo.
FlowLogFormatType	O tipo de ficheiro do registo de fluxo.
FlowLogInformation	Informações sobre a configuração do registo de fluxo e análise de tráfego (opcional) .
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.

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

FlowLogInformation

Informações sobre a configuração do registo de fluxo e análise de tráfego (opcional) .

Name	Tipo	Description
flowAnalyticsConfiguration	TrafficAnalyticsProperties	Parâmetros que definem a configuração da análise de tráfego.
properties.enabled	boolean	Sinalizar para ativar/desativar o registo de fluxos.
properties.format	FlowLogFormatParameters	Parâmetros que definem o formato de 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.
targetResourceId	string	O ID do recurso a configurar para o registo de fluxo e a análise de tráfego (opcional) .

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 de recursos da área de trabalho anexada.
workspaceRegion	string	A localização da área de trabalho anexada.
workspaceResourceId	string	ID de 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.