Network Watchers - Set Flow Log Configuration

Referens

Tjänst:: Network Watcher

API-version:: 2023-11-01

Konfigurerar flödeslogg och trafikanalys (valfritt) på en angiven resurs.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
networkWatcherName	path	True	string	Namnet på nätverksbevakarresursen.
resourceGroupName	path	True	string	Namnet på resursgruppen network watcher.
subscriptionId	path	True	string	Autentiseringsuppgifterna för prenumerationen som unikt identifierar Microsoft Azure-prenumerationen. Prenumerations-ID:t utgör en del av URI:n för varje tjänstanrop.
api-version	query	True	string	Klient-API-version.

Begärandetext

Name	Obligatorisk	Typ	Description
properties.enabled	True	boolean	Flagga för att aktivera/inaktivera flödesloggning.
properties.storageId	True	string	ID för lagringskontot som används för att lagra flödesloggen.
targetResourceId	True	string	ID för resursen som ska konfigureras för flödeslogg och trafikanalys (valfritt) .
flowAnalyticsConfiguration		TrafficAnalyticsProperties	Parametrar som definierar konfigurationen av trafikanalys.
properties.format		FlowLogFormatParameters	Parametrar som definierar flödesloggformatet.
properties.retentionPolicy		RetentionPolicyParameters	Parametrar som definierar kvarhållningsprincipen för flödesloggen.

Svar

Name	Typ	Description
200 OK	FlowLogInformation	Lyckad begäran om att ange konfiguration av flödesloggar och trafikanalyser (valfritt).
202 Accepted	FlowLogInformation	Godkänd och åtgärden slutförs asynkront.
Other Status Codes	ErrorResponse	Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

Configure flow log

Exempelbegäran

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/configureFlowLog?api-version=2023-11-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-11-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 typing import Any, IO, Union

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-11-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/f4c6c8697c59f966db0d1e36b62df3af3bca9065/specification/network/resource-manager/Microsoft.Network/stable/2023-11-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-11-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

Exempelsvar

Statuskod:: 200

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

Statuskod:: 202

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

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

Definitioner

Name	Description
ErrorDetails	Vanliga felinformationsrepresentationer.
ErrorResponse	Felobjektet.
FlowLogFormatParameters	Parametrar som definierar flödesloggformatet.
FlowLogFormatType	Filtypen för flödesloggen.
FlowLogInformation	Information om konfigurationen av flödeslogg och trafikanalys (valfritt) .
RetentionPolicyParameters	Parametrar som definierar kvarhållningsprincipen för flödesloggen.
TrafficAnalyticsConfigurationProperties	Parametrar som definierar konfigurationen av trafikanalys.
TrafficAnalyticsProperties	Parametrar som definierar konfigurationen av trafikanalys.

ErrorDetails

Vanliga felinformationsrepresentationer.

Name	Typ	Description
code	string	Felkod.
message	string	Felmeddelande.
target	string	Felmål.

ErrorResponse

Felobjektet.

Name	Typ	Description
error	ErrorDetails	Fel Objektet med felinformation.

FlowLogFormatParameters

Parametrar som definierar flödesloggformatet.

Name	Typ	Standardvärde	Description
type	FlowLogFormatType		Filtypen för flödesloggen.
version	integer	0	Version (revision) av flödesloggen.

FlowLogFormatType

Filtypen för flödesloggen.

Name	Typ	Description
JSON	string

FlowLogInformation

Information om konfigurationen av flödeslogg och trafikanalys (valfritt) .

Name	Typ	Description
flowAnalyticsConfiguration	TrafficAnalyticsProperties	Parametrar som definierar konfigurationen av trafikanalys.
properties.enabled	boolean	Flagga för att aktivera/inaktivera flödesloggning.
properties.format	FlowLogFormatParameters	Parametrar som definierar flödesloggformatet.
properties.retentionPolicy	RetentionPolicyParameters	Parametrar som definierar kvarhållningsprincipen för flödesloggen.
properties.storageId	string	ID för lagringskontot som används för att lagra flödesloggen.
targetResourceId	string	ID för resursen som ska konfigureras för flödeslogg och trafikanalys (valfritt) .

RetentionPolicyParameters

Parametrar som definierar kvarhållningsprincipen för flödesloggen.

Name	Typ	Standardvärde	Description
days	integer	0	Antal dagar för att behålla flödesloggposter.
enabled	boolean	False	Flagga för att aktivera/inaktivera kvarhållning.

TrafficAnalyticsConfigurationProperties

Parametrar som definierar konfigurationen av trafikanalys.

Name	Typ	Description
enabled	boolean	Flagga för att aktivera/inaktivera trafikanalys.
trafficAnalyticsInterval	integer	Intervallet i minuter som avgör hur ofta TA-tjänsten ska utföra flödesanalyser.
workspaceId	string	Resurs-GUID för den anslutna arbetsytan.
workspaceRegion	string	Platsen för den anslutna arbetsytan.
workspaceResourceId	string	Resurs-ID för den anslutna arbetsytan.

TrafficAnalyticsProperties

Parametrar som definierar konfigurationen av trafikanalys.

Name	Typ	Description
networkWatcherFlowAnalyticsConfiguration	TrafficAnalyticsConfigurationProperties	Parametrar som definierar konfigurationen av trafikanalys.

Dela via

Network Watchers - Set Flow Log Configuration

URI-parametrar

Begärandetext

Svar

Säkerhet

azure_auth

Omfattningar

Exempel

Configure flow log

Exempelbegäran

Exempelsvar

Definitioner

ErrorDetails

ErrorResponse

FlowLogFormatParameters

FlowLogFormatType

FlowLogInformation

RetentionPolicyParameters

TrafficAnalyticsConfigurationProperties

TrafficAnalyticsProperties

Ytterligare resurser