Network Watchers - Get Flow Log Status

Reference

Service:: Network Watcher

API Version:: 2023-09-01

Dotazuje se na stav protokolu toku a analýzy provozu (volitelné) u zadaného prostředku.

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

Parametry identifikátoru URI

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

Text požadavku

Name	Vyžadováno	Typ	Description
targetResourceId	True	string	Cílový prostředek, ve kterém se získá stav protokolu toku a analýzy provozu (volitelné).

Odpovědi

Name	Typ	Description
200 OK	FlowLogInformation	Úspěšný požadavek na protokol toku dotazů a stav analýzy provozu (volitelné).
202 Accepted	FlowLogInformation	Akce byla přijata a operace se dokončí asynchronně.
Other Status Codes	ErrorResponse	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

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

Scopes

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

Příklady

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
  }
}

Definice

Name	Description
ErrorDetails	Běžné znázornění podrobností o chybách
ErrorResponse	Objekt chyby.
FlowLogFormatParameters	Parametry, které definují formát protokolu toku.
FlowLogFormatType	Typ souboru protokolu toku.
FlowLogInformation	Informace o konfiguraci protokolu toku a analýzy provozu (volitelné) .
FlowLogStatusParameters	Parametry, které definují prostředek pro dotazování protokolu toku a stavu analýzy provozu (volitelné).
RetentionPolicyParameters	Parametry, které definují zásady uchovávání informací pro protokol toku.
TrafficAnalyticsConfigurationProperties	Parametry, které definují konfiguraci analýzy provozu.
TrafficAnalyticsProperties	Parametry, které definují konfiguraci analýzy provozu.

ErrorDetails

Běžné znázornění podrobností o chybách

Name	Typ	Description
code	string	Kód chyby
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorResponse

Objekt chyby.

Name	Typ	Description
error	ErrorDetails	Chyba Chyba podrobnosti objektu.

FlowLogFormatParameters

Parametry, které definují formát protokolu toku.

Name	Typ	Výchozí hodnota	Description
type	FlowLogFormatType		Typ souboru protokolu toku.
version	integer	0	Verze (revize) protokolu toku.

FlowLogFormatType

Typ souboru protokolu toku.

Name	Typ	Description
JSON	string

FlowLogInformation

Informace o konfiguraci protokolu toku a analýzy provozu (volitelné) .

Name	Typ	Description
flowAnalyticsConfiguration	TrafficAnalyticsProperties	Parametry, které definují konfiguraci analýzy provozu.
properties.enabled	boolean	Příznakem povolíte nebo zakážete protokolování toku.
properties.format	FlowLogFormatParameters	Parametry, které definují formát 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.
targetResourceId	string	ID prostředku, který se má nakonfigurovat pro protokol toku a analýzu provozu (volitelné) .

FlowLogStatusParameters

Parametry, které definují prostředek pro dotazování protokolu toku a stavu analýzy provozu (volitelné).

Name	Typ	Description
targetResourceId	string	Cílový prostředek, ve kterém se získá stav protokolu toku a analýzy provozu (volitelné).

RetentionPolicyParameters

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

Name	Typ	Výchozí hodnota	Description
days	integer	0	Počet dnů pro uchování záznamů protokolu toku
enabled	boolean	False	Příznakem povolíte nebo zakážete uchovávání informací.

TrafficAnalyticsConfigurationProperties

Parametry, které definují konfiguraci analýzy provozu.

Name	Typ	Description
enabled	boolean	Příznakem povolíte nebo zakážete analýzu provozu.
trafficAnalyticsInterval	integer	Interval v minutách, který by rozhodoval o tom, jak často má služba technického poradce provádět analýzu toku.
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, které definují konfiguraci analýzy provozu.

Name	Typ	Description
networkWatcherFlowAnalyticsConfiguration	TrafficAnalyticsConfigurationProperties	Parametry, které definují konfiguraci analýzy provozu.