Microsoft.Network NetworkWatchers/flowLogs 2020-04-01

Definicja zasobu Bicep

Typ zasobu networkWatchers/flowLogs można wdrożyć przy użyciu operacji docelowych:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Przykłady użycia

Przykłady Bicep

Podstawowy przykład wdrażania dziennika przepływu usługi Network Watcher.

param location string = 'eastus2'
param resourceName string = 'acctest0001'

resource networkWatchers 'Microsoft.Network/networkWatchers@2023-11-01' = {
  name: resourceName
  location: location
  properties: {}
}

resource flowLog 'Microsoft.Network/networkWatchers/flowLogs@2023-11-01' = {
  name: resourceName
  location: location
  parent: networkWatchers
  properties: {
    enabled: true
    flowAnalyticsConfiguration: {
      networkWatcherFlowAnalyticsConfiguration: {
        enabled: false
      }
    }
    format: {
      type: 'JSON'
      version: 2
    }
    retentionPolicy: {
      days: 7
      enabled: true
    }
    storageId: storageAccount.id
    targetResourceId: virtualNetwork.id
  }
}

resource storageAccount 'Microsoft.Storage/storageAccounts@2021-09-01' = {
  name: resourceName
  location: location
  sku: {
    name: 'Standard_LRS'
  }
  kind: 'StorageV2'
  properties: {
    accessTier: 'Hot'
    allowBlobPublicAccess: true
    allowCrossTenantReplication: true
    allowSharedKeyAccess: true
    defaultToOAuthAuthentication: false
    encryption: {
      keySource: 'Microsoft.Storage'
      services: {
        queue: {
          keyType: 'Service'
        }
        table: {
          keyType: 'Service'
        }
      }
    }
    isHnsEnabled: false
    isNfsV3Enabled: false
    isSftpEnabled: false
    minimumTlsVersion: 'TLS1_2'
    networkAcls: {
      defaultAction: 'Allow'
    }
    publicNetworkAccess: 'Enabled'
    supportsHttpsTrafficOnly: true
  }
}

resource virtualNetwork 'Microsoft.Network/virtualNetworks@2022-07-01' = {
  name: resourceName
  location: location
  properties: {
    addressSpace: {
      addressPrefixes: [
        '10.0.0.0/16'
      ]
    }
    dhcpOptions: {
      dnsServers: []
    }
    subnets: []
  }
}

Moduły zweryfikowane na platformie Azure

Następujące moduły zweryfikowane platformy Azure mogą służyć do wdrażania tego typu zasobu.

Module Opis
Network Watcher - Flow Log Moduł podrzędny AVM dla Network Watcher – Flow Log

Przykłady szybkiego startu platformy Azure

Poniższe szablony szybkiego startu platformy Azure zawierają przykłady Bicep na potrzeby wdrażania tego typu zasobu.

Plik Bicep Opis
Włącz Virtual Network Flow Logs Ten szablon tworzy wirtualny zasób dziennika przepływu sieci.
dzienniki przepływu sieciowej grupy zabezpieczeń z analizą ruchu Ten szablon tworzy dziennik przepływu sieciowej grupy zabezpieczeń w istniejącej sieciowej grupie zabezpieczeń z analizą ruchu

Format zasobu

Aby utworzyć zasób Microsoft.Network/networkWatchers/flowLogs, dodaj następujący kod Bicep do szablonu.

