Network Watchers - Set Flow Log Configuration

참조

서비스:: Network Watcher

API 버전:: 2024-05-01

지정된 리소스에서 흐름 로그 및 트래픽 분석(선택 사항)을 구성합니다.

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
networkWatcherName	path	True	string	Network Watcher 리소스의 이름입니다.
resourceGroupName	path	True	string	Network Watcher 리소스 그룹의 이름입니다.
subscriptionId	path	True	string	Microsoft Azure 구독을 고유하게 식별하는 구독 자격 증명입니다. 구독 ID는 모든 서비스 호출에 대한 URI의 일부를 형성합니다.
api-version	query	True	string	클라이언트 API 버전입니다.

요청 본문

Name	필수	형식	Description
properties.enabled	True	boolean	흐름 로깅을 사용하거나 사용하지 않도록 설정하는 플래그입니다.
properties.storageId	True	string	흐름 로그를 저장하는 데 사용되는 스토리지 계정의 ID입니다.
targetResourceId	True	string	흐름 로그 및 트래픽 분석에 대해 구성할 리소스의 ID입니다(선택 사항).
flowAnalyticsConfiguration		TrafficAnalyticsProperties	트래픽 분석의 구성을 정의하는 매개 변수입니다.
identity		ManagedServiceIdentity	FlowLog 리소스 관리 ID
properties.enabledFilteringCriteria		string	SrcIP, SrcPort, DstIP, DstPort, 프로토콜, 암호화, 방향 및 작업을 기반으로 네트워크 트래픽 로그를 필터링하는 선택적 필드입니다. 지정하지 않으면 모든 네트워크 트래픽이 기록됩니다.
properties.format		FlowLogFormatParameters	흐름 로그 형식을 정의하는 매개 변수입니다.
properties.retentionPolicy		RetentionPolicyParameters	흐름 로그에 대한 보존 정책을 정의하는 매개 변수입니다.

응답

Name	형식	Description
200 OK	FlowLogInformation	흐름 로그 및 트래픽 분석(선택 사항) 구성을 설정하기 위한 요청이 성공했습니다.
202 Accepted	FlowLogInformation	수락되고 작업이 비동기적으로 완료됩니다.
Other Status Codes	ErrorResponse	작업이 실패한 이유를 설명하는 오류 응답입니다.

보안

azure_auth

Azure Active Directory OAuth2 Flow.

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name	Description
user_impersonation	사용자 계정 가장

예제

Configure flow log

샘플 요청

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/configureFlowLog?api-version=2024-05-01

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


import com.azure.resourcemanager.network.fluent.models.FlowLogInformationInner;
import com.azure.resourcemanager.network.models.ManagedServiceIdentity;
import com.azure.resourcemanager.network.models.ManagedServiceIdentityUserAssignedIdentities;
import com.azure.resourcemanager.network.models.ResourceIdentityType;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for NetworkWatchers SetFlowLogConfiguration.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-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")
                .withIdentity(new ManagedServiceIdentity().withType(ResourceIdentityType.USER_ASSIGNED)
                    .withUserAssignedIdentities(mapOf(
                        "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1",
                        new ManagedServiceIdentityUserAssignedIdentities())))
                .withStorageId(
                    "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/st1")
                .withEnabled(true),
            com.azure.core.util.Context.NONE);
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

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={
            "identity": {
                "type": "UserAssigned",
                "userAssignedIdentities": {
                    "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {}
                },
            },
            "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/2024-05-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/v6"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/ab04533261eff228f28e08900445d0edef3eb70c/specification/network/resource-manager/Microsoft.Network/stable/2024-05-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{
		Identity: &armnetwork.ManagedServiceIdentity{
			Type: to.Ptr(armnetwork.ResourceIdentityTypeUserAssigned),
			UserAssignedIdentities: map[string]*armnetwork.Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties{
				"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {},
			},
		},
		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{
	// 	Identity: &armnetwork.ManagedServiceIdentity{
	// 		Type: to.Ptr(armnetwork.ResourceIdentityTypeUserAssigned),
	// 		UserAssignedIdentities: map[string]*armnetwork.Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties{
	// 			"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": &armnetwork.Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties{
	// 				ClientID: to.Ptr("c16d15e1-f60a-40e4-8a05-df3d3f655c14"),
	// 				PrincipalID: to.Ptr("e3858881-e40c-43bd-9cde-88da39c05023"),
	// 			},
	// 		},
	// 	},
	// 	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/2024-05-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,
    identity: {
      type: "UserAssigned",
      userAssignedIdentities: {
        "/subscriptions/subid/resourceGroups/rg1/providers/MicrosoftManagedIdentity/userAssignedIdentities/id1":
          {},
      },
    },
    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

샘플 응답

상태 코드:: 200

{
  "targetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1",
  "properties": {
    "storageId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/st1",
    "enabled": true
  },
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {
        "clientId": "c16d15e1-f60a-40e4-8a05-df3d3f655c14",
        "principalId": "e3858881-e40c-43bd-9cde-88da39c05023"
      }
    }
  }
}

상태 코드:: 202

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

{
  "targetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1",
  "properties": {
    "storageId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/st1",
    "enabled": true
  },
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {
        "clientId": "c16d15e1-f60a-40e4-8a05-df3d3f655c14",
        "principalId": "e3858881-e40c-43bd-9cde-88da39c05023"
      }
    }
  }
}

