Flow Logs - Create Or Update

Service:

Network Watcher

API Version:

2023-09-01

Cree o actualice un registro de flujo para el grupo de seguridad de red especificado.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
flowLogName	path	True	string	Nombre del registro de flujo.
networkWatcherName	path	True	string	Nombre del monitor de red.
resourceGroupName	path	True	string	Nombre del grupo de recursos.
subscriptionId	path	True	string	Las credenciales de suscripción que identifican de forma exclusiva la suscripción a Microsoft Azure. El identificador de suscripción forma parte del URI para cada llamada al servicio.
api-version	query	True	string	Versión de API del cliente.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
properties.storageId	True	string	Identificador de la cuenta de almacenamiento que se usa para almacenar el registro de flujo.
properties.targetResourceId	True	string	Identificador del grupo de seguridad de red al que se aplicará el registro de flujo.
id		string	Identificador del recurso.
location		string	Ubicación del recurso
properties.enabled		boolean	Marca para habilitar o deshabilitar el registro de flujo.
properties.flowAnalyticsConfiguration		TrafficAnalyticsProperties	Parámetros que definen la configuración del análisis de tráfico.
properties.format		FlowLogFormatParameters	Parámetros que definen el formato del registro de flujo.
properties.retentionPolicy		RetentionPolicyParameters	Parámetros que definen la directiva de retención para el registro de flujo.
tags		object	Etiquetas del recurso.

Respuestas

Nombre	Tipo	Description
200 OK	FlowLog	Actualización correcta. La operación devuelve el recurso de registro de flujo resultante.
201 Created	FlowLog	Solicite correctamente. La operación devuelve el recurso de registro de flujo resultante.
Other Status Codes	ErrorResponse	Respuesta de error que describe el motivo del error de la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

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

Scopes

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

Create or update flow log

Sample Request

HTTP

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

{
  "location": "centraluseuap",
  "properties": {
    "targetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/desmondcentral-nsg",
    "storageId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/nwtest1mgvbfmqsigdxe",
    "enabled": true,
    "format": {
      "type": "JSON",
      "version": 1
    }
  }
}

Java

import com.azure.resourcemanager.network.fluent.models.FlowLogInner;
import com.azure.resourcemanager.network.models.FlowLogFormatParameters;
import com.azure.resourcemanager.network.models.FlowLogFormatType;

/**
 * Samples for FlowLogs CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/NetworkWatcherFlowLogCreate.
     * json
     */
    /**
     * Sample code: Create or update flow log.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void createOrUpdateFlowLog(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getFlowLogs().createOrUpdate("rg1", "nw1", "fl", new FlowLogInner()
            .withLocation("centraluseuap")
            .withTargetResourceId(
                "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/desmondcentral-nsg")
            .withStorageId(
                "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/nwtest1mgvbfmqsigdxe")
            .withEnabled(true)
            .withFormat(new FlowLogFormatParameters().withType(FlowLogFormatType.JSON).withVersion(1)),
            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_create.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.begin_create_or_update(
        resource_group_name="rg1",
        network_watcher_name="nw1",
        flow_log_name="fl",
        parameters={
            "location": "centraluseuap",
            "properties": {
                "enabled": True,
                "format": {"type": "JSON", "version": 1},
                "storageId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/nwtest1mgvbfmqsigdxe",
                "targetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/desmondcentral-nsg",
            },
        },
    ).result()
    print(response)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/NetworkWatcherFlowLogCreate.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/NetworkWatcherFlowLogCreate.json
func ExampleFlowLogsClient_BeginCreateOrUpdate() {
	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.NewFlowLogsClient().BeginCreateOrUpdate(ctx, "rg1", "nw1", "fl", armnetwork.FlowLog{
		Location: to.Ptr("centraluseuap"),
		Properties: &armnetwork.FlowLogPropertiesFormat{
			Format: &armnetwork.FlowLogFormatParameters{
				Type:    to.Ptr(armnetwork.FlowLogFormatTypeJSON),
				Version: to.Ptr[int32](1),
			},
			Enabled:          to.Ptr(true),
			StorageID:        to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/nwtest1mgvbfmqsigdxe"),
			TargetResourceID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/desmondcentral-nsg"),
		},
	}, 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.FlowLog = armnetwork.FlowLog{
	// 	Name: to.Ptr("Microsoft.Networkdesmond-rgdesmondcentral-nsg"),
	// 	Type: to.Ptr("Microsoft.Network/networkWatchers/FlowLogs"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw/FlowLogs/fl"),
	// 	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](1),
	// 		},
	// 		Enabled: to.Ptr(true),
	// 		FlowAnalyticsConfiguration: &armnetwork.TrafficAnalyticsProperties{
	// 		},
	// 		ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 		RetentionPolicy: &armnetwork.RetentionPolicyParameters{
	// 			Days: to.Ptr[int32](0),
	// 			Enabled: to.Ptr(false),
	// 		},
	// 		StorageID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/nwtest1mgvbfmqsigdxe"),
	// 		TargetResourceGUID: to.Ptr("00000000-0000-0000-0000-000000000000"),
	// 		TargetResourceID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/desmondcentral-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 Create or update a flow log for the specified network security group.
 *
 * @summary Create or update a flow log for the specified network security group.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/NetworkWatcherFlowLogCreate.json
 */
