Network Watchers - Set Flow Log Configuration

Referensi

Service:: Network Watcher

API Version:: 2021-08-01

Mengonfigurasi log alur dan analitik lalu lintas (opsional) pada sumber daya tertentu.

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

Parameter URI

Name	In	Required	Type	Description
networkWatcherName	path	True	string	Nama sumber daya network watcher.
resourceGroupName	path	True	string	Nama grup sumber daya pengamat jaringan.
subscriptionId	path	True	string	Info masuk langganan yang secara unik mengidentifikasi langganan Microsoft Azure. ID langganan membentuk bagian dari URI untuk setiap panggilan layanan.
api-version	query	True	string	Versi API klien.

Isi Permintaan

Name	Required	Type	Description
properties.enabled	True	boolean	Bendera untuk mengaktifkan/menonaktifkan pengelogan alur.
properties.storageId	True	string	ID akun penyimpanan yang digunakan untuk menyimpan log alur.
targetResourceId	True	string	ID sumber daya yang akan dikonfigurasi untuk log alur dan analitik lalu lintas (opsional) .
flowAnalyticsConfiguration		TrafficAnalyticsProperties	Parameter yang menentukan konfigurasi analitik lalu lintas.
properties.format		FlowLogFormatParameters	Parameter yang menentukan format log alur.
properties.retentionPolicy		RetentionPolicyParameters	Parameter yang menentukan kebijakan penyimpanan untuk log alur.

Respons

Name	Type	Description
200 OK	FlowLogInformation	Permintaan yang berhasil untuk mengatur log alur dan konfigurasi analitik lalu lintas (opsional).
202 Accepted	FlowLogInformation	Diterima dan operasi akan selesai secara asinkron.
Other Status Codes	ErrorResponse	Respons kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Azure Active Directory Flow OAuth2.

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

Scopes

Name	Description
user_impersonation	meniru akun pengguna Anda

Contoh

Configure flow log

Sample Request

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/configureFlowLog?api-version=2021-08-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.core.util.Context;
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/2021-08-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),
                Context.NONE);
    }
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

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

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2021-08-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()
	client, err := armnetwork.NewWatchersClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := client.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)
	}
	// TODO: use response item
	_ = res
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

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/2021-08-01/examples/NetworkWatcherFlowLogConfigure.json
 */
async function configureFlowLog() {
  const subscriptionId = "subid";
  const resourceGroupName = "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);
}

configureFlowLog().catch(console.error);

Read this SDK documentation on how to add the SDK to your project and authenticate.

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=2021-08-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
  }
}

Definisi

ErrorDetails	Representasi detail kesalahan umum.
ErrorResponse	Objek kesalahan.
FlowLogFormatParameters	Parameter yang menentukan format log alur.
FlowLogFormatType	Jenis file log alur.
FlowLogInformation	Informasi tentang konfigurasi log alur dan analitik lalu lintas (opsional) .
RetentionPolicyParameters	Parameter yang menentukan kebijakan penyimpanan untuk log alur.
TrafficAnalyticsConfigurationProperties	Parameter yang menentukan konfigurasi analitik lalu lintas.
TrafficAnalyticsProperties	Parameter yang menentukan konfigurasi analitik lalu lintas.

ErrorDetails

Representasi detail kesalahan umum.

Name	Type	Description
code	string	Kode Kesalahan.
message	string	Pesan kesalahan.
target	string	Target kesalahan.

ErrorResponse

Objek kesalahan.

Name	Type	Description
error	ErrorDetails	Kesalahan Objek detail kesalahan.

FlowLogFormatParameters

Parameter yang menentukan format log alur.

Name	Type	Default Value	Description
type	FlowLogFormatType		Jenis file log alur.
version	integer	0	Versi (revisi) log alur.

FlowLogFormatType

Jenis file log alur.

Name	Type	Description
JSON	string

FlowLogInformation

Informasi tentang konfigurasi log alur dan analitik lalu lintas (opsional) .

Name	Type	Description
flowAnalyticsConfiguration	TrafficAnalyticsProperties	Parameter yang menentukan konfigurasi analitik lalu lintas.
properties.enabled	boolean	Bendera untuk mengaktifkan/menonaktifkan pengelogan alur.
properties.format	FlowLogFormatParameters	Parameter yang menentukan format log alur.
properties.retentionPolicy	RetentionPolicyParameters	Parameter yang menentukan kebijakan penyimpanan untuk log alur.
properties.storageId	string	ID akun penyimpanan yang digunakan untuk menyimpan log alur.
targetResourceId	string	ID sumber daya yang akan dikonfigurasi untuk log alur dan analitik lalu lintas (opsional) .

RetentionPolicyParameters

Parameter yang menentukan kebijakan penyimpanan untuk log alur.

Name	Type	Default Value	Description
days	integer	0	Jumlah hari untuk menyimpan rekaman log alur.
enabled	boolean	False	Bendera untuk mengaktifkan/menonaktifkan retensi.

TrafficAnalyticsConfigurationProperties

Parameter yang menentukan konfigurasi analitik lalu lintas.

Name	Type	Description
enabled	boolean	Benderai untuk mengaktifkan/menonaktifkan analitik lalu lintas.
trafficAnalyticsInterval	integer	Interval dalam menit yang akan memutuskan seberapa sering layanan TA harus melakukan analitik alur.
workspaceId	string	Panduan sumber daya ruang kerja yang terlampir.
workspaceRegion	string	Lokasi ruang kerja terlampir.
workspaceResourceId	string	Id sumber daya ruang kerja terlampir.

TrafficAnalyticsProperties

Parameter yang menentukan konfigurasi analitik lalu lintas.

Name	Type	Description
networkWatcherFlowAnalyticsConfiguration	TrafficAnalyticsConfigurationProperties	Parameter yang menentukan konfigurasi analitik lalu lintas.