Freigeben über

Microsoft.Network networkWatchers/packetCaptures

  • Artikel

Bicep-Ressourcendefinition

Der Ressourcentyp networkWatchers/packetCaptures kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie im Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.Network/networkWatchers/packetCaptures-Ressource zu erstellen, fügen Sie der Vorlage den folgenden Bicep hinzu.

resource symbolicname 'Microsoft.Network/networkWatchers/packetCaptures@2023-11-01' = {
  name: 'string'
  parent: resourceSymbolicName
  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
  }
}

Eigenschaftswerte

networkWatchers/packetCaptures

Name BESCHREIBUNG Wert
name Der Ressourcenname

Weitere Informationen finden Sie unter Festlegen von Namen und Typen für untergeordnete Ressourcen in Bicep.		 Zeichenfolge (erforderlich)
parent In Bicep können Sie die übergeordnete Ressource für eine untergeordnete Ressource angeben. Sie müssen diese Eigenschaft nur hinzufügen, wenn die untergeordnete Ressource außerhalb der übergeordneten Ressource deklariert wird.

Weitere Informationen finden Sie unter Untergeordnete Ressource außerhalb der übergeordneten Ressource.		 Symbolischer Name für Ressource vom Typ: networkWatchers
properties Eigenschaften der Paketerfassung. PacketCaptureParametersOrPacketCaptureResultProperti... (erforderlich)

PacketCaptureParametersOrPacketCaptureResultProperti...

Name BESCHREIBUNG Wert
bytesToCapturePerPacket Anzahl der pro Paket erfassten Bytes, die verbleibenden Bytes werden abgeschnitten. INT

Einschränkungen:
Minimaler Wert = 0
Max. Wert = 4294967295
captureSettings Die Erfassungseinstellung enthält die Werte "FileCount", "FileSizeInBytes", "SessionTimeLimitInSeconds". PacketCaptureSettings
continuousCapture Diese fortlaufende Erfassung ist ein boolescher Nullable-Wert, der den Wert "null", "true" oder "false" enthalten kann. Wenn wir diesen Parameter nicht übergeben, wird er als "NULL" betrachtet, der Standardwert ist "NULL". bool
Filter Eine Liste von Paketerfassungsfiltern. PacketCaptureFilter[]
scope Eine Liste der AzureVMSS-Instanzen, die zum Ausführen der Paketerfassung eingeschlossen oder ausgeschlossen werden können. Wenn sowohl eingeschlossene als auch ausgeschlossene leer sind, wird die Paketerfassung auf allen Instanzen von AzureVMSS ausgeführt. PacketCaptureMachineScope
storageLocation Der Speicherort für eine Paketerfassungssitzung. PacketCaptureStorageLocation (erforderlich)
target Die ID der Zielressource, nur AzureVM und AzureVMSS als Zieltyp werden derzeit unterstützt. Zeichenfolge (erforderlich)
targetType Zieltyp der bereitgestellten Ressource. "AzureVM"
"AzureVMSS"
timeLimitInSeconds Maximale Dauer der Aufzeichnungssitzung in Sekunden. INT

Einschränkungen:
Minimaler Wert = 0
Maximaler Wert = 18000
totalBytesPerSession Maximale Größe der Aufzeichnungsausgabe. INT

Einschränkungen:
Minimaler Wert = 0
Max. Wert = 4294967295

PacketCaptureSettings

Name BESCHREIBUNG Wert
fileCount Anzahl der Dateien. Der Standardwert für die Anzahl ist 10 und die maximale Anzahl 10000. INT

Einschränkungen:
Minimaler Wert = 0
Maximaler Wert = 10000
fileSizeInBytes Anzahl der erfassten Bytes pro Paket. Standardwert in Bytes 104857600 (100 MB) und maximal in Bytes 4294967295 (4 GB). INT

Einschränkungen:
Min-Wert = 0
Max. Wert = 4294967295
sessionTimeLimitInSeconds Die maximale Dauer der Aufzeichnungssitzung in Sekunden beträgt 604800s (7 Tage) für eine Datei. Standardwert in sekunden 86400s (1 Tag). INT

Einschränkungen:
Min-Wert = 0
Maximaler Wert = 604800

PacketCaptureFilter

