Dela via


Microsoft.Network networkWatchers/packetCaptures 2024-05-01

Bicep-resursdefinition

Resurstypen networkWatchers/packetCaptures kan distribueras med åtgärder som mål:

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.Network/networkWatchers/packetCaptures-resurs lägger du till följande Bicep i mallen.

resource symbolicname 'Microsoft.Network/networkWatchers/packetCaptures@2024-05-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    bytesToCapturePerPacket: int
    captureSettings: {
      fileCount: int
      fileSizeInBytes: int
      sessionTimeLimitInSeconds: int
    }
    continuousCapture: bool
    filters: [
      {
        localIPAddress: 'string'
        localPort: 'string'
        protocol: 'string'
        remoteIPAddress: 'string'
        remotePort: 'string'
      }
    ]
    scope: {
      exclude: [
        'string'
      ]
      include: [
        'string'
      ]
    }
    storageLocation: {
      filePath: 'string'
      localPath: 'string'
      storageId: 'string'
      storagePath: 'string'
    }
    target: 'string'
    targetType: 'string'
    timeLimitInSeconds: int
    totalBytesPerSession: int
  }
}

Egenskapsvärden

Microsoft.Network/networkWatchers/packetCaptures

Namn Beskrivning Värde
Namn Resursnamnet sträng (krävs)
förälder I Bicep kan du ange den överordnade resursen för en underordnad resurs. Du behöver bara lägga till den här egenskapen när den underordnade resursen deklareras utanför den överordnade resursen.

Mer information finns i Underordnad resurs utanför den överordnade resursen.
Symboliskt namn för resurs av typen: networkWatchers
Egenskaper Egenskaper för paketinsamlingen. PacketCaptureParametersOrPacketCaptureResultProperties (krävs)

PacketCaptureFilter

Namn Beskrivning Värde
localIPAddress Lokal IP-adress som ska filtreras på. Notation: "127.0.0.1" för enkel adresspost. "127.0.0.1-127.0.0.255" för intervall. "127.0.0.1; 127.0.0.5"? för flera poster. Flera intervall stöds inte för närvarande. Blandningsintervall med flera poster stöds för närvarande inte. Standard = null. sträng
localPort Lokal port som ska filtreras på. Notation: "80" för enkel portinmatning. 80-85" för intervall. "80; 443;" för flera poster. Flera intervall stöds inte för närvarande. Blandningsintervall med flera poster stöds för närvarande inte. Standard = null. sträng
protokoll Protokoll som ska filtreras på. "Alla"
"TCP"
"UDP"
remoteIPAddress Lokal IP-adress som ska filtreras på. Notation: "127.0.0.1" för enkel adresspost. "127.0.0.1-127.0.0.255" för intervall. "127.0.0.1; 127.0.0.5;" för flera poster. Flera intervall stöds inte för närvarande. Blandningsintervall med flera poster stöds för närvarande inte. Standard = null. sträng
remotePort Fjärrport som ska filtreras på. Notation: "80" för enkel portinmatning. 80-85" för intervall. "80; 443;" för flera poster. Flera intervall stöds inte för närvarande. Blandningsintervall med flera poster stöds för närvarande inte. Standard = null. sträng

PacketCaptureMachineScope

Namn Beskrivning Värde
utesluta Lista över AzureVMSS-instanser som måste undantas från AzureVMSS från att köra paketinsamling. string[]
inbegripa Lista över AzureVMSS-instanser som paketinsamling ska köras på. string[]

PacketCaptureParametersOrPacketCaptureResultProperties

Namn Beskrivning Värde
bytesToCapturePerPacket Antalet byte som samlas in per paket, de återstående byteen trunkeras. Int