async function createOrUpdateFlowLog() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const networkWatcherName = "nw1";
  const flowLogName = "fl";
  const parameters = {
    format: { type: "JSON", version: 1 },
    enabled: true,
    location: "centraluseuap",
    storageId:
      "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/nwtest1mgvbfmqsigdxe",
    targetResourceId:
      "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/desmondcentral-nsg",
  };
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.flowLogs.beginCreateOrUpdateAndWait(
    resourceGroupName,
    networkWatcherName,
    flowLogName,
    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;

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/NetworkWatcherFlowLogCreate.json
// this example is just showing the usage of "FlowLogs_CreateOrUpdate" 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);

// get the collection of this FlowLogResource
FlowLogCollection collection = networkWatcher.GetFlowLogs();

// invoke the operation
string flowLogName = "fl";
FlowLogData data = new FlowLogData()
{
    TargetResourceId = new ResourceIdentifier("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/desmondcentral-nsg"),
    StorageId = new ResourceIdentifier("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/nwtest1mgvbfmqsigdxe"),
    Enabled = true,
    Format = new FlowLogProperties()
    {
        FormatType = FlowLogFormatType.Json,
        Version = 1,
    },
    Location = new AzureLocation("centraluseuap"),
};
ArmOperation<FlowLogResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, flowLogName, data);
FlowLogResource result = lro.Value;

// 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": "Microsoft.Networkdesmond-rgdesmondcentral-nsg",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw/FlowLogs/fl",
  "etag": "W/\"00000000-0000-0000-0000-000000000000\"",
  "properties": {
    "provisioningState": "Updating",
    "targetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/desmondcentral-nsg",
    "targetResourceGuid": "00000000-0000-0000-0000-000000000000",
    "storageId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/nwtest1mgvbfmqsigdxe",
    "enabled": true,
    "flowAnalyticsConfiguration": {},
    "retentionPolicy": {
      "days": 0,
      "enabled": false
    },
    "format": {
      "type": "JSON",
      "version": 1
    }
  },
  "type": "Microsoft.Network/networkWatchers/FlowLogs",
  "location": "centraluseuap"
}

Status code:

201

{
  "name": "Microsoft.Networkdesmond-rgdesmondcentral-nsg",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw/FlowLogs/fl",
  "etag": "W/\"00000000-0000-0000-0000-000000000000\"",
  "properties": {
    "provisioningState": "Succeeded",
    "targetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/desmondcentral-nsg",
    "targetResourceGuid": "00000000-0000-0000-0000-000000000000",
    "storageId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/nwtest1mgvbfmqsigdxe",
    "enabled": true,
    "flowAnalyticsConfiguration": {},
    "retentionPolicy": {
      "days": 0,
      "enabled": false
    },
    "format": {
      "type": "JSON",
      "version": 1
    }
  },
  "type": "Microsoft.Network/networkWatchers/FlowLogs",
  "location": "centraluseuap"
}

