Network Watchers - Get Flow Log Status

Référence

Service:: Network Watcher

API Version:: 2023-09-01

Requêtes status du journal de flux et de l’analytique du trafic (facultatif) sur une ressource spécifiée.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
networkWatcherName	path	True	string	Nom de la ressource network watcher.
resourceGroupName	path	True	string	Nom du groupe de ressources network watcher.
subscriptionId	path	True	string	Informations d’identification d’abonnement qui identifient de façon unique l’abonnement Microsoft Azure. L’ID d’abonnement fait partie de l’URI pour chaque appel de service.
api-version	query	True	string	Version d’API client.

Corps de la demande

Nom	Obligatoire	Type	Description
targetResourceId	True	string	Ressource cible dans laquelle l’obtention du journal de flux et de l’analytique du trafic (facultatif) status.

Réponses

Nom	Type	Description
200 OK	FlowLogInformation	Demande réussie de journal de flux de requête et d’analytique du trafic (facultatif) status.
202 Accepted	FlowLogInformation	Accepté et l’opération se termine de manière asynchrone.
Other Status Codes	ErrorResponse	Réponse d’erreur décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

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

Scopes

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Exemples

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

Définitions

Nom	Description
ErrorDetails	Représentation des détails d’erreur courante.
ErrorResponse	Objet error.
FlowLogFormatParameters	Paramètres qui définissent le format du journal de flux.
FlowLogFormatType	Type de fichier du journal de flux.
FlowLogInformation	Informations sur la configuration du journal de flux et de l’analytique du trafic (facultatif) .
FlowLogStatusParameters	Paramètres qui définissent une ressource pour interroger le journal de flux et l’analytique du trafic (facultatif) status.
RetentionPolicyParameters	Paramètres qui définissent la stratégie de rétention pour le journal de flux.
TrafficAnalyticsConfigurationProperties	Paramètres qui définissent la configuration de l’analytique du trafic.
TrafficAnalyticsProperties	Paramètres qui définissent la configuration de l’analytique du trafic.

ErrorDetails

Représentation des détails d’erreur courante.

Nom	Type	Description
code	string	Code d’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Objet error.

Nom	Type	Description
error	ErrorDetails	Erreur Objet détails de l’erreur.

FlowLogFormatParameters

Paramètres qui définissent le format du journal de flux.

Nom	Type	Valeur par défaut	Description
type	FlowLogFormatType		Type de fichier du journal de flux.
version	integer	0	Version (révision) du journal de flux.

FlowLogFormatType

Type de fichier du journal de flux.

Nom	Type	Description
JSON	string

FlowLogInformation

Informations sur la configuration du journal de flux et de l’analytique du trafic (facultatif) .

Nom	Type	Description
flowAnalyticsConfiguration	TrafficAnalyticsProperties	Paramètres qui définissent la configuration de l’analytique du trafic.
properties.enabled	boolean	Indicateur permettant d’activer/désactiver la journalisation de flux.
properties.format	FlowLogFormatParameters	Paramètres qui définissent le format du journal de flux.
properties.retentionPolicy	RetentionPolicyParameters	Paramètres qui définissent la stratégie de rétention pour le journal de flux.
properties.storageId	string	ID du compte de stockage utilisé pour stocker le journal de flux.
targetResourceId	string	ID de la ressource à configurer pour le journal de flux et l’analytique du trafic (facultatif).

FlowLogStatusParameters

Paramètres qui définissent une ressource pour interroger le journal de flux et l’analytique du trafic (facultatif) status.

Nom	Type	Description
targetResourceId	string	Ressource cible dans laquelle l’obtention du journal de flux et de l’analytique du trafic (facultatif) status.

RetentionPolicyParameters

Paramètres qui définissent la stratégie de rétention pour le journal de flux.

Nom	Type	Valeur par défaut	Description
days	integer	0	Nombre de jours pour conserver les enregistrements du journal de flux.
enabled	boolean	False	Indicateur pour activer/désactiver la rétention.

TrafficAnalyticsConfigurationProperties

Paramètres qui définissent la configuration de l’analytique du trafic.

Nom	Type	Description
enabled	boolean	Indicateur pour activer/désactiver l’analytique du trafic.
trafficAnalyticsInterval	integer	Intervalle en minutes qui détermine la fréquence à laquelle le service TA doit effectuer l’analyse de flux.
workspaceId	string	Guid de ressource de l’espace de travail attaché.
workspaceRegion	string	Emplacement de l’espace de travail attaché.
workspaceResourceId	string	ID de ressource de l’espace de travail attaché.

TrafficAnalyticsProperties

Paramètres qui définissent la configuration de l’analytique du trafic.

Nom	Type	Description
networkWatcherFlowAnalyticsConfiguration	TrafficAnalyticsConfigurationProperties	Paramètres qui définissent la configuration de l’analytique du trafic.