Begränsningar:
Minsta värde = 0
Maxvärde = 4294967295
captureSettings Avbildningsinställningen innehåller värdena "FileCount", "FileSizeInBytes", "SessionTimeLimitInSeconds". PacketCaptureSettings
continuousCapture Den här kontinuerliga avbildningen är ett booleskt värde som kan innehålla värdet null, true eller false. Om vi inte skickar den här parametern skulle det betraktas som "null", standardvärdet är "null". Bool
Filter En lista över paketinsamlingsfilter. PacketCaptureFilter[]
omfattning En lista över AzureVMSS-instanser som kan inkluderas eller exkluderas för att köra paketinsamling. Om både inkluderad och exkluderad är tom körs paketinsamlingen på alla instanser av AzureVMSS. PacketCaptureMachineScope
storageLocation Lagringsplatsen för en paketinsamlingssession. PacketCaptureStorageLocation (krävs)
mål ID:t för målresursen, endast AzureVM och AzureVMSS som måltyp stöds för närvarande. sträng (krävs)
targetType Måltyp för den angivna resursen. "AzureVM"
"AzureVMSS"
timeLimitInSeconds Maximal varaktighet för avbildningssessionen i sekunder. Int

Begränsningar:
Minsta värde = 0
Maxvärde = 18000
totalBytesPerSession Maximal storlek på avbildningsutdata. Int

Begränsningar:
Minsta värde = 0
Maxvärde = 4294967295

PacketCaptureSettings

Namn Beskrivning Värde
fileCount Antal filer. Standardvärdet för antal är 10 och det maximala antalet är 1 0000. Int

Begränsningar:
Minsta värde = 0
Maxvärde = 10000
fileSizeInBytes Antal insamlade byte per paket. Standardvärde i byte 104857600 (100 MB) och maximalt i byte 4294967295 (4 GB). Int

Begränsningar:
Minsta värde = 0
Maxvärde = 4294967295
sessionTimeLimitInSeconds Maximal varaktighet för avbildningssessionen i sekunder är 604800s (7 dagar) för en fil. Standardvärde under andra 86400-talet (1 dag). Int

Begränsningar:
Minsta värde = 0
Maxvärde = 604800

PacketCaptureStorageLocation

Namn Beskrivning Värde
filePath Den här sökvägen är ogiltig om "Kontinuerlig avbildning" tillhandahålls med "true" eller "false". En giltig lokal sökväg på den virtuella måldatorn. Måste innehålla namnet på avbildningsfilen (*.cap). För den virtuella Linux-datorn måste den börja med /var/captures. Krävs om inget lagrings-ID anges, annars valfritt. sträng
localPath Den här sökvägen är giltig om "Kontinuerlig avbildning" tillhandahålls med "true" eller "false" och krävs om inget lagrings-ID anges, annars valfritt. Måste innehålla namnet på avbildningsfilen (*.cap). För den virtuella Linux-datorn måste den börja med /var/captures. sträng
storageId ID:t för lagringskontot för att spara paketinsamlingssessionen. Krävs om ingen localPath eller filePath tillhandahålls. sträng
storagePath URI:n för lagringssökvägen för att spara paketinsamlingen. Måste vara en välformulerad URI som beskriver platsen för att spara paketinsamlingen. sträng

Resursdefinition för ARM-mall

Resurstypen networkWatchers/packetCaptures kan distribueras med åtgärder som mål:

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.Network/networkWatchers/packetCaptures-resurs lägger du till följande JSON i mallen.

{
  "type": "Microsoft.Network/networkWatchers/packetCaptures",
  "apiVersion": "2024-05-01",
  "name": "string",
  "properties": {
    "bytesToCapturePerPacket": "int",
    "captureSettings": {
      "fileCount": "int",
      "fileSizeInBytes": "int",
      "sessionTimeLimitInSeconds": "int"
    },
    "continuousCapture": "bool",
    "filters": [
      {
        "localIPAddress": "string",
        "localPort": "string",
        "protocol": "string",
        "remoteIPAddress": "string",
        "remotePort": "string"
      }
    ],
    "scope": {
      "exclude": [ "string" ],
      "include": [ "string" ]
    },
    "storageLocation": {
      "filePath": "string",
      "localPath": "string",
      "storageId": "string",
      "storagePath": "string"
    },
    "target": "string",
    "targetType": "string",
    "timeLimitInSeconds": "int",
    "totalBytesPerSession": "int"
  }
}

Egenskapsvärden

Microsoft.Network/networkWatchers/packetCaptures