정의

Name	Description
ErrorDetails	일반적인 오류 세부 정보 표현입니다.
ErrorResponse	오류 개체입니다.
FlowLogFormatParameters	흐름 로그 형식을 정의하는 매개 변수입니다.
FlowLogFormatType	흐름 로그의 파일 형식입니다.
FlowLogInformation	흐름 로그 및 트래픽 분석 구성에 대한 정보입니다(선택 사항).
ManagedServiceIdentity	리소스의 ID입니다.
ResourceIdentityType	리소스에 사용되는 ID의 형식입니다. 'SystemAssigned, UserAssigned' 형식에는 암시적으로 생성된 ID와 사용자 할당 ID 집합이 모두 포함됩니다. 'None' 형식은 가상 머신에서 모든 ID를 제거합니다.
RetentionPolicyParameters	흐름 로그에 대한 보존 정책을 정의하는 매개 변수입니다.
TrafficAnalyticsConfigurationProperties	트래픽 분석의 구성을 정의하는 매개 변수입니다.
TrafficAnalyticsProperties	트래픽 분석의 구성을 정의하는 매개 변수입니다.
UserAssignedIdentities	리소스와 연결된 사용자 ID 목록입니다. 사용자 ID 사전 키 참조는 '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' 형식의 ARM 리소스 ID입니다.

ErrorDetails

일반적인 오류 세부 정보 표현입니다.

Name	형식	Description
code	string	오류 코드입니다.
message	string	오류 메시지입니다.
target	string	오류 대상입니다.

ErrorResponse

오류 개체입니다.

Name	형식	Description
error	ErrorDetails	오류 오류 세부 정보 개체입니다.

FlowLogFormatParameters

흐름 로그 형식을 정의하는 매개 변수입니다.

Name	형식	Default value	Description
type	FlowLogFormatType		흐름 로그의 파일 형식입니다.
version	integer	0	흐름 로그의 버전(수정 버전)입니다.

FlowLogFormatType

흐름 로그의 파일 형식입니다.

Name	형식	Description
JSON	string

FlowLogInformation

흐름 로그 및 트래픽 분석 구성에 대한 정보입니다(선택 사항).

