Flow Logs - Get

Reference

Služba:: Network Watcher

Verze rozhraní API:: 2024-05-01

Získá prostředek protokolu toku podle názvu.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
flowLogName	path	True	string	Název prostředku protokolu toku
networkWatcherName	path	True	string	Název sledovacího procesu sítě.
resourceGroupName	path	True	string	Název skupiny prostředků.
subscriptionId	path	True	string	Přihlašovací údaje předplatného, které jednoznačně identifikují předplatné Microsoft Azure. ID předplatného tvoří součást identifikátoru URI pro každé volání služby.
api-version	query	True	string	Verze rozhraní API klienta.

Odpovědi

Name	Typ	Description
200 OK	FlowLog	Žádost byla úspěšná. Operace vrátí prostředek protokolu toku.
Other Status Codes	ErrorResponse	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok OAuth2 v Azure Active Directory

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

Get flow log

Ukázkový požadavek

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


/**
 * Samples for FlowLogs Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/NetworkWatcherFlowLogGet.json
     */
    /**
     * Sample code: Get flow log.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getFlowLog(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getFlowLogs().getWithResponse("rg1", "nw1", "flowLog1",
            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_get.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.get(
        resource_group_name="rg1",
        network_watcher_name="nw1",
        flow_log_name="flowLog1",
    )
    print(response)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/NetworkWatcherFlowLogGet.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/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/NetworkWatcherFlowLogGet.json
func ExampleFlowLogsClient_Get() {
	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)
	}
	res, err := clientFactory.NewFlowLogsClient().Get(ctx, "rg1", "nw1", "flowLog1", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %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("flowLog1"),
	// 	Type: to.Ptr("Microsoft.Network/networkWatchers/FlowLogs"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/тц1/FlowLogs/flowLog1"),
	// 	Location: to.Ptr("centraluseuap"),
	// 	Etag: to.Ptr("W/\"00000000-0000-0000-0000-000000000000\""),
	// 	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.FlowLogPropertiesFormat{
	// 		Format: &armnetwork.FlowLogFormatParameters{
	// 			Type: to.Ptr(armnetwork.FlowLogFormatTypeJSON),
	// 			Version: to.Ptr[int32](2),
	// 		},
	// 		Enabled: to.Ptr(true),
	// 		EnabledFilteringCriteria: to.Ptr("srcIP=158.255.7.8 || dstPort=56891"),
	// 		FlowAnalyticsConfiguration: &armnetwork.TrafficAnalyticsProperties{
	// 			NetworkWatcherFlowAnalyticsConfiguration: &armnetwork.TrafficAnalyticsConfigurationProperties{
	// 				Enabled: to.Ptr(false),
	// 				TrafficAnalyticsInterval: to.Ptr[int32](60),
	// 				WorkspaceID: to.Ptr("-"),
	// 				WorkspaceRegion: to.Ptr("-"),
	// 			},
	// 		},
	// 		ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 		RetentionPolicy: &armnetwork.RetentionPolicyParameters{
	// 			Days: to.Ptr[int32](0),
	// 			Enabled: to.Ptr(false),
	// 		},
	// 		StorageID: to.Ptr("/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Storage/storageAccounts/wzstorage002"),
	// 		TargetResourceGUID: to.Ptr("00000000-0000-0000-0000-000000000000"),
	// 		TargetResourceID: to.Ptr("/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Network/networkSecurityGroups/vm5-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 Gets a flow log resource by name.
 *
 * @summary Gets a flow log resource by name.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/NetworkWatcherFlowLogGet.json
 */
async function getFlowLog() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const networkWatcherName = "nw1";
  const flowLogName = "flowLog1";
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.flowLogs.get(resourceGroupName, networkWatcherName, flowLogName);
  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

Ukázková odpověď

Stavový kód:: 200

{
  "name": "flowLog1",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/тц1/FlowLogs/flowLog1",
  "etag": "W/\"00000000-0000-0000-0000-000000000000\"",
  "properties": {
    "provisioningState": "Succeeded",
    "targetResourceId": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Network/networkSecurityGroups/vm5-nsg",
    "targetResourceGuid": "00000000-0000-0000-0000-000000000000",
    "storageId": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Storage/storageAccounts/wzstorage002",
    "enabledFilteringCriteria": "srcIP=158.255.7.8 || dstPort=56891",
    "enabled": true,
    "flowAnalyticsConfiguration": {
      "networkWatcherFlowAnalyticsConfiguration": {
        "enabled": false,
        "workspaceId": "-",
        "workspaceRegion": "-",
        "trafficAnalyticsInterval": 60
      }
    },
    "retentionPolicy": {
      "days": 0,
      "enabled": false
    },
    "format": {
      "type": "JSON",
      "version": 2
    }
  },
  "location": "centraluseuap",
  "type": "Microsoft.Network/networkWatchers/FlowLogs",
  "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"
      }
    }
  }
}

Definice

Name	Description
ErrorDetails	Znázornění běžných podrobností o chybách
ErrorResponse	Objekt chyby.
FlowLog	Prostředek protokolu toku.
FlowLogFormatParameters	Parametry definující formát protokolu toku
FlowLogFormatType	Typ souboru protokolu toku.
ManagedServiceIdentity	Identita prostředku
ProvisioningState	Aktuální stav zřizování.
ResourceIdentityType	Typ identity používané pro prostředek. Typ SystemAssigned, UserAssigned zahrnuje implicitně vytvořenou identitu i sadu identit přiřazených uživatelem. Typ None odebere všechny identity z virtuálního počítače.
RetentionPolicyParameters	Parametry, které definují zásady uchovávání informací pro protokol toku.
TrafficAnalyticsConfigurationProperties	Parametry definující konfiguraci analýzy provozu
TrafficAnalyticsProperties	Parametry definující konfiguraci analýzy provozu
UserAssignedIdentities	Seznam identit uživatelů přidružených k prostředku. Odkazy na klíč slovníku identit uživatele budou ID prostředků ARM ve formátu: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.

