Network Watchers - Get Flow Log Status

Odwołanie

Service:: Network Watcher

API Version:: 2023-09-01

Wykonuje zapytania dotyczące stanu dziennika przepływu i analizy ruchu (opcjonalnie) w określonym zasobie.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
networkWatcherName	path	True	string	Nazwa zasobu usługi Network Watcher.
resourceGroupName	path	True	string	Nazwa grupy zasobów usługi Network Watcher.
subscriptionId	path	True	string	Poświadczenia subskrypcji, które jednoznacznie identyfikują subskrypcję platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora URI dla każdego wywołania usługi.
api-version	query	True	string	Wersja interfejsu API klienta.

Treść żądania

Nazwa	Wymagane	Typ	Opis
targetResourceId	True	string	Zasób docelowy, w którym jest wyświetlany stan dziennika przepływu i analizy ruchu (opcjonalnie).

Odpowiedzi

Nazwa	Typ	Opis
200 OK	FlowLogInformation	Pomyślne żądanie dotyczące dziennika przepływu zapytań i stanu analizy ruchu (opcjonalnie).
202 Accepted	FlowLogInformation	Zaakceptowane i operacja zostanie ukończona asynchronicznie.
Other Status Codes	ErrorResponse	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory.

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

Scopes

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

Get flow log status

Sample Request

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

{
  "targetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1"
}


import com.azure.resourcemanager.network.models.FlowLogStatusParameters;

/**
 * Samples for NetworkWatchers GetFlowLogStatus.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/
     * NetworkWatcherFlowLogStatusQuery.json
     */
    /**
     * Sample code: Get flow log status.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getFlowLogStatus(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getNetworkWatchers().getFlowLogStatus("rg1", "nw1",
            new FlowLogStatusParameters().withTargetResourceId(
                "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1"),
            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_status_query.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_get_flow_log_status(
        resource_group_name="rg1",
        network_watcher_name="nw1",
        parameters={
            "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-09-01/examples/NetworkWatcherFlowLogStatusQuery.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/d4205894880b989ede35d62d97c8e901ed14fb5a/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/NetworkWatcherFlowLogStatusQuery.json
func ExampleWatchersClient_BeginGetFlowLogStatus() {
	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().BeginGetFlowLogStatus(ctx, "rg1", "nw1", armnetwork.FlowLogStatusParameters{
		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 Queries status of flow log and traffic analytics (optional) on a specified resource.
 *
 * @summary Queries status of flow log and traffic analytics (optional) on a specified resource.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/NetworkWatcherFlowLogStatusQuery.json
 */
async function getFlowLogStatus() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const networkWatcherName = "nw1";
  const parameters = {
    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.beginGetFlowLogStatusAndWait(
    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

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;
using Azure.ResourceManager.Resources;

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

// invoke the operation
FlowLogStatusContent content = new FlowLogStatusContent(new ResourceIdentifier("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1"));
ArmOperation<FlowLogInformation> lro = await networkWatcher.GetFlowLogStatusAsync(WaitUntil.Completed, content);
FlowLogInformation result = lro.Value;

Console.WriteLine($"Succeeded: {result}");

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

{
  "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/queryFlowLogStatus?api-version=2023-09-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
  }
}

Definicje

Nazwa	Opis
ErrorDetails	Reprezentacja typowych szczegółów błędu.
ErrorResponse	Obiekt error.
FlowLogFormatParameters	Parametry definiujące format dziennika przepływu.
FlowLogFormatType	Typ pliku dziennika przepływu.
FlowLogInformation	Informacje na temat konfiguracji dziennika przepływu i analizy ruchu (opcjonalnie) .
FlowLogStatusParameters	Parametry definiujące zasób do wykonywania zapytań dotyczących dziennika przepływu i stanu analizy ruchu (opcjonalnie).
RetentionPolicyParameters	Parametry definiujące zasady przechowywania dziennika przepływu.
TrafficAnalyticsConfigurationProperties	Parametry definiujące konfigurację analizy ruchu.
TrafficAnalyticsProperties	Parametry definiujące konfigurację analizy ruchu.

ErrorDetails

Reprezentacja typowych szczegółów błędu.

Nazwa	Typ	Opis
code	string	Kod błędu.
message	string	Komunikat o błędzie.
target	string	Błąd docelowy.

ErrorResponse

Obiekt error.

Nazwa	Typ	Opis
error	ErrorDetails	Błąd Obiekt szczegółów błędu.

FlowLogFormatParameters

Parametry definiujące format dziennika przepływu.

Nazwa	Typ	Wartość domyślna	Opis
type	FlowLogFormatType		Typ pliku dziennika przepływu.
version	integer	0	Wersja (poprawka) dziennika przepływu.

FlowLogFormatType

Typ pliku dziennika przepływu.

Nazwa	Typ	Opis
JSON	string

FlowLogInformation

Informacje na temat konfiguracji dziennika przepływu i analizy ruchu (opcjonalnie) .

Nazwa	Typ	Opis
flowAnalyticsConfiguration	TrafficAnalyticsProperties	Parametry definiujące konfigurację analizy ruchu.
properties.enabled	boolean	Flaga umożliwiająca włączanie/wyłączanie rejestrowania przepływu.
properties.format	FlowLogFormatParameters	Parametry definiujące format dziennika przepływu.
properties.retentionPolicy	RetentionPolicyParameters	Parametry definiujące zasady przechowywania dziennika przepływu.
properties.storageId	string	Identyfikator konta magazynu używanego do przechowywania dziennika przepływu.
targetResourceId	string	Identyfikator zasobu do skonfigurowania na potrzeby dziennika przepływu i analizy ruchu (opcjonalnie) .

FlowLogStatusParameters

Parametry definiujące zasób do wykonywania zapytań dotyczących dziennika przepływu i stanu analizy ruchu (opcjonalnie).

Nazwa	Typ	Opis
targetResourceId	string	Zasób docelowy, w którym jest wyświetlany stan dziennika przepływu i analizy ruchu (opcjonalnie).

RetentionPolicyParameters

Parametry definiujące zasady przechowywania dziennika przepływu.

Nazwa	Typ	Wartość domyślna	Opis
days	integer	0	Liczba dni przechowywania rekordów dziennika przepływu.
enabled	boolean	False	Flaga włączania/wyłączania przechowywania.

TrafficAnalyticsConfigurationProperties

Parametry definiujące konfigurację analizy ruchu.

Nazwa	Typ	Opis
enabled	boolean	Flaga umożliwiająca włączanie/wyłączanie analizy ruchu.
trafficAnalyticsInterval	integer	Interwał w minutach, który decyduje, jak często usługa TA powinna wykonywać analizę przepływu.
workspaceId	string	Identyfikator GUID zasobu dołączonego obszaru roboczego.
workspaceRegion	string	Lokalizacja dołączonego obszaru roboczego.
workspaceResourceId	string	Identyfikator zasobu dołączonego obszaru roboczego.

TrafficAnalyticsProperties

Parametry definiujące konfigurację analizy ruchu.

Nazwa	Typ	Opis
networkWatcherFlowAnalyticsConfiguration	TrafficAnalyticsConfigurationProperties	Parametry definiujące konfigurację analizy ruchu.