Network Watchers - Get Flow Log Status

Ссылка

Служба:: Network Watcher

Версия API:: 2024-05-01

Запрашивает состояние журнала потоков и аналитики трафика (необязательно) для указанного ресурса.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
networkWatcherName	path	True	string	Имя ресурса наблюдателя за сетями.
resourceGroupName	path	True	string	Имя группы ресурсов наблюдателя за сетями.
subscriptionId	path	True	string	Учетные данные подписки, которые однозначно определяют подписку Microsoft Azure. Идентификатор подписки входит в состав URI для каждого вызова службы.
api-version	query	True	string	Версия КЛИЕНТСКОго API.

Текст запроса

Имя	Обязательно	Тип	Описание
targetResourceId	True	string	Целевой ресурс, в котором получается состояние журнала потоков и аналитики трафика (необязательно).

Ответы

Имя	Тип	Описание
200 OK	FlowLogInformation	Успешный запрос к журналу потока запросов и состоянию аналитики трафика (необязательно).
202 Accepted	FlowLogInformation	Принято и операция будет выполняться асинхронно.
Other Status Codes	ErrorResponse	Ответ на ошибку, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

Get flow log status

Образец запроса

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/queryFlowLogStatus?api-version=2024-05-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/2024-05-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/2024-05-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/v6"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/ab04533261eff228f28e08900445d0edef3eb70c/specification/network/resource-manager/Microsoft.Network/stable/2024-05-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{
	// 	Identity: &armnetwork.ManagedServiceIdentity{
	// 		Type: to.Ptr(armnetwork.ResourceIdentityTypeUserAssigned),
	// 		UserAssignedIdentities: map[string]*armnetwork.Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties{
	// 			"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": &armnetwork.Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties{
	// 				ClientID: to.Ptr("c16d15e1-f60a-40e4-8a05-df3d3f655c14"),
	// 				PrincipalID: to.Ptr("e3858881-e40c-43bd-9cde-88da39c05023"),
	// 			},
	// 		},
	// 	},
	// 	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/2024-05-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

Пример ответа

Код состояния:: 200

{
  "targetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1",
  "properties": {
    "storageId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/st1",
    "enabled": true
  },
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {
        "clientId": "c16d15e1-f60a-40e4-8a05-df3d3f655c14",
        "principalId": "e3858881-e40c-43bd-9cde-88da39c05023"
      }
    }
  }
}

Код состояния:: 202

Location: https:/management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/queryFlowLogStatus?api-version=2024-05-01

{
  "targetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1",
  "properties": {
    "storageId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/st1",
    "enabled": true
  },
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {
        "clientId": "c16d15e1-f60a-40e4-8a05-df3d3f655c14",
        "principalId": "e3858881-e40c-43bd-9cde-88da39c05023"
      }
    }
  }
}

Определения

Имя	Описание
ErrorDetails	Общее представление сведений об ошибке.
ErrorResponse	Объект ошибки.
FlowLogFormatParameters	Параметры, определяющие формат журнала потоков.
FlowLogFormatType	Тип файла журнала потоков.
FlowLogInformation	Сведения о конфигурации журнала потоков и аналитики трафика (необязательно).
FlowLogStatusParameters	Параметры, определяющие ресурс для запроса журнала потоков и состояния аналитики трафика (необязательно).
ManagedServiceIdentity	Удостоверение ресурса.
ResourceIdentityType	Тип удостоверения, используемого для ресурса. Тип SystemAssigned, UserAssigned включает как неявное созданное удостоверение, так и набор назначенных пользователем удостоверений. Тип "Нет" приведет к удалению удостоверений из виртуальной машины.
RetentionPolicyParameters	Параметры, определяющие политику хранения для журнала потоков.
TrafficAnalyticsConfigurationProperties	Параметры, определяющие конфигурацию аналитики трафика.
TrafficAnalyticsProperties	Параметры, определяющие конфигурацию аналитики трафика.
UserAssignedIdentities	Список удостоверений пользователей, связанных с ресурсом. Ссылки на ключ словаря удостоверений пользователя будут идентификаторами ресурсов ARM в форме: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

ErrorDetails

Общее представление сведений об ошибке.

Имя	Тип	Описание
code	string	Код ошибки.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

Объект ошибки.

Имя	Тип	Описание
error	ErrorDetails	Ошибка Объект сведений об ошибке.

FlowLogFormatParameters

Параметры, определяющие формат журнала потоков.

Имя	Тип	Default value	Описание
type	FlowLogFormatType		Тип файла журнала потоков.
version	integer	0	Версия (редакция) журнала потоков.

FlowLogFormatType

Тип файла журнала потоков.