Name	형식	Description
flowAnalyticsConfiguration	TrafficAnalyticsProperties	트래픽 분석의 구성을 정의하는 매개 변수입니다.
identity	ManagedServiceIdentity	FlowLog 리소스 관리 ID
properties.enabled	boolean	흐름 로깅을 사용하거나 사용하지 않도록 설정하는 플래그입니다.
properties.enabledFilteringCriteria	string	SrcIP, SrcPort, DstIP, DstPort, 프로토콜, 암호화, 방향 및 작업을 기반으로 네트워크 트래픽 로그를 필터링하는 선택적 필드입니다. 지정하지 않으면 모든 네트워크 트래픽이 기록됩니다.
properties.format	FlowLogFormatParameters	흐름 로그 형식을 정의하는 매개 변수입니다.
properties.retentionPolicy	RetentionPolicyParameters	흐름 로그에 대한 보존 정책을 정의하는 매개 변수입니다.
properties.storageId	string	흐름 로그를 저장하는 데 사용되는 스토리지 계정의 ID입니다.
targetResourceId	string	흐름 로그 및 트래픽 분석에 대해 구성할 리소스의 ID입니다(선택 사항).

ManagedServiceIdentity

리소스의 ID입니다.

Name	형식	Description
principalId	string	시스템 할당 ID의 보안 주체 ID입니다. 이 속성은 시스템 할당 ID에 대해서만 제공됩니다.
tenantId	string	시스템 할당 ID의 테넌트 ID입니다. 이 속성은 시스템 할당 ID에 대해서만 제공됩니다.
type	ResourceIdentityType	리소스에 사용되는 ID의 형식입니다. 'SystemAssigned, UserAssigned' 형식에는 암시적으로 생성된 ID와 사용자 할당 ID 집합이 모두 포함됩니다. 'None' 형식은 가상 머신에서 모든 ID를 제거합니다.
userAssignedIdentities	UserAssignedIdentities	리소스와 연결된 사용자 ID 목록입니다. 사용자 ID 사전 키 참조는 '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' 형식의 ARM 리소스 ID입니다.

ResourceIdentityType

리소스에 사용되는 ID의 형식입니다. 'SystemAssigned, UserAssigned' 형식에는 암시적으로 생성된 ID와 사용자 할당 ID 집합이 모두 포함됩니다. 'None' 형식은 가상 머신에서 모든 ID를 제거합니다.

Name	형식	Description
None	string
SystemAssigned	string
SystemAssigned, UserAssigned	string
UserAssigned	string

RetentionPolicyParameters

흐름 로그에 대한 보존 정책을 정의하는 매개 변수입니다.

Name	형식	Default value	Description
days	integer	0	흐름 로그 레코드를 보존할 일 수입니다.
enabled	boolean	False	보존을 사용/사용하지 않도록 설정하는 플래그입니다.

TrafficAnalyticsConfigurationProperties

트래픽 분석의 구성을 정의하는 매개 변수입니다.

Name	형식	Description
enabled	boolean	트래픽 분석을 사용하거나 사용하지 않도록 설정하는 플래그입니다.
trafficAnalyticsInterval	integer	TA 서비스가 흐름 분석을 수행하는 빈도를 결정하는 간격(분)입니다.
workspaceId	string	연결된 작업 영역의 리소스 GUID입니다.
workspaceRegion	string	연결된 작업 영역의 위치입니다.
workspaceResourceId	string	연결된 작업 영역의 리소스 ID입니다.

TrafficAnalyticsProperties

트래픽 분석의 구성을 정의하는 매개 변수입니다.

Name	형식	Description
networkWatcherFlowAnalyticsConfiguration	TrafficAnalyticsConfigurationProperties	트래픽 분석의 구성을 정의하는 매개 변수입니다.

UserAssignedIdentities

리소스와 연결된 사용자 ID 목록입니다. 사용자 ID 사전 키 참조는 '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' 형식의 ARM 리소스 ID입니다.

Name	형식	Description

다음을 통해 공유

Network Watchers - Set Flow Log Configuration

URI 매개 변수

요청 본문

응답

보안

azure_auth

범위

예제

Configure flow log

샘플 요청

샘플 응답

정의

ErrorDetails

ErrorResponse

FlowLogFormatParameters

FlowLogFormatType

FlowLogInformation

ManagedServiceIdentity

ResourceIdentityType

RetentionPolicyParameters

TrafficAnalyticsConfigurationProperties

TrafficAnalyticsProperties

UserAssignedIdentities

추가 리소스