Network Watchers - Set Flow Log Configuration

Služba:: Network Watcher

Verze rozhraní API:: 2025-05-01

Nakonfiguruje protokol toku a analýzu provozu (volitelné) na zadaném prostředku.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
networkWatcherName	path	True	string	Název sledovacího procesu sítě.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
subscriptionId	path	True	string (uuid)	ID cílového předplatného. Hodnota musí být UUID.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Text požadavku

Name	Vyžadováno	Typ	Description
properties.enabled	True	boolean	Příznak pro povolení nebo zakázání protokolování toku
properties.storageId	True	string	ID účtu úložiště, který se používá k ukládání protokolu toku.
targetResourceId	True	string	ID prostředku, které se má nakonfigurovat pro protokol toku a analýzu provozu (volitelné).
flowAnalyticsConfiguration		Common.TrafficAnalyticsProperties	Parametry definující konfiguraci analýzy provozu
identity		Common.ManagedServiceIdentity	Spravovaná identita prostředku FlowLog
properties.enabledFilteringCriteria		string	Volitelné pole pro filtrování protokolů síťového provozu na základě protokolů SrcIP, SrcPort, DstIP, DstPort, Protocol, Encryption, Direction a Action. Pokud ho nezadáte, zaprotokoluje se veškerý síťový provoz.
properties.format		Common.FlowLogFormatParameters	Parametry definující formát protokolu toku
properties.recordTypes		string	Volitelné pole pro filtrování síťových dopravních logů podle stavu toku. Hodnota tohoto pole může být libovolný kombinační řetězec písmen B, C, E nebo D, oddělený čárkou. B představuje Begin, kdy je vytvořen tok. C představuje Pokračování pro probíhající tok generovaný každých pět minut. E představuje konec, kdy je tok ukončen. D představuje Popření, když je tok odepřen. Pokud ho nezadáte, zaprotokoluje se veškerý síťový provoz.
properties.retentionPolicy		Common.RetentionPolicyParameters	Parametry, které definují zásady uchovávání informací pro protokol toku.

Odpovědi

Name	Typ	Description
200 OK	FlowLogInformation	Operace Azure byla úspěšně dokončena.
202 Accepted	FlowLogInformation	Žádost byla přijata ke zpracování, ale zpracování ještě nebylo dokončeno. Hlavičky Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Neočekávaná chybová odpověď

Name

Typ

Description

200 OK

FlowLogInformation

Operace Azure byla úspěšně dokončena.

202 Accepted

FlowLogInformation

Žádost byla přijata ke zpracování, ale zpracování ještě nebylo dokončeno.

Hlavičky

Location: string
Retry-After: integer

Other Status Codes

ErrorResponse

Neočekávaná chybová odpověď

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2.

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

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

Příklady

Configure flow log

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/configureFlowLog?api-version=2025-05-01

{
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {}
    }
  },
  "properties": {
    "enabled": true,
    "storageId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/st1"
  },
  "targetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1"
}

const { NetworkManagementClient } = require("@azure/arm-network");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Configures flow log and traffic analytics (optional) on a specified resource.
 *
 * @summary Configures flow log and traffic analytics (optional) on a specified resource.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/Network/stable/2025-05-01/examples/NetworkWatcherFlowLogConfigure.json
 */