Имя	Тип	Описание
JSON	string

FlowLogInformation

Сведения о конфигурации журнала потоков и аналитики трафика (необязательно).

Имя	Тип	Описание
flowAnalyticsConfiguration	TrafficAnalyticsProperties	Параметры, определяющие конфигурацию аналитики трафика.
identity	ManagedServiceIdentity	Управляемое удостоверение ресурса FlowLog
properties.enabled	boolean	Пометка для включения и отключения ведения журнала потоков.
properties.enabledFilteringCriteria	string	Необязательное поле для фильтрации журналов сетевого трафика на основе SrcIP, SrcPort, DstIP, DstPort, Protocol, Encryption, Direction and Action. Если он не указан, будет зарегистрирован весь сетевой трафик.
properties.format	FlowLogFormatParameters	Параметры, определяющие формат журнала потоков.
properties.retentionPolicy	RetentionPolicyParameters	Параметры, определяющие политику хранения для журнала потоков.
properties.storageId	string	Идентификатор учетной записи хранения, которая используется для хранения журнала потока.
targetResourceId	string	Идентификатор ресурса для настройки журнала потоков и аналитики трафика (необязательно).

FlowLogStatusParameters

Параметры, определяющие ресурс для запроса журнала потоков и состояния аналитики трафика (необязательно).

Имя	Тип	Описание
targetResourceId	string	Целевой ресурс, в котором получается состояние журнала потоков и аналитики трафика (необязательно).

ManagedServiceIdentity

Удостоверение ресурса.

Имя	Тип	Описание
principalId	string	Основной идентификатор назначенного системой удостоверения. Это свойство будет предоставлено только для назначаемого системой удостоверения.
tenantId	string	Идентификатор клиента назначенного системой удостоверения. Это свойство будет предоставлено только для назначаемого системой удостоверения.
type	ResourceIdentityType	Тип удостоверения, используемого для ресурса. Тип SystemAssigned, UserAssigned включает как неявное созданное удостоверение, так и набор назначенных пользователем удостоверений. Тип "Нет" приведет к удалению удостоверений из виртуальной машины.
userAssignedIdentities	UserAssignedIdentities	Список удостоверений пользователей, связанных с ресурсом. Ссылки на ключ словаря удостоверений пользователя будут идентификаторами ресурсов ARM в форме: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

ResourceIdentityType

Тип удостоверения, используемого для ресурса. Тип SystemAssigned, UserAssigned включает как неявное созданное удостоверение, так и набор назначенных пользователем удостоверений. Тип "Нет" приведет к удалению удостоверений из виртуальной машины.

Имя	Тип	Описание
None	string
SystemAssigned	string
SystemAssigned, UserAssigned	string
UserAssigned	string

RetentionPolicyParameters

Параметры, определяющие политику хранения для журнала потоков.

Имя	Тип	Default value	Описание
days	integer	0	Количество дней для хранения записей журнала потоков.
enabled	boolean	False	Пометка для включения и отключения хранения.

TrafficAnalyticsConfigurationProperties

Параметры, определяющие конфигурацию аналитики трафика.

Имя	Тип	Описание
enabled	boolean	Пометка для включения и отключения аналитики трафика.
trafficAnalyticsInterval	integer	Интервал в минутах, который решит, насколько часто служба TA должна выполнять аналитику потоков.
workspaceId	string	Guid ресурса присоединенной рабочей области.
workspaceRegion	string	Расположение подключенной рабочей области.
workspaceResourceId	string	Идентификатор ресурса подключенной рабочей области.

TrafficAnalyticsProperties

Параметры, определяющие конфигурацию аналитики трафика.

Имя	Тип	Описание
networkWatcherFlowAnalyticsConfiguration	TrafficAnalyticsConfigurationProperties	Параметры, определяющие конфигурацию аналитики трафика.

UserAssignedIdentities

Список удостоверений пользователей, связанных с ресурсом. Ссылки на ключ словаря удостоверений пользователя будут идентификаторами ресурсов ARM в форме: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

Имя	Тип	Описание

Поделиться через

Network Watchers - Get Flow Log Status

Параметры URI

Текст запроса

Ответы

Безопасность

azure_auth

Области

Примеры

Get flow log status

Образец запроса

Пример ответа

Определения

ErrorDetails

ErrorResponse

FlowLogFormatParameters

FlowLogFormatType

FlowLogInformation

FlowLogStatusParameters

ManagedServiceIdentity

ResourceIdentityType

RetentionPolicyParameters

TrafficAnalyticsConfigurationProperties

TrafficAnalyticsProperties

UserAssignedIdentities

Дополнительные ресурсы