Namn Beskrivning Värde
apiVersion API-versionen '2024-05-01'
Namn Resursnamnet sträng (krävs)
Egenskaper Egenskaper för paketinsamlingen. PacketCaptureParametersOrPacketCaptureResultProperties (krävs)
typ Resurstypen "Microsoft.Network/networkWatchers/packetCaptures"

PacketCaptureFilter

Namn Beskrivning Värde
localIPAddress Lokal IP-adress som ska filtreras på. Notation: "127.0.0.1" för enkel adresspost. "127.0.0.1-127.0.0.255" för intervall. "127.0.0.1; 127.0.0.5"? för flera poster. Flera intervall stöds inte för närvarande. Blandningsintervall med flera poster stöds för närvarande inte. Standard = null. sträng
localPort Lokal port som ska filtreras på. Notation: "80" för enkel portinmatning. 80-85" för intervall. "80; 443;" för flera poster. Flera intervall stöds inte för närvarande. Blandningsintervall med flera poster stöds för närvarande inte. Standard = null. sträng
protokoll Protokoll som ska filtreras på. "Alla"
"TCP"
"UDP"
remoteIPAddress Lokal IP-adress som ska filtreras på. Notation: "127.0.0.1" för enkel adresspost. "127.0.0.1-127.0.0.255" för intervall. "127.0.0.1; 127.0.0.5;" för flera poster. Flera intervall stöds inte för närvarande. Blandningsintervall med flera poster stöds för närvarande inte. Standard = null. sträng
remotePort Fjärrport som ska filtreras på. Notation: "80" för enkel portinmatning. 80-85" för intervall. "80; 443;" för flera poster. Flera intervall stöds inte för närvarande. Blandningsintervall med flera poster stöds för närvarande inte. Standard = null. sträng

PacketCaptureMachineScope

Namn Beskrivning Värde
utesluta Lista över AzureVMSS-instanser som måste undantas från AzureVMSS från att köra paketinsamling. string[]
inbegripa Lista över AzureVMSS-instanser som paketinsamling ska köras på. string[]

PacketCaptureParametersOrPacketCaptureResultProperties

Namn Beskrivning Värde
bytesToCapturePerPacket Antalet byte som samlas in per paket, de återstående byteen trunkeras. Int

Begränsningar:
Minsta värde = 0
Maxvärde = 4294967295
captureSettings Avbildningsinställningen innehåller värdena "FileCount", "FileSizeInBytes", "SessionTimeLimitInSeconds". PacketCaptureSettings
continuousCapture Den här kontinuerliga avbildningen är ett booleskt värde som kan innehålla värdet null, true eller false. Om vi inte skickar den här parametern skulle det betraktas som "null", standardvärdet är "null". Bool
Filter En lista över paketinsamlingsfilter. PacketCaptureFilter[]
omfattning En lista över AzureVMSS-instanser som kan inkluderas eller exkluderas för att köra paketinsamling. Om både inkluderad och exkluderad är tom körs paketinsamlingen på alla instanser av AzureVMSS. PacketCaptureMachineScope
storageLocation Lagringsplatsen för en paketinsamlingssession. PacketCaptureStorageLocation (krävs)
mål ID:t för målresursen, endast AzureVM och AzureVMSS som måltyp stöds för närvarande. sträng (krävs)
targetType Måltyp för den angivna resursen. "AzureVM"
"AzureVMSS"
timeLimitInSeconds Maximal varaktighet för avbildningssessionen i sekunder. Int

Begränsningar:
Minsta värde = 0
Maxvärde = 18000
totalBytesPerSession Maximal storlek på avbildningsutdata. Int

Begränsningar:
Minsta värde = 0
Maxvärde = 4294967295

PacketCaptureSettings

Namn Beskrivning Värde
fileCount Antal filer. Standardvärdet för antal är 10 och det maximala antalet är 1 0000. Int

Begränsningar:
Minsta värde = 0
Maxvärde = 10000
fileSizeInBytes Antal insamlade byte per paket. Standardvärde i byte 104857600 (100 MB) och maximalt i byte 4294967295 (4 GB). Int