ErrorDetails

Znázornění běžných podrobností o chybách

Name	Typ	Description
code	string	Kód chyby
message	string	Zpráva o chybě.
target	string	Cíl chyby

ErrorResponse

Objekt chyby.

Name	Typ	Description
error	ErrorDetails	Chyba Objekt podrobností o chybě.

FlowLog

Prostředek protokolu toku.

Name	Typ	Description
etag	string	Jedinečný řetězec jen pro čtení, který se změní při každé aktualizaci prostředku.
id	string	ID prostředku.
identity	ManagedServiceIdentity	Spravovaná identita prostředku FlowLog
location	string	Umístění prostředku
name	string	Název prostředku
properties.enabled	boolean	Příznak pro povolení nebo zakázání protokolování toku
properties.enabledFilteringCriteria	string	Volitelné pole pro filtrování protokolů síťového provozu na základě protokolů SrcIP, SrcPort, DstIP, DstPort, Protocol, Encryption, Direction a Action. Pokud ho nezadáte, zaprotokoluje se veškerý síťový provoz.
properties.flowAnalyticsConfiguration	TrafficAnalyticsProperties	Parametry definující konfiguraci analýzy provozu
properties.format	FlowLogFormatParameters	Parametry definující formát protokolu toku
properties.provisioningState	ProvisioningState	Stav zřizování protokolu toku.
properties.retentionPolicy	RetentionPolicyParameters	Parametry, které definují zásady uchovávání informací pro protokol toku.
properties.storageId	string	ID účtu úložiště, který se používá k ukládání protokolu toku.
properties.targetResourceGuid	string	Identifikátor GUID skupiny zabezpečení sítě, na kterou se použije protokol toku.
properties.targetResourceId	string	ID skupiny zabezpečení sítě, na kterou se použije protokol toku.
tags	object	Značky prostředků
type	string	Typ prostředku.

FlowLogFormatParameters

Parametry definující formát protokolu toku

Name	Typ	Default value	Description
type	FlowLogFormatType		Typ souboru protokolu toku.
version	integer	0	Verze (revize) protokolu toku.

FlowLogFormatType

Typ souboru protokolu toku.

Name	Typ	Description
JSON	string

ManagedServiceIdentity

Identita prostředku

Name	Typ	Description
principalId	string	ID objektu zabezpečení přiřazené identitou systému. Tato vlastnost bude poskytována pouze pro identitu přiřazenou systémem.
tenantId	string	ID tenanta přiřazené identity systému. Tato vlastnost bude poskytována pouze pro identitu přiřazenou systémem.
type	ResourceIdentityType	Typ identity používané pro prostředek. Typ SystemAssigned, UserAssigned zahrnuje implicitně vytvořenou identitu i sadu identit přiřazených uživatelem. Typ None odebere všechny identity z virtuálního počítače.
userAssignedIdentities	UserAssignedIdentities	Seznam identit uživatelů přidružených k prostředku. Odkazy na klíč slovníku identit uživatele budou ID prostředků ARM ve formátu: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.

ProvisioningState

Aktuální stav zřizování.

Name	Typ	Description
Deleting	string
Failed	string
Succeeded	string
Updating	string

ResourceIdentityType

Typ identity používané pro prostředek. Typ SystemAssigned, UserAssigned zahrnuje implicitně vytvořenou identitu i sadu identit přiřazených uživatelem. Typ None odebere všechny identity z virtuálního počítače.

Name	Typ	Description
None	string
SystemAssigned	string
SystemAssigned, UserAssigned	string
UserAssigned	string

RetentionPolicyParameters

Parametry, které definují zásady uchovávání informací pro protokol toku.

Name	Typ	Default value	Description
days	integer	0	Počet dnů, po které se mají uchovávat záznamy protokolu toku
enabled	boolean	False	Příznak pro povolení nebo zakázání uchovávání informací

TrafficAnalyticsConfigurationProperties

Parametry definující konfiguraci analýzy provozu

Name	Typ	Description
enabled	boolean	Označte příznakem pro povolení nebo zakázání analýzy provozu.
trafficAnalyticsInterval	integer	Interval v minutách, který by se rozhodl, jak často by služba technického poradce měla provádět analýzy toků.
workspaceId	string	Identifikátor GUID prostředku připojeného pracovního prostoru.
workspaceRegion	string	Umístění připojeného pracovního prostoru.
workspaceResourceId	string	ID prostředku připojeného pracovního prostoru.

TrafficAnalyticsProperties

Parametry definující konfiguraci analýzy provozu

Name	Typ	Description
networkWatcherFlowAnalyticsConfiguration	TrafficAnalyticsConfigurationProperties	Parametry definující konfiguraci analýzy provozu

UserAssignedIdentities

Seznam identit uživatelů přidružených k prostředku. Odkazy na klíč slovníku identit uživatele budou ID prostředků ARM ve formátu: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.

Name	Typ	Description

Sdílet prostřednictvím

Flow Logs - Get

Parametry identifikátoru URI

Odpovědi

Zabezpečení

azure_auth

Rozsahy

Příklady

Get flow log

Ukázkový požadavek

Ukázková odpověď

Definice

ErrorDetails

ErrorResponse

FlowLog

FlowLogFormatParameters

FlowLogFormatType

ManagedServiceIdentity

ProvisioningState

ResourceIdentityType

RetentionPolicyParameters

TrafficAnalyticsConfigurationProperties

TrafficAnalyticsProperties

UserAssignedIdentities

Další materiály