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	Network Watcher リソースグループの名前。
subscriptionId	path	True	string	Microsoft Azure サブスクリプションを一意に識別するサブスクリプション資格情報。サブスクリプション ID は、すべてのサービス呼び出しの URI の一部を形成します。
api-version	query	True	string	クライアント API のバージョン。

要求本文

名前	必須	型	説明
targetResourceId	True	string	フローログとトラフィック分析 (省略可能) の状態を取得するターゲットリソース。

応答

名前	型	説明
200 OK	FlowLogInformation	クエリフローログとトラフィック分析 (省略可能) 状態の要求が成功しました。
202 Accepted	FlowLogInformation	受け入れられ、操作は非同期的に完了します。
Other Status Codes	ErrorResponse	操作が失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

型: oauth2
フロー: implicit
Authorization URL (承認 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	リソースの ID。
ResourceIdentityType	リソースに使用される ID の種類。型 'SystemAssigned, UserAssigned' には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。種類 'None' は、仮想マシンからすべての ID を削除します。
RetentionPolicyParameters	フローログの保持ポリシーを定義するパラメーター。
TrafficAnalyticsConfigurationProperties	トラフィック分析の構成を定義するパラメーター。
TrafficAnalyticsProperties	トラフィック分析の構成を定義するパラメーター。
UserAssignedIdentities	リソースに関連付けられているユーザー ID の一覧。ユーザー ID ディクショナリのキー参照は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' という形式の ARM リソース ID になります。

ErrorDetails

一般的なエラーの詳細表現。

名前	型	説明
code	string	エラーコード。
message	string	エラーメッセージ。
target	string	エラーターゲット。

ErrorResponse

エラーオブジェクト。

名前	型	説明
error	ErrorDetails	エラーエラーの詳細オブジェクト。

FlowLogFormatParameters

フローログ形式を定義するパラメーター。

名前	型	規定値	説明
type	FlowLogFormatType		フローログのファイルの種類。
version	integer	0	フローログのバージョン (リビジョン)。

FlowLogFormatType

フローログのファイルの種類。

名前	型	説明
JSON	string

FlowLogInformation

フローログとトラフィック分析の構成に関する情報 (省略可能)。

名前	型	説明
flowAnalyticsConfiguration	TrafficAnalyticsProperties	トラフィック分析の構成を定義するパラメーター。
identity	ManagedServiceIdentity	FlowLog リソースのマネージド ID
properties.enabled	boolean	フローログ記録を有効または無効にするフラグ。
properties.enabledFilteringCriteria	string	SrcIP、SrcPort、DstIP、DstPort、Protocol、Encryption、Direction、Action に基づいてネットワークトラフィックログをフィルター処理するオプションのフィールド。指定しない場合、すべてのネットワークトラフィックがログに記録されます。
properties.format	FlowLogFormatParameters	フローログ形式を定義するパラメーター。
properties.retentionPolicy	RetentionPolicyParameters	フローログの保持ポリシーを定義するパラメーター。
properties.storageId	string	フローログの格納に使用されるストレージアカウントの ID。
targetResourceId	string	フローログとトラフィック分析用に構成するリソースの ID (省略可能)。

FlowLogStatusParameters

フローログとトラフィック分析 (省略可能) の状態を照会するリソースを定義するパラメーター。

名前	型	説明
targetResourceId	string	フローログとトラフィック分析 (省略可能) の状態を取得するターゲットリソース。

ManagedServiceIdentity

リソースの ID。

名前	型	説明
principalId	string	システム割り当て ID のプリンシパル ID。このプロパティは、システム割り当て ID にのみ提供されます。
tenantId	string	システム割り当て ID のテナント ID。このプロパティは、システム割り当て ID にのみ提供されます。
type	ResourceIdentityType	リソースに使用される ID の種類。型 'SystemAssigned, UserAssigned' には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。種類 'None' は、仮想マシンからすべての ID を削除します。
userAssignedIdentities	UserAssignedIdentities	リソースに関連付けられているユーザー ID の一覧。ユーザー ID ディクショナリのキー参照は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' という形式の ARM リソース ID になります。

ResourceIdentityType

リソースに使用される ID の種類。型 'SystemAssigned, UserAssigned' には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。種類 'None' は、仮想マシンからすべての ID を削除します。

名前	型	説明
None	string
SystemAssigned	string
SystemAssigned, UserAssigned	string
UserAssigned	string

RetentionPolicyParameters

フローログの保持ポリシーを定義するパラメーター。

名前	型	規定値	説明
days	integer	0	フローログレコードを保持する日数。
enabled	boolean	False	保持を有効または無効にするフラグ。

TrafficAnalyticsConfigurationProperties

トラフィック分析の構成を定義するパラメーター。

名前	型	説明
enabled	boolean	トラフィック分析を有効または無効にするフラグ。
trafficAnalyticsInterval	integer	TA サービスがフロー分析を実行する頻度を決定する間隔 (分)。
workspaceId	string	アタッチされたワークスペースのリソース GUID。
workspaceRegion	string	アタッチされたワークスペースの場所。
workspaceResourceId	string	アタッチされたワークスペースのリソース ID。

TrafficAnalyticsProperties

トラフィック分析の構成を定義するパラメーター。

名前	型	説明
networkWatcherFlowAnalyticsConfiguration	TrafficAnalyticsConfigurationProperties	トラフィック分析の構成を定義するパラメーター。

UserAssignedIdentities

リソースに関連付けられているユーザー ID の一覧。ユーザー ID ディクショナリのキー参照は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' という形式の ARM リソース ID になります。

名前	型	説明

次の方法で共有

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

その他のリソース