Name BESCHREIBUNG Wert
localIPAddress Lokale IP-Adresse, nach der gefiltert werden soll. Notation: "127.0.0.1" für einzelne Adresseingaben. "127.0.0.1-127.0.0.255" für Bereich. "127.0.0.1; 127.0.0.5"? für mehrere Einträge. Mehrere Bereiche werden derzeit nicht unterstützt. Mischen von Bereichen mit mehreren Einträgen wird derzeit nicht unterstützt. Standardwert = NULL. Zeichenfolge
localPort Lokaler Port, nach dem gefiltert werden soll. Notation: "80" für den Einzelnen Porteintrag." 80-85" für den Bereich. "80; 443;" für mehrere Einträge. Mehrere Bereiche werden derzeit nicht unterstützt. Mischen von Bereichen mit mehreren Einträgen wird derzeit nicht unterstützt. Standardwert = NULL. Zeichenfolge
Protokoll Protokoll, nach dem gefiltert werden soll. "Beliebige"
"TCP"
"UDP"
remoteIPAddress Lokale IP-Adresse, nach der gefiltert werden soll. Notation: "127.0.0.1" für einzelne Adresseingaben. "127.0.0.1-127.0.0.255" für Bereich. "127.0.0.1; 127.0.0.5;" für mehrere Einträge. Mehrere Bereiche werden derzeit nicht unterstützt. Mischen von Bereichen mit mehreren Einträgen wird derzeit nicht unterstützt. Standardwert = NULL. Zeichenfolge
remotePort Remoteport, nach dem gefiltert werden soll. Notation: "80" für den Einzelnen Porteintrag." 80-85" für den Bereich. "80; 443;" für mehrere Einträge. Mehrere Bereiche werden derzeit nicht unterstützt. Mischen von Bereichen mit mehreren Einträgen wird derzeit nicht unterstützt. Standardwert = NULL. Zeichenfolge

PacketCaptureMachineScope

Name BESCHREIBUNG Wert
Ausschließen Liste der AzureVMSS-Instanzen, die von azureVMSS von der Ausführung der Paketerfassung ausgeschlossen werden müssen. string[]
include Liste der AzureVMSS-Instanzen, für die die Paketerfassung ausgeführt werden soll. string[]

PacketCaptureStorageLocation

Name BESCHREIBUNG Wert
filePath Dieser Pfad ist ungültig, wenn "Continuous Capture" mit "true" oder "false" angegeben wird. Ein gültiger lokaler Pfad auf der Ziel-VM. Muss den Namen der Erfassungsdatei (*.cap) enthalten. Für virtuelle Linux-Computer muss er mit /var/captures beginnen. Erforderlich, wenn keine Speicher-ID angegeben wird, andernfalls optional. Zeichenfolge
Localpath Dieser Pfad ist gültig, wenn "Continuous Capture" mit "true" oder "false" angegeben wird und erforderlich ist, wenn keine Speicher-ID angegeben wird, andernfalls optional. Muss den Namen der Erfassungsdatei (*.cap) enthalten. Für virtuelle Linux-Computer muss er mit /var/captures beginnen. Zeichenfolge
storageId Die ID des Speicherkontos zum Speichern der Paketerfassungssitzung. Erforderlich, wenn kein localPath oder filePath bereitgestellt wird. Zeichenfolge
storagePath Der URI des Speicherpfads zum Speichern der Paketerfassung. Es muss sich um einen wohlgeformten URI handeln, der den Speicherort zum Speichern der Paketerfassung beschreibt. Zeichenfolge

Ressourcendefinition mit einer ARM-Vorlage

Der ressourcentyp networkWatchers/packetCaptures kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.Network/networkWatchers/packetCaptures-Ressource zu erstellen, fügen Sie der Vorlage den folgenden JSON-Code hinzu.

{
  "type": "Microsoft.Network/networkWatchers/packetCaptures",
  "apiVersion": "2023-11-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"
  }
}

Eigenschaftswerte

networkWatchers/packetCaptures

Name BESCHREIBUNG Wert
type Der Ressourcentyp "Microsoft.Network/networkWatchers/packetCaptures"
apiVersion Die Version der Ressourcen-API '2023-11-01'
name Der Ressourcenname

Weitere Informationen finden Sie unter Festlegen von Namen und Typen für untergeordnete Ressourcen in JSON-ARM-Vorlagen.		 Zeichenfolge (erforderlich)
properties Eigenschaften der Paketerfassung. PacketCaptureParametersOrPacketCaptureResultProperti... (erforderlich)

PacketCaptureParametersOrPacketCaptureResultProperti...

Name BESCHREIBUNG Wert
bytesToCapturePerPacket Anzahl der pro Paket erfassten Bytes, die verbleibenden Bytes werden abgeschnitten. INT

