Network Watchers - Get Flow Log Status

Service:

Network Watcher

API Version:

2023-09-01

Consultas status de log de fluxo e análise de tráfego (opcional) em um recurso especificado.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
networkWatcherName	path	True	string	O nome do recurso do observador de rede.
resourceGroupName	path	True	string	O nome do grupo de recursos do observador de rede.
subscriptionId	path	True	string	As credenciais de assinatura que identificam exclusivamente a assinatura do Microsoft Azure. A ID da assinatura faz parte do URI para cada chamada de serviço.
api-version	query	True	string	Versão de API do cliente.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
targetResourceId	True	string	O recurso de destino em que obter o log de fluxo e a análise de tráfego (opcional) status.

Respostas

Nome	Tipo	Description
200 OK	FlowLogInformation	Solicitação bem-sucedida para log de fluxo de consulta e análise de tráfego (opcional) status.
202 Accepted	FlowLogInformation	Aceito e a operação será concluída de forma assíncrona.
Other Status Codes	ErrorResponse	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

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

Scopes

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

Get flow log status

Sample Request

HTTP

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

Java

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

Python

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

Go

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

JavaScript

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

dotnet

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

Definições

Nome	Description
ErrorDetails	Representação de detalhes de erro comuns.
ErrorResponse	O objeto de erro.
FlowLogFormatParameters	Parâmetros que definem o formato de log de fluxo.
FlowLogFormatType	O tipo de arquivo do log de fluxo.
FlowLogInformation	Informações sobre a configuração do log de fluxo e análise de tráfego (opcional) .
FlowLogStatusParameters	Parâmetros que definem um recurso para consultar o log de fluxo e a análise de tráfego (opcional) status.
RetentionPolicyParameters	Parâmetros que definem a política de retenção para o log de fluxo.
TrafficAnalyticsConfigurationProperties	Parâmetros que definem a configuração da análise de tráfego.
TrafficAnalyticsProperties	Parâmetros que definem a configuração da análise de tráfego.

ErrorDetails

Representação de detalhes de erro comuns.

Nome	Tipo	Description
code	string	Código do erro.
message	string	Mensagem de erro.
target	string	Destino do erro.

ErrorResponse

O objeto de erro.

Nome	Tipo	Description
error	ErrorDetails	Erro O objeto de detalhes do erro.

FlowLogFormatParameters

Parâmetros que definem o formato de log de fluxo.

Nome	Tipo	Valor padrão	Description
type	FlowLogFormatType		O tipo de arquivo do log de fluxo.
version	integer	0	A versão (revisão) do log de fluxo.

FlowLogFormatType

O tipo de arquivo do log de fluxo.

Nome	Tipo	Description
JSON	string

FlowLogInformation

Informações sobre a configuração do log de fluxo e análise de tráfego (opcional) .

Nome	Tipo	Description
flowAnalyticsConfiguration	TrafficAnalyticsProperties	Parâmetros que definem a configuração da análise de tráfego.
properties.enabled	boolean	Sinalizador para habilitar/desabilitar o log de fluxo.
properties.format	FlowLogFormatParameters	Parâmetros que definem o formato de log de fluxo.
properties.retentionPolicy	RetentionPolicyParameters	Parâmetros que definem a política de retenção para o log de fluxo.
properties.storageId	string	ID da conta de armazenamento que é usada para armazenar o log de fluxo.
targetResourceId	string	A ID do recurso a ser configurado para log de fluxo e análise de tráfego (opcional).

FlowLogStatusParameters

Parâmetros que definem um recurso para consultar o log de fluxo e a análise de tráfego (opcional) status.

Nome	Tipo	Description
targetResourceId	string	O recurso de destino em que obter o log de fluxo e a análise de tráfego (opcional) status.

RetentionPolicyParameters

Parâmetros que definem a política de retenção para o log de fluxo.

Nome	Tipo	Valor padrão	Description
days	integer	0	Número de dias para reter registros de log de fluxo.
enabled	boolean	False	Sinalizador para habilitar/desabilitar a retenção.

TrafficAnalyticsConfigurationProperties

Parâmetros que definem a configuração da análise de tráfego.

Nome	Tipo	Description
enabled	boolean	Sinalizador para habilitar/desabilitar a análise de tráfego.
trafficAnalyticsInterval	integer	O intervalo em minutos que decidiria com que frequência o serviço TA deve fazer análise de fluxo.
workspaceId	string	O guid de recurso do workspace anexado.
workspaceRegion	string	O local do workspace anexado.
workspaceResourceId	string	ID do recurso do workspace anexado.

TrafficAnalyticsProperties

Parâmetros que definem a configuração da análise de tráfego.

Nome	Tipo	Description
networkWatcherFlowAnalyticsConfiguration	TrafficAnalyticsConfigurationProperties	Parâmetros que definem a configuração da análise de tráfego.