resource symbolicname 'Microsoft.Network/networkWatchers/flowLogs@2020-04-01' = {
  parent: resourceSymbolicName
  location: 'string'
  name: 'string'
  properties: {
    enabled: bool
    flowAnalyticsConfiguration: {
      networkWatcherFlowAnalyticsConfiguration: {
        enabled: bool
        trafficAnalyticsInterval: int
        workspaceId: 'string'
        workspaceRegion: 'string'
        workspaceResourceId: 'string'
      }
    }
    format: {
      type: 'string'
      version: int
    }
    retentionPolicy: {
      days: int
      enabled: bool
    }
    storageId: 'string'
    targetResourceId: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Wartości właściwości

Microsoft.Network/networkWatchers/flowLogs

Nazwa Opis Wartość
lokalizacja Lokalizacja zasobu. ciąg
nazwa Nazwa zasobu ciąg (wymagany)
nadrzędny W Bicep można określić zasób nadrzędny dla zasobu podrzędnego. Tę właściwość należy dodać tylko wtedy, gdy zasób podrzędny jest zadeklarowany poza zasobem nadrzędnym.

Aby uzyskać więcej informacji, zobacz Zasób podrzędny poza zasobem nadrzędnym.
Nazwa symboliczna zasobu typu: networkWatchers
Właściwości Właściwości dziennika przepływu. FlowLogPropertiesFormat (Format właściwości dziennika przepływu)
Tagi Tagi zasobów Słownik nazw tagów i wartości. Zobacz tagi w szablonach

Parametry formatu przepływu

Nazwa Opis Wartość
typ Typ pliku dziennika przepływu. "JSON"
wersja Wersja (poprawka) dziennika przepływu. Int

FlowLogPropertiesFormat (Format właściwości dziennika przepływu)

Nazwa Opis Wartość
Włączone Flaga włączania/wyłączania rejestrowania przepływu. Bool
flowAnalyticsConfiguration (konfiguracja analizy) Parametry definiujące konfigurację analizy ruchu. Właściwości TrafficAnalyticsProperties
formatowanie Parametry definiujące format dziennika przepływu. Parametry formatu przepływu
Polityka przechowywania Parametry definiujące zasady przechowywania dziennika przepływu. RetentionPolicyParameters (Parametry polityki przechowywania)
storageId (identyfikator magazynu) Identyfikator konta magazynu używanego do przechowywania dziennika przepływu. ciąg (wymagany)
IdentyfikatorZasobuDocelowego Identyfikator sieciowej grupy zabezpieczeń, do której zostanie zastosowany dziennik przepływu. ciąg (wymagany)

Tagi zasobów

Nazwa Opis Wartość

RetentionPolicyParameters (Parametry polityki przechowywania)

Nazwa Opis Wartość
Dni Liczba dni przechowywania rekordów dziennika przepływu. Int
Włączone Flaga włączania/wyłączania przechowywania. Bool

TrafficAnalyticsConfigurationProperties

Nazwa Opis Wartość
Włączone Flaga umożliwiająca włączanie/wyłączanie analizy ruchu. Bool
trafficAnalyticsInterwał Interwał w minutach, który decyduje, jak często usługa TA powinna wykonywać analizę przepływu. Int
Identyfikator przestrzeni roboczej (workspaceId) Identyfikator GUID zasobu dołączonego obszaru roboczego. ciąg
obszar roboczy Lokalizacja dołączonego obszaru roboczego. ciąg
IdentyfikatorZasobuPrzestrzeniRoboczej Identyfikator zasobu dołączonego obszaru roboczego. ciąg

Właściwości TrafficAnalyticsProperties

Nazwa Opis Wartość
networkWatcherFlowAnalyticsConfiguration Parametry definiujące konfigurację analizy ruchu. TrafficAnalyticsConfigurationProperties

Definicja zasobu szablonu usługi ARM

Typ zasobu networkWatchers/flowLogs można wdrożyć przy użyciu operacji docelowych:

Przykłady użycia

Szablony szybkiego startu platformy Azure

Następujące szablony szybkiego startu platformy Azure wdrożyć ten typ zasobu.

Szablon Opis
Włącz Virtual Network Flow Logs

wdrażanie w usłudze Azure
Ten szablon tworzy wirtualny zasób dziennika przepływu sieci.
dzienniki przepływu sieciowej grupy zabezpieczeń z analizą ruchu

wdrażanie w usłudze Azure
Ten szablon tworzy dziennik przepływu sieciowej grupy zabezpieczeń w istniejącej sieciowej grupie zabezpieczeń z analizą ruchu

Format zasobu

Aby utworzyć zasób Microsoft.Network/networkWatchers/flowLogs, dodaj następujący kod JSON do szablonu.

{
  "type": "Microsoft.Network/networkWatchers/flowLogs",
  "apiVersion": "2020-04-01",
  "name": "string",
  "location": "string",
  "properties": {
    "enabled": "bool",
    "flowAnalyticsConfiguration": {
      "networkWatcherFlowAnalyticsConfiguration": {
        "enabled": "bool",
        "trafficAnalyticsInterval": "int",
        "workspaceId": "string",
        "workspaceRegion": "string",
        "workspaceResourceId": "string"
      }
    },
    "format": {
      "type": "string",
      "version": "int"
    },
    "retentionPolicy": {
      "days": "int",
      "enabled": "bool"
    },
    "storageId": "string",
    "targetResourceId": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Wartości właściwości

Microsoft.Network/networkWatchers/flowLogs

Nazwa Opis Wartość
apiVersion (wersja interfejsu api) Wersja interfejsu API '2020-04-01'
lokalizacja Lokalizacja zasobu. ciąg
nazwa Nazwa zasobu ciąg (wymagany)
Właściwości Właściwości dziennika przepływu. FlowLogPropertiesFormat (Format właściwości dziennika przepływu)
Tagi Tagi zasobów Słownik nazw tagów i wartości. Zobacz tagi w szablonach
typ Typ zasobu "Microsoft.Network/networkWatchers/flowLogs"

Parametry formatu przepływu

Nazwa Opis Wartość
typ Typ pliku dziennika przepływu. "JSON"
wersja Wersja (poprawka) dziennika przepływu. Int

FlowLogPropertiesFormat (Format właściwości dziennika przepływu)

Nazwa Opis Wartość
Włączone Flaga włączania/wyłączania rejestrowania przepływu. Bool
flowAnalyticsConfiguration (konfiguracja analizy) Parametry definiujące konfigurację analizy ruchu. Właściwości TrafficAnalyticsProperties
formatowanie Parametry definiujące format dziennika przepływu. Parametry formatu przepływu
Polityka przechowywania Parametry definiujące zasady przechowywania dziennika przepływu. RetentionPolicyParameters (Parametry polityki przechowywania)
storageId (identyfikator magazynu) Identyfikator konta magazynu używanego do przechowywania dziennika przepływu. ciąg (wymagany)
IdentyfikatorZasobuDocelowego Identyfikator sieciowej grupy zabezpieczeń, do której zostanie zastosowany dziennik przepływu. ciąg (wymagany)

Tagi zasobów

Nazwa Opis Wartość

RetentionPolicyParameters (Parametry polityki przechowywania)

Nazwa Opis Wartość
Dni Liczba dni przechowywania rekordów dziennika przepływu. Int
Włączone Flaga włączania/wyłączania przechowywania. Bool

TrafficAnalyticsConfigurationProperties

Nazwa Opis Wartość
Włączone Flaga umożliwiająca włączanie/wyłączanie analizy ruchu. Bool
trafficAnalyticsInterwał Interwał w minutach, który decyduje, jak często usługa TA powinna wykonywać analizę przepływu. Int
Identyfikator przestrzeni roboczej (workspaceId) Identyfikator GUID zasobu dołączonego obszaru roboczego. ciąg
obszar roboczy Lokalizacja dołączonego obszaru roboczego. ciąg
IdentyfikatorZasobuPrzestrzeniRoboczej Identyfikator zasobu dołączonego obszaru roboczego. ciąg

Właściwości TrafficAnalyticsProperties

Nazwa Opis Wartość
networkWatcherFlowAnalyticsConfiguration Parametry definiujące konfigurację analizy ruchu. TrafficAnalyticsConfigurationProperties

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

Typ zasobu networkWatchers/flowLogs można wdrożyć przy użyciu operacji docelowych:

  • Grupy zasobów Listę zmienionych właściwości w każdej wersji API można znaleźć w dzienniku zmian.

Przykłady użycia

Przykłady programu Terraform

Podstawowy przykład wdrażania dziennika przepływu usługi Network Watcher.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "eastus2"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "virtualNetwork" {
  type      = "Microsoft.Network/virtualNetworks@2022-07-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    properties = {
      addressSpace = {
        addressPrefixes = [
          "10.0.0.0/16",
        ]
      }
      dhcpOptions = {
        dnsServers = [
        ]
      }
      subnets = [
      ]
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
  lifecycle {
    ignore_changes = [body.properties.subnets]
  }
}

resource "azapi_resource" "networkWatchers" {
  type      = "Microsoft.Network/networkWatchers@2023-11-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    properties = {
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "storageAccount" {
  type      = "Microsoft.Storage/storageAccounts@2021-09-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    kind = "StorageV2"
    properties = {
      accessTier                   = "Hot"
      allowBlobPublicAccess        = true
      allowCrossTenantReplication  = true
      allowSharedKeyAccess         = true
      defaultToOAuthAuthentication = false
      encryption = {
        keySource = "Microsoft.Storage"
        services = {
          queue = {
            keyType = "Service"
          }
          table = {
            keyType = "Service"
          }
        }
      }
      isHnsEnabled      = false
      isNfsV3Enabled    = false
      isSftpEnabled     = false
      minimumTlsVersion = "TLS1_2"
      networkAcls = {
        defaultAction = "Allow"
      }
      publicNetworkAccess      = "Enabled"
      supportsHttpsTrafficOnly = true
    }
    sku = {
      name = "Standard_LRS"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "flowLog" {
  type      = "Microsoft.Network/networkWatchers/flowLogs@2023-11-01"
  name      = var.resource_name
  location  = var.location
  parent_id = azapi_resource.networkWatchers.id

  body = {
    properties = {
      enabled = true
      flowAnalyticsConfiguration = {
        networkWatcherFlowAnalyticsConfiguration = {
          enabled = false
        }
      }
      format = {
        type    = "JSON"
        version = 2
      }
      retentionPolicy = {
        days    = 7
        enabled = true
      }
      storageId        = azapi_resource.storageAccount.id
      targetResourceId = azapi_resource.virtualNetwork.id
    }
  }
}

Format zasobu

Aby utworzyć zasób Microsoft.Network/networkWatchers/flowLogs, dodaj następujący program Terraform do szablonu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/networkWatchers/flowLogs@2020-04-01"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      enabled = bool
      flowAnalyticsConfiguration = {
        networkWatcherFlowAnalyticsConfiguration = {
          enabled = bool
          trafficAnalyticsInterval = int
          workspaceId = "string"
          workspaceRegion = "string"
          workspaceResourceId = "string"
        }
      }
      format = {
        type = "string"
        version = int
      }
      retentionPolicy = {
        days = int
        enabled = bool
      }
      storageId = "string"
      targetResourceId = "string"
    }
  }
}

Wartości właściwości

Microsoft.Network/networkWatchers/flowLogs

Nazwa Opis Wartość
lokalizacja Lokalizacja zasobu. ciąg
nazwa Nazwa zasobu ciąg (wymagany)
parent_id (identyfikator rodzica) Identyfikator zasobu, który jest elementem nadrzędnym dla tego zasobu. Identyfikator zasobu typu: networkWatchers
Właściwości Właściwości dziennika przepływu. FlowLogPropertiesFormat (Format właściwości dziennika przepływu)
Tagi Tagi zasobów Słownik nazw tagów i wartości.
typ Typ zasobu "Microsoft.Network/networkWatchers/flowLogs@2020-04-01"

Parametry formatu przepływu

Nazwa Opis Wartość
typ Typ pliku dziennika przepływu. "JSON"
wersja Wersja (poprawka) dziennika przepływu. Int

FlowLogPropertiesFormat (Format właściwości dziennika przepływu)

Nazwa Opis Wartość
Włączone Flaga włączania/wyłączania rejestrowania przepływu. Bool
flowAnalyticsConfiguration (konfiguracja analizy) Parametry definiujące konfigurację analizy ruchu. Właściwości TrafficAnalyticsProperties
formatowanie Parametry definiujące format dziennika przepływu. Parametry formatu przepływu
Polityka przechowywania Parametry definiujące zasady przechowywania dziennika przepływu. RetentionPolicyParameters (Parametry polityki przechowywania)
storageId (identyfikator magazynu) Identyfikator konta magazynu używanego do przechowywania dziennika przepływu. ciąg (wymagany)
IdentyfikatorZasobuDocelowego Identyfikator sieciowej grupy zabezpieczeń, do której zostanie zastosowany dziennik przepływu. ciąg (wymagany)

Tagi zasobów

Nazwa Opis Wartość

RetentionPolicyParameters (Parametry polityki przechowywania)

Nazwa Opis Wartość
Dni Liczba dni przechowywania rekordów dziennika przepływu. Int
Włączone Flaga włączania/wyłączania przechowywania. Bool

TrafficAnalyticsConfigurationProperties

Nazwa Opis Wartość
Włączone Flaga umożliwiająca włączanie/wyłączanie analizy ruchu. Bool
trafficAnalyticsInterwał Interwał w minutach, który decyduje, jak często usługa TA powinna wykonywać analizę przepływu. Int
Identyfikator przestrzeni roboczej (workspaceId) Identyfikator GUID zasobu dołączonego obszaru roboczego. ciąg
obszar roboczy Lokalizacja dołączonego obszaru roboczego. ciąg
IdentyfikatorZasobuPrzestrzeniRoboczej Identyfikator zasobu dołączonego obszaru roboczego. ciąg

Właściwości TrafficAnalyticsProperties

Nazwa Opis Wartość
networkWatcherFlowAnalyticsConfiguration Parametry definiujące konfigurację analizy ruchu. TrafficAnalyticsConfigurationProperties