Begränsningar:
Minsta värde = 0
Maxvärde = 4294967295
sessionTimeLimitInSeconds Maximal varaktighet för avbildningssessionen i sekunder är 604800s (7 dagar) för en fil. Standardvärde under andra 86400-talet (1 dag). Int

Begränsningar:
Minsta värde = 0
Maxvärde = 604800

PacketCaptureStorageLocation

Namn Beskrivning Värde
filePath Den här sökvägen är ogiltig om "Kontinuerlig avbildning" tillhandahålls med "true" eller "false". En giltig lokal sökväg på den virtuella måldatorn. Måste innehålla namnet på avbildningsfilen (*.cap). För den virtuella Linux-datorn måste den börja med /var/captures. Krävs om inget lagrings-ID anges, annars valfritt. sträng
localPath Den här sökvägen är giltig om "Kontinuerlig avbildning" tillhandahålls med "true" eller "false" och krävs om inget lagrings-ID anges, annars valfritt. Måste innehålla namnet på avbildningsfilen (*.cap). För den virtuella Linux-datorn måste den börja med /var/captures. sträng
storageId ID:t för lagringskontot för att spara paketinsamlingssessionen. Krävs om ingen localPath eller filePath tillhandahålls. sträng
storagePath URI:n för lagringssökvägen för att spara paketinsamlingen. Måste vara en välformulerad URI som beskriver platsen för att spara paketinsamlingen. sträng

Resursdefinition för Terraform (AzAPI-provider)

Resurstypen networkWatchers/packetCaptures kan distribueras med åtgärder som mål:

  • Resursgrupper

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.Network/networkWatchers/packetCaptures-resurs lägger du till följande Terraform i mallen.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/networkWatchers/packetCaptures@2024-05-01"
  name = "string"
  body = jsonencode({
    properties = {
      bytesToCapturePerPacket = int
      captureSettings = {
        fileCount = int
        fileSizeInBytes = int
        sessionTimeLimitInSeconds = int
      }
      continuousCapture = bool
      filters = [
        {
          localIPAddress = "string"
          localPort = "string"
          protocol = "string"
          remoteIPAddress = "string"
          remotePort = "string"
        }
      ]
      scope = {
        exclude = [
          "string"
        ]
        include = [
          "string"
        ]
      }
      storageLocation = {
        filePath = "string"
        localPath = "string"
        storageId = "string"
        storagePath = "string"
      }
      target = "string"
      targetType = "string"
      timeLimitInSeconds = int
      totalBytesPerSession = int
    }
  })
}

Egenskapsvärden

Microsoft.Network/networkWatchers/packetCaptures

Namn Beskrivning Värde
Namn Resursnamnet sträng (krävs)
parent_id ID för resursen som är överordnad för den här resursen. ID för resurs av typen: networkWatchers
Egenskaper Egenskaper för paketinsamlingen. PacketCaptureParametersOrPacketCaptureResultProperties (krävs)
typ Resurstypen "Microsoft.Network/networkWatchers/packetCaptures@2024-05-01"

PacketCaptureFilter

Namn Beskrivning Värde
localIPAddress Lokal IP-adress som ska filtreras på. Notation: "127.0.0.1" för enkel adresspost. "127.0.0.1-127.0.0.255" för intervall. "127.0.0.1; 127.0.0.5"? för flera poster. Flera intervall stöds inte för närvarande. Blandningsintervall med flera poster stöds för närvarande inte. Standard = null. sträng
localPort Lokal port som ska filtreras på. Notation: "80" för enkel portinmatning. 80-85" för intervall. "80; 443;" för flera poster. Flera intervall stöds inte för närvarande. Blandningsintervall med flera poster stöds för närvarande inte. Standard = null. sträng
protokoll Protokoll som ska filtreras på. "Alla"
"TCP"
"UDP"
remoteIPAddress Lokal IP-adress som ska filtreras på. Notation: "127.0.0.1" för enkel adresspost. "127.0.0.1-127.0.0.255" för intervall. "127.0.0.1; 127.0.0.5;" för flera poster. Flera intervall stöds inte för närvarande. Blandningsintervall med flera poster stöds för närvarande inte. Standard = null. sträng
remotePort Fjärrport som ska filtreras på. Notation: "80" för enkel portinmatning. 80-85" för intervall. "80; 443;" för flera poster. Flera intervall stöds inte för närvarande. Blandningsintervall med flera poster stöds för närvarande inte. Standard = null. sträng