Einschränkungen:
Minimaler Wert = 0
Max. Wert = 4294967295
captureSettings Die Erfassungseinstellung enthält die Werte "FileCount", "FileSizeInBytes", "SessionTimeLimitInSeconds". PacketCaptureSettings
continuousCapture Diese fortlaufende Erfassung ist ein boolescher Nullable-Wert, der den Wert "null", "true" oder "false" enthalten kann. Wenn wir diesen Parameter nicht übergeben, wird er als "NULL" betrachtet, der Standardwert ist "NULL". bool
Filter Eine Liste von Paketerfassungsfiltern. PacketCaptureFilter[]
scope Eine Liste der AzureVMSS-Instanzen, die zum Ausführen der Paketerfassung eingeschlossen oder ausgeschlossen werden können. Wenn sowohl eingeschlossene als auch ausgeschlossene leer sind, wird die Paketerfassung auf allen Instanzen von AzureVMSS ausgeführt. PacketCaptureMachineScope
storageLocation Der Speicherort für eine Paketerfassungssitzung. PacketCaptureStorageLocation (erforderlich)
target Die ID der Zielressource, nur AzureVM und AzureVMSS als Zieltyp werden derzeit unterstützt. Zeichenfolge (erforderlich)
targetType Zieltyp der bereitgestellten Ressource. "AzureVM"
"AzureVMSS"
timeLimitInSeconds Maximale Dauer der Aufzeichnungssitzung in Sekunden. INT

Einschränkungen:
Minimaler Wert = 0
Maximaler Wert = 18000
totalBytesPerSession Maximale Größe der Aufzeichnungsausgabe. INT

Einschränkungen:
Minimaler Wert = 0
Max. Wert = 4294967295

PacketCaptureSettings

Name BESCHREIBUNG Wert
fileCount Anzahl der Dateien. Der Standardwert für die Anzahl ist 10 und die maximale Anzahl 10000. INT

Einschränkungen:
Minimaler Wert = 0
Maximaler Wert = 10000
fileSizeInBytes Anzahl der pro Paket erfassten Bytes. Standardwert in Bytes 104857600 (100 MB) und maximal in Bytes 4294967295 (4 GB). INT

Einschränkungen:
Minimaler Wert = 0
Max. Wert = 4294967295
sessionTimeLimitInSeconds Die maximale Dauer der Aufzeichnungssitzung in Sekunden beträgt 604800s (7 Tage) für eine Datei. Standardwert im zweiten 86400s (1 Tag). INT

Einschränkungen:
Minimaler Wert = 0
Maximaler Wert = 604800

PacketCaptureFilter

Name BESCHREIBUNG Wert
localIPAddress Lokale IP-Adresse, nach der gefiltert werden soll. Notation: "127.0.0.1" für die Einzelne Adresseingabe. "127.0.0.1-127.0.0.255" für Bereich. "127.0.0.1; 127.0.0.5"? für mehrere Einträge. Mehrere Bereiche werden derzeit nicht unterstützt. Mischen von Bereichen mit mehreren Einträgen wird derzeit nicht unterstützt. Standardwert = NULL. Zeichenfolge
localPort Lokaler Port, nach dem gefiltert werden soll. Notation: "80" für single port entry." 80-85 Zoll für Den Bereich. "80; 443;" für mehrere Einträge. Mehrere Bereiche werden derzeit nicht unterstützt. Mischen von Bereichen mit mehreren Einträgen wird derzeit nicht unterstützt. Standardwert = NULL. Zeichenfolge
Protokoll Protokoll, nach dem gefiltert werden soll. "Beliebig"
"TCP"
"UDP"
remoteIPAddress Lokale IP-Adresse, nach der gefiltert werden soll. Notation: "127.0.0.1" für die Einzelne Adresseingabe. "127.0.0.1-127.0.0.255" für Bereich. "127.0.0.1; 127.0.0.5;" für mehrere Einträge. Mehrere Bereiche werden derzeit nicht unterstützt. Mischen von Bereichen mit mehreren Einträgen wird derzeit nicht unterstützt. Standardwert = NULL. Zeichenfolge
remotePort Remoteport, nach dem gefiltert werden soll. Notation: "80" für single port entry." 80-85 Zoll für Den Bereich. "80; 443;" für mehrere Einträge. Mehrere Bereiche werden derzeit nicht unterstützt. Mischen von Bereichen mit mehreren Einträgen wird derzeit nicht unterstützt. Standardwert = NULL. Zeichenfolge