async function configureFlowLog() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const networkWatcherName = "nw1";
  const parameters = {
    enabled: true,
    identity: {
      type: "UserAssigned",
      userAssignedIdentities: {
        "/subscriptions/subid/resourceGroups/rg1/providers/MicrosoftManagedIdentity/userAssignedIdentities/id1":
          {},
      },
    },
    storageId:
      "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/st1",
    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.beginSetFlowLogConfigurationAndWait(
    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

Ukázková odpověď

Stavový kód:: 200

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

Stavový kód:: 202

Location: https:/management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/configureFlowLog?api-version=2025-05-01

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

Definice

Name	Description
Common.FlowLogFormatParameters	Parametry definující formát protokolu toku
Common.ManagedServiceIdentity	Identita prostředku
Common.RetentionPolicyParameters	Parametry, které definují zásady uchovávání informací pro protokol toku.
Common.TrafficAnalyticsConfigurationProperties	Parametry definující konfiguraci analýzy provozu
Common.TrafficAnalyticsProperties	Parametry definující konfiguraci analýzy provozu
ErrorDetails	Znázornění běžných podrobností o chybách
ErrorResponse	Objekt chyby.
FlowLogFormatType	Typ souboru protokolu toku.
FlowLogInformation	Informace o konfiguraci protokolu toku a analýzy provozu (volitelné) .
ManagedServiceIdentityUserAssignedIdentities
ResourceIdentityType	Typ identity používané pro prostředek. Typ SystemAssigned, UserAssigned zahrnuje implicitně vytvořenou identitu i sadu identit přiřazených uživatelem. Typ None odebere všechny identity z virtuálního počítače.

Common.FlowLogFormatParameters

Objekt

Parametry definující formát protokolu toku

Name	Typ	Default value	Description
type	FlowLogFormatType		Typ souboru protokolu toku.
version	integer (int32)	0	Verze (revize) protokolu toku.

Common.ManagedServiceIdentity

Objekt

Identita prostředku

Name	Typ	Description
principalId	string	ID objektu zabezpečení přiřazené systému. Tato vlastnost bude poskytována pouze pro identitu přiřazenou systémem.
tenantId	string	ID tenanta identity přiřazené systémem. Tato vlastnost bude poskytována pouze pro identitu přiřazenou systémem.
type	ResourceIdentityType	Typ identity používané pro prostředek. Typ SystemAssigned, UserAssigned zahrnuje implicitně vytvořenou identitu i sadu identit přiřazených uživatelem. Typ None odebere všechny identity z virtuálního počítače.
userAssignedIdentities	<string, ManagedServiceIdentityUserAssignedIdentities>	Seznam identit uživatelů přidružených k prostředku. Odkazy na klíč slovníku identit uživatele budou ID prostředků ARM ve formátu: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.

Common.RetentionPolicyParameters

Objekt

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

Name	Typ	Default value	Description
days	integer (int32)	0	Počet dnů, po které se mají uchovávat záznamy protokolu toku
enabled	boolean	False	Příznak pro povolení nebo zakázání uchovávání informací

Common.TrafficAnalyticsConfigurationProperties

Objekt

Parametry definující konfiguraci analýzy provozu

Name	Typ	Description
enabled	boolean	Označte příznakem pro povolení nebo zakázání analýzy provozu.
trafficAnalyticsInterval	integer (int32)	Interval v minutách, který by se rozhodl, jak často by služba technického poradce měla provádět analýzy toků.
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.

Common.TrafficAnalyticsProperties

Objekt

Parametry definující konfiguraci analýzy provozu

Name	Typ	Description
networkWatcherFlowAnalyticsConfiguration	Common.TrafficAnalyticsConfigurationProperties	Parametry definující konfiguraci analýzy provozu

ErrorDetails

Objekt

Znázornění běžných podrobností o chybách

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

ErrorResponse

Objekt

Objekt chyby.

Name	Typ	Description
error	ErrorDetails	Error Objekt s podrobnostmi o chybě.

FlowLogFormatType

Výčet

Typ souboru protokolu toku.

Hodnota	Description
JSON	JSON

FlowLogInformation

Objekt

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

Name	Typ	Description
flowAnalyticsConfiguration	Common.TrafficAnalyticsProperties	Parametry definující konfiguraci analýzy provozu
identity	Common.ManagedServiceIdentity	Spravovaná identita prostředku FlowLog
properties.enabled	boolean	Příznak pro povolení nebo zakázání protokolování toku
properties.enabledFilteringCriteria	string	Volitelné pole pro filtrování protokolů síťového provozu na základě protokolů SrcIP, SrcPort, DstIP, DstPort, Protocol, Encryption, Direction a Action. Pokud ho nezadáte, zaprotokoluje se veškerý síťový provoz.
properties.format	Common.FlowLogFormatParameters	Parametry definující formát protokolu toku
properties.recordTypes	string	Volitelné pole pro filtrování síťových dopravních logů podle stavu toku. Hodnota tohoto pole může být libovolný kombinační řetězec písmen B, C, E nebo D, oddělený čárkou. B představuje Begin, kdy je vytvořen tok. C představuje Pokračování pro probíhající tok generovaný každých pět minut. E představuje konec, kdy je tok ukončen. D představuje Popření, když je tok odepřen. Pokud ho nezadáte, zaprotokoluje se veškerý síťový provoz.
properties.retentionPolicy	Common.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é).

ManagedServiceIdentityUserAssignedIdentities

Objekt

Name	Typ	Description
clientId	string	ID klienta identity přiřazené uživatelem.
principalId	string	ID objektu zabezpečení identity přiřazené uživatelem.

ResourceIdentityType

Výčet

Typ identity používané pro prostředek. Typ SystemAssigned, UserAssigned zahrnuje implicitně vytvořenou identitu i sadu identit přiřazených uživatelem. Typ None odebere všechny identity z virtuálního počítače.

Hodnota	Description
SystemAssigned	Přiřazen systémem
UserAssigned	Přiřazeno uživatelem
SystemAssigned, UserAssigned	PřiřazenoSystém, Přiřazeno uživatelem
None	None