Definiciones

Nombre	Description
ErrorDetails	Representación de detalles de error comunes.
ErrorResponse	Objeto de error.
FlowLog	Un recurso de registro de flujo.
FlowLogFormatParameters	Parámetros que definen el formato del registro de flujo.
FlowLogFormatType	Tipo de archivo de registro de flujo.
ProvisioningState	Estado de aprovisionamiento actual.
RetentionPolicyParameters	Parámetros que definen la directiva de retención para el registro de flujo.
TrafficAnalyticsConfigurationProperties	Parámetros que definen la configuración del análisis de tráfico.
TrafficAnalyticsProperties	Parámetros que definen la configuración del análisis de tráfico.

ErrorDetails

Representación de detalles de error comunes.

Nombre	Tipo	Description
code	string	Código de error.
message	string	Mensaje de error.
target	string	Destino de error.

ErrorResponse

Objeto de error.

Nombre	Tipo	Description
error	ErrorDetails	Error Objeto de detalles del error.

FlowLog

Un recurso de registro de flujo.

Nombre	Tipo	Description
etag	string	Cadena de solo lectura única que cambia cada vez que se actualiza el recurso.
id	string	Identificador del recurso.
location	string	Ubicación del recurso
name	string	Nombre del recurso.
properties.enabled	boolean	Marca para habilitar o deshabilitar el registro de flujo.
properties.flowAnalyticsConfiguration	TrafficAnalyticsProperties	Parámetros que definen la configuración del análisis de tráfico.
properties.format	FlowLogFormatParameters	Parámetros que definen el formato del registro de flujo.
properties.provisioningState	ProvisioningState	Estado de aprovisionamiento del registro de flujo.
properties.retentionPolicy	RetentionPolicyParameters	Parámetros que definen la directiva de retención para el registro de flujo.
properties.storageId	string	Identificador de la cuenta de almacenamiento que se usa para almacenar el registro de flujo.
properties.targetResourceGuid	string	Guid del grupo de seguridad de red al que se aplicará el registro de flujo.
properties.targetResourceId	string	Identificador del grupo de seguridad de red al que se aplicará el registro de flujo.
tags	object	Etiquetas del recurso.
type	string	Tipo de recurso.

FlowLogFormatParameters

Parámetros que definen el formato del registro de flujo.

Nombre	Tipo	Valor predeterminado	Description
type	FlowLogFormatType		Tipo de archivo de registro de flujo.
version	integer	0	Versión (revisión) del registro de flujo.

FlowLogFormatType

Tipo de archivo de registro de flujo.

Nombre	Tipo	Description
JSON	string

ProvisioningState

Estado de aprovisionamiento actual.

Nombre	Tipo	Description
Deleting	string
Failed	string
Succeeded	string
Updating	string

RetentionPolicyParameters

Parámetros que definen la directiva de retención para el registro de flujo.

Nombre	Tipo	Valor predeterminado	Description
days	integer	0	Número de días para conservar los registros de flujo.
enabled	boolean	False	Marca para habilitar o deshabilitar la retención.

TrafficAnalyticsConfigurationProperties

Parámetros que definen la configuración del análisis de tráfico.

Nombre	Tipo	Description
enabled	boolean	Marca para habilitar o deshabilitar el análisis de tráfico.
trafficAnalyticsInterval	integer	Intervalo en minutos que decidiría con qué frecuencia el servicio TA debe realizar análisis de flujo.
workspaceId	string	Guid del recurso del área de trabajo adjunta.
workspaceRegion	string	Ubicación del área de trabajo adjunta.
workspaceResourceId	string	Identificador de recurso del área de trabajo adjunta.

TrafficAnalyticsProperties

Parámetros que definen la configuración del análisis de tráfico.

Nombre	Tipo	Description
networkWatcherFlowAnalyticsConfiguration	TrafficAnalyticsConfigurationProperties	Parámetros que definen la configuración del análisis de tráfico.