PacketCaptureMachineScope

Name BESCHREIBUNG Wert
Ausschließen Liste der AzureVMSS-Instanzen, die von azureVMSS von der Ausführung der Paketerfassung ausgeschlossen werden müssen. string[]
include Liste der AzureVMSS-Instanzen, auf denen die Paketerfassung ausgeführt werden soll. string[]

PacketCaptureStorageLocation

Name BESCHREIBUNG Wert
filePath Dieser Pfad ist ungültig, wenn "Continuous Capture" mit "true" oder "false" angegeben wird. Ein gültiger lokaler Pfad auf dem virtuellen Zielcomputer. Muss den Namen der Erfassungsdatei (*.cap) enthalten. Für virtuelle Linux-Computer muss er mit /var/captures beginnen. Erforderlich, wenn keine Speicher-ID angegeben wird, andernfalls optional. Zeichenfolge
Localpath Dieser Pfad ist gültig, wenn "Continuous Capture" mit "true" oder "false" angegeben wird und erforderlich ist, wenn keine Speicher-ID angegeben wird, andernfalls optional. Muss den Namen der Erfassungsdatei (*.cap) enthalten. Für virtuelle Linux-Computer muss er mit /var/captures beginnen. Zeichenfolge
storageId Die ID des Speicherkontos zum Speichern der Paketerfassungssitzung. Erforderlich, wenn kein localPath oder filePath bereitgestellt wird. Zeichenfolge
storagePath Der URI des Speicherpfads zum Speichern der Paketerfassung. Muss ein wohlgeformter URI sein, der den Speicherort zum Speichern der Paketerfassung beschreibt. Zeichenfolge

Terraform-Ressourcendefinition (AzAPI-Anbieter)

Der Ressourcentyp networkWatchers/packetCaptures kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

  • Ressourcengruppen

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie im Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.Network/networkWatchers/packetCaptures-Ressource zu erstellen, fügen Sie der Vorlage die folgende Terraform-Ressource hinzu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/networkWatchers/packetCaptures@2023-11-01"
  name = "string"
  parent_id = "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
    }
  })
}

Eigenschaftswerte

networkWatchers/packetCaptures

Name BESCHREIBUNG Wert
type Der Ressourcentyp "Microsoft.Network/networkWatchers/packetCaptures@2023-11-01"
name Der Ressourcenname Zeichenfolge (erforderlich)
parent_id Die ID der Ressource, die das übergeordnete Element für diese Ressource ist. ID für Ressource vom Typ : networkWatchers
properties Eigenschaften der Paketerfassung. PacketCaptureParametersOrPacketCaptureResultProperti... (erforderlich)

PacketCaptureParametersOrPacketCaptureResultProperti...

Name BESCHREIBUNG Wert
bytesToCapturePerPacket Anzahl der pro Paket erfassten Bytes, die verbleibenden Bytes werden abgeschnitten. INT

Einschränkungen:
Minimaler Wert = 0
Max. Wert = 4294967295
captureSettings Die Erfassungseinstellung enthält die Werte "FileCount", "FileSizeInBytes", "SessionTimeLimitInSeconds". PacketCaptureSettings
continuousCapture Diese fortlaufende Erfassung ist ein boolescher Nullwert, der den Wert "null", "true" oder "false" enthalten kann. Wenn wir diesen Parameter nicht übergeben, wird er als "null" betrachtet, der Standardwert ist "NULL". bool
Filter Eine Liste von Paketerfassungsfiltern. PacketCaptureFilter[]
scope Eine Liste von AzureVMSS-Instanzen, die zum Ausführen der Paketerfassung eingeschlossen oder ausgeschlossen werden können. Wenn sowohl eingeschlossene als auch ausgeschlossene leer sind, wird die Paketerfassung auf allen Instanzen von AzureVMSS ausgeführt. PacketCaptureMachineScope
storageLocation Der Speicherort für eine Paketerfassungssitzung. PacketCaptureStorageLocation (erforderlich)
target Die ID der Zielressource, nur AzureVM und AzureVMSS als Zieltyp werden derzeit unterstützt. Zeichenfolge (erforderlich)
targetType Zieltyp der bereitgestellten Ressource. "AzureVM"
"AzureVMSS"
timeLimitInSeconds Maximale Dauer der Aufzeichnungssitzung in Sekunden. INT

Einschränkungen:
Min-Wert = 0
Maximaler Wert = 18000
totalBytesPerSession Maximale Größe der Aufzeichnungsausgabe. INT

