Network Watchers - Set Flow Log Configuration

Başvuru

Service:: Network Watcher

API Version:: 2023-09-01

Belirtilen kaynakta akış günlüğünü ve trafik analizini (isteğe bağlı) yapılandırılır.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
networkWatcherName	path	True	string	Ağ izleyici kaynağının adı.
resourceGroupName	path	True	string	Ağ izleyicisi kaynak grubunun adı.
subscriptionId	path	True	string	Microsoft Azure aboneliğini benzersiz olarak tanımlayan abonelik kimlik bilgileri. Abonelik kimliği, her hizmet çağrısı için URI'nin bir parçasını oluşturur.
api-version	query	True	string	İstemci API sürümü.

İstek Gövdesi

Name	Gerekli	Tür	Description
properties.enabled	True	boolean	Akış günlüğünü etkinleştirmek/devre dışı bırakmak için bayrak.
properties.storageId	True	string	Akış günlüğünü depolamak için kullanılan depolama hesabının kimliği.
targetResourceId	True	string	Akış günlüğü ve trafik analizi için yapılandırılan kaynağın kimliği (isteğe bağlı) .
flowAnalyticsConfiguration		TrafficAnalyticsProperties	Trafik analizi yapılandırmasını tanımlayan parametreler.
properties.format		FlowLogFormatParameters	Akış günlüğü biçimini tanımlayan parametreler.
properties.retentionPolicy		RetentionPolicyParameters	Akış günlüğü için bekletme ilkesini tanımlayan parametreler.

Yanıtlar

Name	Tür	Description
200 OK	FlowLogInformation	Akış günlüğü ve trafik analizi (isteğe bağlı) yapılandırmasını ayarlamak için başarılı istek.
202 Accepted	FlowLogInformation	Kabul edilir ve işlem zaman uyumsuz olarak tamamlanır.
Other Status Codes	ErrorResponse	İşlemin neden başarısız olduğunu açıklayan hata yanıtı.

Güvenlik

azure_auth

Azure Active Directory OAuth2 Flow.

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

Scopes

Name	Description
user_impersonation	kullanıcı hesabınızın kimliğine bürünme

Örnekler

Configure flow log

Sample Request

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


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

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

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

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

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

Tanımlar

Name	Description
ErrorDetails	Yaygın hata ayrıntıları gösterimi.
ErrorResponse	Hata nesnesi.
FlowLogFormatParameters	Akış günlüğü biçimini tanımlayan parametreler.
FlowLogFormatType	Akış günlüğünün dosya türü.
FlowLogInformation	Akış günlüğünün ve trafik analizinin yapılandırmasıyla ilgili bilgiler (isteğe bağlı) .
RetentionPolicyParameters	Akış günlüğü için bekletme ilkesini tanımlayan parametreler.
TrafficAnalyticsConfigurationProperties	Trafik analizi yapılandırmasını tanımlayan parametreler.
TrafficAnalyticsProperties	Trafik analizi yapılandırmasını tanımlayan parametreler.

ErrorDetails

Yaygın hata ayrıntıları gösterimi.

Name	Tür	Description
code	string	Hata kodu.
message	string	Hata iletisi.
target	string	Hata hedefi.

ErrorResponse

Hata nesnesi.

Name	Tür	Description
error	ErrorDetails	Hata Hata ayrıntıları nesnesi.

FlowLogFormatParameters

Akış günlüğü biçimini tanımlayan parametreler.

Name	Tür	Varsayılan değer	Description
type	FlowLogFormatType		Akış günlüğünün dosya türü.
version	integer	0	Akış günlüğünün sürümü (düzeltme).

FlowLogFormatType

Akış günlüğünün dosya türü.

Name	Tür	Description
JSON	string

FlowLogInformation

Akış günlüğünün ve trafik analizinin yapılandırmasıyla ilgili bilgiler (isteğe bağlı) .

Name	Tür	Description
flowAnalyticsConfiguration	TrafficAnalyticsProperties	Trafik analizi yapılandırmasını tanımlayan parametreler.
properties.enabled	boolean	Akış günlüğünü etkinleştirmek/devre dışı bırakmak için bayrak.
properties.format	FlowLogFormatParameters	Akış günlüğü biçimini tanımlayan parametreler.
properties.retentionPolicy	RetentionPolicyParameters	Akış günlüğü için bekletme ilkesini tanımlayan parametreler.
properties.storageId	string	Akış günlüğünü depolamak için kullanılan depolama hesabının kimliği.
targetResourceId	string	Akış günlüğü ve trafik analizi için yapılandırılan kaynağın kimliği (isteğe bağlı) .

RetentionPolicyParameters

Akış günlüğü için bekletme ilkesini tanımlayan parametreler.

Name	Tür	Varsayılan değer	Description
days	integer	0	Akış günlüğü kayıtlarının tutulacak gün sayısı.
enabled	boolean	False	Bekletmeyi etkinleştirmek/devre dışı bırakmak için bayrak ekleyin.

TrafficAnalyticsConfigurationProperties

Trafik analizi yapılandırmasını tanımlayan parametreler.

Name	Tür	Description
enabled	boolean	Trafik analizini etkinleştirmek/devre dışı bırakmak için bayrak ekleyin.
trafficAnalyticsInterval	integer	TA hizmetinin akış analizini ne sıklıkta yapacağına karar veren dakika cinsinden aralık.
workspaceId	string	Ekli çalışma alanının kaynak guid'i.
workspaceRegion	string	Ekli çalışma alanının konumu.
workspaceResourceId	string	Ekli çalışma alanının kaynak kimliği.

TrafficAnalyticsProperties

Trafik analizi yapılandırmasını tanımlayan parametreler.

Name	Tür	Description
networkWatcherFlowAnalyticsConfiguration	TrafficAnalyticsConfigurationProperties	Trafik analizi yapılandırmasını tanımlayan parametreler.