Flow Logs - Get

Referenz

Service:: Network Watcher

API Version:: 2023-09-01

Ruft eine Flussprotokollressource nach Name ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
flowLogName	path	True	string	Der Name der Flowprotokollressource.
networkWatcherName	path	True	string	Der Name des Network Watchers.
resourceGroupName	path	True	string	Der Name der Ressourcengruppe.
subscriptionId	path	True	string	Die Abonnementanmeldeinformationen, die das Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.
api-version	query	True	string	Client-API-Version.

Antworten

Name	Typ	Beschreibung
200 OK	FlowLog	Anforderung erfolgreich. Der Vorgang gibt eine Flussprotokollressource zurück.
Other Status Codes	ErrorResponse	Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory OAuth2 Flow.

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

Scopes

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

Get flow log

Sample Request

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


/**
 * Samples for FlowLogs Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/network/resource-manager/Microsoft.Network/stable/2023-09-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/2023-09-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/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/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\""),
	// 	Properties: &armnetwork.FlowLogPropertiesFormat{
	// 		Format: &armnetwork.FlowLogFormatParameters{
	// 			Type: to.Ptr(armnetwork.FlowLogFormatTypeJSON),
	// 			Version: to.Ptr[int32](2),
	// 		},
	// 		Enabled: to.Ptr(true),
	// 		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/2023-09-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

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;

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/NetworkWatcherFlowLogGet.json
// this example is just showing the usage of "FlowLogs_Get" 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 FlowLogResource created on azure
// for more information of creating FlowLogResource, please refer to the document of FlowLogResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string networkWatcherName = "nw1";
string flowLogName = "flowLog1";
ResourceIdentifier flowLogResourceId = FlowLogResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, networkWatcherName, flowLogName);
FlowLogResource flowLog = client.GetFlowLogResource(flowLogResourceId);

// invoke the operation
FlowLogResource result = await flowLog.GetAsync();

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
FlowLogData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

{
  "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",
    "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"
}

Definitionen

Name	Beschreibung
ErrorDetails	Allgemeine Darstellung von Fehlerdetails.
ErrorResponse	Das Fehlerobjekt.
FlowLog	Eine Flussprotokollressource.
FlowLogFormatParameters	Parameter, die das Ablaufprotokollformat definieren.
FlowLogFormatType	Der Dateityp des Flussprotokolls.
ProvisioningState	Der aktuelle Bereitstellungsstatus.
RetentionPolicyParameters	Parameter, die die Aufbewahrungsrichtlinie für das Flussprotokoll definieren.
TrafficAnalyticsConfigurationProperties	Parameter, die die Konfiguration der Datenverkehrsanalyse definieren.
TrafficAnalyticsProperties	Parameter, die die Konfiguration der Datenverkehrsanalyse definieren.

ErrorDetails

Allgemeine Darstellung von Fehlerdetails.

Name	Typ	Beschreibung
code	string	Fehlercode
message	string	Fehlermeldung.
target	string	Fehlerziel.

ErrorResponse

Das Fehlerobjekt.

Name	Typ	Beschreibung
error	ErrorDetails	Fehler Das Fehlerdetailsobjekt.

FlowLog

Eine Flussprotokollressource.

Name	Typ	Beschreibung
etag	string	Eine eindeutige schreibgeschützte Zeichenfolge, die sich ändert, wenn die Ressource aktualisiert wird.
id	string	Ressourcen-ID
location	string	Ressourcenspeicherort
name	string	Name der Ressource.
properties.enabled	boolean	Kennzeichnen, um die Flussprotokollierung zu aktivieren/deaktivieren.
properties.flowAnalyticsConfiguration	TrafficAnalyticsProperties	Parameter, die die Konfiguration der Datenverkehrsanalyse definieren.
properties.format	FlowLogFormatParameters	Parameter, die das Ablaufprotokollformat definieren.
properties.provisioningState	ProvisioningState	Der Bereitstellungsstatus des Flussprotokolls.
properties.retentionPolicy	RetentionPolicyParameters	Parameter, die die Aufbewahrungsrichtlinie für das Flussprotokoll definieren.
properties.storageId	string	ID des Speicherkontos, das zum Speichern des Flussprotokolls verwendet wird.
properties.targetResourceGuid	string	Guid der Netzwerksicherheitsgruppe, auf die das Flussprotokoll angewendet wird.
properties.targetResourceId	string	ID der Netzwerksicherheitsgruppe, auf die das Flussprotokoll angewendet wird.
tags	object	Ressourcentags.
type	string	Der Ressourcentyp.

FlowLogFormatParameters

Parameter, die das Ablaufprotokollformat definieren.

Name	Typ	Standardwert	Beschreibung
type	FlowLogFormatType		Der Dateityp des Flussprotokolls.
version	integer	0	Die Version (Revision) des Flussprotokolls.

FlowLogFormatType

Der Dateityp des Flussprotokolls.

Name	Typ	Beschreibung
JSON	string

ProvisioningState

Der aktuelle Bereitstellungsstatus.

Name	Typ	Beschreibung
Deleting	string
Failed	string
Succeeded	string
Updating	string

RetentionPolicyParameters

Parameter, die die Aufbewahrungsrichtlinie für das Flussprotokoll definieren.

Name	Typ	Standardwert	Beschreibung
days	integer	0	Anzahl der Tage zum Aufbewahren von Flussprotokolldatensätzen.
enabled	boolean	False	Kennzeichnen, um die Aufbewahrung zu aktivieren/zu deaktivieren.

TrafficAnalyticsConfigurationProperties

Parameter, die die Konfiguration der Datenverkehrsanalyse definieren.

Name	Typ	Beschreibung
enabled	boolean	Kennzeichnen, um Die Datenverkehrsanalyse zu aktivieren/deaktivieren.
trafficAnalyticsInterval	integer	Das Intervall in Minuten, das darüber entscheidet, wie häufig der TA-Dienst Flussanalysen durchführen soll.
workspaceId	string	Die Ressourcen-GUID des angefügten Arbeitsbereichs.
workspaceRegion	string	Der Speicherort des angefügten Arbeitsbereichs.
workspaceResourceId	string	Ressourcen-ID des angefügten Arbeitsbereichs.

TrafficAnalyticsProperties

Parameter, die die Konfiguration der Datenverkehrsanalyse definieren.

Name	Typ	Beschreibung
networkWatcherFlowAnalyticsConfiguration	TrafficAnalyticsConfigurationProperties	Parameter, die die Konfiguration der Datenverkehrsanalyse definieren.