PacketCaptureMachineScope

Namn Beskrivning Värde
utesluta Lista över AzureVMSS-instanser som måste undantas från AzureVMSS från att köra paketinsamling. string[]
inbegripa Lista över AzureVMSS-instanser som paketinsamling ska köras på. string[]

PacketCaptureParametersOrPacketCaptureResultProperties

Namn Beskrivning Värde
bytesToCapturePerPacket Antalet byte som samlas in per paket, de återstående byteen trunkeras. Int

Begränsningar:
Minsta värde = 0
Maxvärde = 4294967295
captureSettings Avbildningsinställningen innehåller värdena "FileCount", "FileSizeInBytes", "SessionTimeLimitInSeconds". PacketCaptureSettings
continuousCapture Den här kontinuerliga avbildningen är ett booleskt värde som kan innehålla värdet null, true eller false. Om vi inte skickar den här parametern skulle det betraktas som "null", standardvärdet är "null". Bool
Filter En lista över paketinsamlingsfilter. PacketCaptureFilter[]
omfattning En lista över AzureVMSS-instanser som kan inkluderas eller exkluderas för att köra paketinsamling. Om både inkluderad och exkluderad är tom körs paketinsamlingen på alla instanser av AzureVMSS. PacketCaptureMachineScope
storageLocation Lagringsplatsen för en paketinsamlingssession. PacketCaptureStorageLocation (krävs)
mål ID:t för målresursen, endast AzureVM och AzureVMSS som måltyp stöds för närvarande. sträng (krävs)
targetType Måltyp för den angivna resursen. "AzureVM"
"AzureVMSS"
timeLimitInSeconds Maximal varaktighet för avbildningssessionen i sekunder. Int

Begränsningar:
Minsta värde = 0
Maxvärde = 18000
totalBytesPerSession Maximal storlek på avbildningsutdata. Int

Begränsningar:
Minsta värde = 0
Maxvärde = 4294967295

PacketCaptureSettings

Namn Beskrivning Värde
fileCount Antal filer. Standardvärdet för antal är 10 och det maximala antalet är 1 0000. Int

Begränsningar:
Minsta värde = 0
Maxvärde = 10000
fileSizeInBytes Antal insamlade byte per paket. Standardvärde i byte 104857600 (100 MB) och maximalt i byte 4294967295 (4 GB). Int

Begränsningar:
Minsta värde = 0
Maxvärde = 4294967295
sessionTimeLimitInSeconds Maximal varaktighet för avbildningssessionen i sekunder är 604800s (7 dagar) för en fil. Standardvärde under andra 86400-talet (1 dag). Int

Begränsningar:
Minsta värde = 0
Maxvärde = 604800

PacketCaptureStorageLocation

Namn Beskrivning Värde
filePath Den här sökvägen är ogiltig om "Kontinuerlig avbildning" tillhandahålls med "true" eller "false". En giltig lokal sökväg på den virtuella måldatorn. Måste innehålla namnet på avbildningsfilen (*.cap). För den virtuella Linux-datorn måste den börja med /var/captures. Krävs om inget lagrings-ID anges, annars valfritt. sträng
localPath Den här sökvägen är giltig om "Kontinuerlig avbildning" tillhandahålls med "true" eller "false" och krävs om inget lagrings-ID anges, annars valfritt. Måste innehålla namnet på avbildningsfilen (*.cap). För den virtuella Linux-datorn måste den börja med /var/captures. sträng
storageId ID:t för lagringskontot för att spara paketinsamlingssessionen. Krävs om ingen localPath eller filePath tillhandahålls. sträng
storagePath URI:n för lagringssökvägen för att spara paketinsamlingen. Måste vara en välformulerad URI som beskriver platsen för att spara paketinsamlingen. sträng