Flow Logs - Create Or Update

Référence

Service:: Network Watcher

API Version:: 2023-09-01

Créez ou mettez à jour un journal de flux pour le groupe de sécurité réseau spécifié.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
flowLogName	path	True	string	Nom du journal de flux.
networkWatcherName	path	True	string	Nom de l’observateur de réseau.
resourceGroupName	path	True	string	Nom du groupe de ressources.
subscriptionId	path	True	string	Informations d’identification d’abonnement qui identifient de façon unique l’abonnement Microsoft Azure. L’ID d’abonnement fait partie de l’URI pour chaque appel de service.
api-version	query	True	string	Version d’API client.

Corps de la demande

Nom	Obligatoire	Type	Description
properties.storageId	True	string	ID du compte de stockage utilisé pour stocker le journal de flux.
properties.targetResourceId	True	string	ID du groupe de sécurité réseau auquel le journal de flux sera appliqué.
id		string	ID de la ressource
location		string	Emplacement de la ressource.
properties.enabled		boolean	Indicateur pour activer/désactiver la journalisation des flux.
properties.flowAnalyticsConfiguration		TrafficAnalyticsProperties	Paramètres qui définissent la configuration de l’analytique du trafic.
properties.format		FlowLogFormatParameters	Paramètres qui définissent le format du journal de flux.
properties.retentionPolicy		RetentionPolicyParameters	Paramètres qui définissent la stratégie de rétention pour le journal de flux.
tags		object	Balises de ressource.

Réponses

Nom	Type	Description
200 OK	FlowLog	Mise à jour réussie. L’opération retourne la ressource de journal de flux résultante.
201 Created	FlowLog	La demande a réussi. L’opération retourne la ressource de journal de flux résultante.
Other Status Codes	ErrorResponse	Réponse d’erreur décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

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

Scopes

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Exemples

Create or update flow log

Sample Request

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


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

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

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

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

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

Définitions

Nom	Description
ErrorDetails	Représentation des détails d’erreur courante.
ErrorResponse	Objet d’erreur.
FlowLog	Ressource de journal de flux.
FlowLogFormatParameters	Paramètres qui définissent le format du journal de flux.
FlowLogFormatType	Type de fichier du journal de flux.
ProvisioningState	État d’approvisionnement actuel.
RetentionPolicyParameters	Paramètres qui définissent la stratégie de rétention pour le journal de flux.
TrafficAnalyticsConfigurationProperties	Paramètres qui définissent la configuration de l’analytique du trafic.
TrafficAnalyticsProperties	Paramètres qui définissent la configuration de l’analytique du trafic.

ErrorDetails

Représentation des détails d’erreur courante.

Nom	Type	Description
code	string	Code d’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Objet d’erreur.

Nom	Type	Description
error	ErrorDetails	Erreur Objet de détails d’erreur.

FlowLog

Ressource de journal de flux.

Nom	Type	Description
etag	string	Chaîne unique en lecture seule qui change chaque fois que la ressource est mise à jour.
id	string	ID de la ressource
location	string	Emplacement de la ressource.
name	string	Nom de la ressource.
properties.enabled	boolean	Indicateur pour activer/désactiver la journalisation des flux.
properties.flowAnalyticsConfiguration	TrafficAnalyticsProperties	Paramètres qui définissent la configuration de l’analytique du trafic.
properties.format	FlowLogFormatParameters	Paramètres qui définissent le format du journal de flux.
properties.provisioningState	ProvisioningState	État d’approvisionnement du journal de flux.
properties.retentionPolicy	RetentionPolicyParameters	Paramètres qui définissent la stratégie de rétention pour le journal de flux.
properties.storageId	string	ID du compte de stockage utilisé pour stocker le journal de flux.
properties.targetResourceGuid	string	Guid du groupe de sécurité réseau auquel le journal de flux sera appliqué.
properties.targetResourceId	string	ID du groupe de sécurité réseau auquel le journal de flux sera appliqué.
tags	object	Balises de ressource.
type	string	Type de ressource.

FlowLogFormatParameters

Paramètres qui définissent le format du journal de flux.

Nom	Type	Valeur par défaut	Description
type	FlowLogFormatType		Type de fichier du journal de flux.
version	integer	0	Version (révision) du journal de flux.

FlowLogFormatType

Type de fichier du journal de flux.

Nom	Type	Description
JSON	string

ProvisioningState

État d’approvisionnement actuel.

Nom	Type	Description
Deleting	string
Failed	string
Succeeded	string
Updating	string

RetentionPolicyParameters

Paramètres qui définissent la stratégie de rétention pour le journal de flux.

Nom	Type	Valeur par défaut	Description
days	integer	0	Nombre de jours pour conserver les enregistrements du journal de flux.
enabled	boolean	False	Indicateur pour activer/désactiver la rétention.

TrafficAnalyticsConfigurationProperties

Paramètres qui définissent la configuration de l’analytique du trafic.

Nom	Type	Description
enabled	boolean	Indicateur pour activer/désactiver l’analyse du trafic.
trafficAnalyticsInterval	integer	Intervalle en minutes qui détermine la fréquence à laquelle le service TA doit effectuer l’analyse de flux.
workspaceId	string	Guid de ressource de l’espace de travail attaché.
workspaceRegion	string	Emplacement de l’espace de travail attaché.
workspaceResourceId	string	ID de ressource de l’espace de travail attaché.

TrafficAnalyticsProperties

Paramètres qui définissent la configuration de l’analytique du trafic.

Nom	Type	Description
networkWatcherFlowAnalyticsConfiguration	TrafficAnalyticsConfigurationProperties	Paramètres qui définissent la configuration de l’analytique du trafic.