Einschränkungen:
Min-Wert = 0
Max. Wert = 4294967295

PacketCaptureSettings

Name BESCHREIBUNG Wert
fileCount Anzahl der Dateien. Der Standardwert für die Anzahl ist 10 und die maximale Zahl ist 10.000. INT

Einschränkungen:
Min-Wert = 0
Maximaler Wert = 10000
fileSizeInBytes Anzahl der erfassten Bytes pro Paket. Standardwert in Bytes 104857600 (100 MB) und maximal in Bytes 4294967295 (4 GB). INT

Einschränkungen:
Min-Wert = 0
Max. Wert = 4294967295
sessionTimeLimitInSeconds Die maximale Dauer der Aufzeichnungssitzung in Sekunden beträgt 604800s (7 Tage) für eine Datei. Standardwert in sekunden 86400s (1 Tag). INT

Einschränkungen:
Min-Wert = 0
Maximaler Wert = 604800

PacketCaptureFilter

Name BESCHREIBUNG Wert
localIPAddress Lokale IP-Adresse, nach der gefiltert werden soll. Notation: "127.0.0.1" für einzelne Adresseingaben. "127.0.0.1-127.0.0.255" für Bereich. "127.0.0.1; 127.0.0.5"? für mehrere Einträge. Mehrere Bereiche werden derzeit nicht unterstützt. Mischen von Bereichen mit mehreren Einträgen wird derzeit nicht unterstützt. Standardwert = NULL. Zeichenfolge
localPort Lokaler Port, nach dem gefiltert werden soll. Notation: "80" für den Einzelnen Porteintrag." 80-85" für den Bereich. "80; 443;" für mehrere Einträge. Mehrere Bereiche werden derzeit nicht unterstützt. Mischen von Bereichen mit mehreren Einträgen wird derzeit nicht unterstützt. Standardwert = NULL. Zeichenfolge
Protokoll Protokoll, nach dem gefiltert werden soll. "Beliebige"
"TCP"
"UDP"
remoteIPAddress Lokale IP-Adresse, nach der gefiltert werden soll. Notation: "127.0.0.1" für einzelne Adresseingaben. "127.0.0.1-127.0.0.255" für Bereich. "127.0.0.1; 127.0.0.5;" für mehrere Einträge. Mehrere Bereiche werden derzeit nicht unterstützt. Mischen von Bereichen mit mehreren Einträgen wird derzeit nicht unterstützt. Standardwert = NULL. Zeichenfolge
remotePort Remoteport, nach dem gefiltert werden soll. Notation: "80" für den Einzelnen Porteintrag." 80-85" für den Bereich. "80; 443;" für mehrere Einträge. Mehrere Bereiche werden derzeit nicht unterstützt. Mischen von Bereichen mit mehreren Einträgen wird derzeit nicht unterstützt. Standardwert = NULL. Zeichenfolge

PacketCaptureMachineScope

Name BESCHREIBUNG Wert
Ausschließen Liste der AzureVMSS-Instanzen, die von azureVMSS von der Ausführung der Paketerfassung ausgeschlossen werden müssen. string[]
include Liste der AzureVMSS-Instanzen, für die die Paketerfassung ausgeführt werden soll. string[]

PacketCaptureStorageLocation

Name BESCHREIBUNG Wert
filePath Dieser Pfad ist ungültig, wenn "Continuous Capture" mit "true" oder "false" angegeben wird. Ein gültiger lokaler Pfad auf der Ziel-VM. Muss den Namen der Erfassungsdatei (*.cap) enthalten. Für virtuelle Linux-Computer muss er mit /var/captures beginnen. Erforderlich, wenn keine Speicher-ID angegeben wird, andernfalls optional. Zeichenfolge
Localpath Dieser Pfad ist gültig, wenn "Continuous Capture" mit "true" oder "false" angegeben wird und erforderlich ist, wenn keine Speicher-ID angegeben wird, andernfalls optional. Muss den Namen der Erfassungsdatei (*.cap) enthalten. Für virtuelle Linux-Computer muss er mit /var/captures beginnen. Zeichenfolge
storageId Die ID des Speicherkontos zum Speichern der Paketerfassungssitzung. Erforderlich, wenn kein localPath oder filePath bereitgestellt wird. Zeichenfolge
storagePath Der URI des Speicherpfads zum Speichern der Paketerfassung. Es muss sich um einen wohlgeformten URI handeln, der den Speicherort zum Speichern der Paketerfassung beschreibt. Zeichenfolge