Condividi tramite

Microsoft.Network networkWatchers/packetCaptures 2024-01-01

  • Articolo

Definizione di risorsa Bicep

Il tipo di risorsa networkWatchers/packetCaptures può essere distribuito con operazioni destinate a:

  • gruppi di risorse - Vedere i comandi di distribuzione del gruppo di risorse

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.

Formato risorsa

Per creare una risorsa Microsoft.Network/networkWatchers/packetCaptures, aggiungere il bicep seguente al modello.

resource symbolicname 'Microsoft.Network/networkWatchers/packetCaptures@2024-01-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
  }
}

Valori delle proprietà

Microsoft.Network/networkWatchers/packetCaptures

Nome Descrizione Valore
nome Nome della risorsa stringa (obbligatorio)
genitore In Bicep è possibile specificare la risorsa padre per una risorsa figlio. È necessario aggiungere questa proprietà solo quando la risorsa figlio viene dichiarata all'esterno della risorsa padre.

Per altre informazioni, vedere risorsa figlio all'esterno della risorsa padre.		 Nome simbolico per la risorsa di tipo: networkWatchers
proprietà Proprietà dell'acquisizione di pacchetti. PacketCaptureParametersOrPacketCaptureResultProperties (obbligatorio)

PacketCaptureFilter

Nome Descrizione Valore
localIPAddress Indirizzo IP locale da filtrare. Notazione: "127.0.0.1" per la voce di indirizzo singolo. "127.0.0.1-127.0.0.255" per intervallo. "127.0.0.1; 127.0.0.5"? per più voci. Più intervalli non attualmente supportati. Combinazione di intervalli con più voci non attualmente supportate. Valore predefinito = null. corda
localPort Porta locale su cui filtrare. Notazione: "80" per la singola voce di porta". 80-85" per intervallo. "80; 443;" per più voci. Più intervalli non attualmente supportati. Combinazione di intervalli con più voci non attualmente supportate. Valore predefinito = null. corda
protocollo Protocollo da filtrare. 'Any'
'TCP'
'UDP'
remoteIPAddress Indirizzo IP locale da filtrare. Notazione: "127.0.0.1" per la voce di indirizzo singolo. "127.0.0.1-127.0.0.255" per intervallo. "127.0.0.1; 127.0.0.5;" per più voci. Più intervalli non attualmente supportati. Combinazione di intervalli con più voci non attualmente supportate. Valore predefinito = null. corda
remotePort Porta remota su cui filtrare. Notazione: "80" per la singola voce di porta". 80-85" per intervallo. "80; 443;" per più voci. Più intervalli non attualmente supportati. Combinazione di intervalli con più voci non attualmente supportate. Valore predefinito = null. corda

PacketCaptureMachineScope

Nome Descrizione Valore
escludere Elenco di istanze di AzureVMSS che devono essere escluse da AzureVMSS dall'esecuzione dell'acquisizione di pacchetti. string[]
includere Elenco di istanze di AzureVMSS in cui eseguire l'acquisizione di pacchetti. string[]

PacketCaptureParametersOrPacketCaptureResultProperties

Nome Descrizione Valore
bytesToCapturePerPacket Numero di byte acquisiti per pacchetto, i byte rimanenti vengono troncati. Int

Vincoli:
Valore minimo = 0
Valore massimo = 4294967295
captureSettings L'impostazione di acquisizione contiene i valori 'FileCount', 'FileSizeInBytes', 'SessionTimeLimitInSeconds'. PacketCaptureSettings
continuousCapture Questa acquisizione continua è un valore booleano nullable, che può contenere il valore 'null', 'true' o 'false'. Se non si passa questo parametro, verrà considerato come 'null', il valore predefinito è 'null'. Bool
filtri Elenco di filtri di acquisizione pacchetti. packetCaptureFilter[]
portata Elenco di istanze di AzureVMSS che possono essere incluse o escluse per eseguire l'acquisizione di pacchetti. Se sia inclusi che esclusi sono vuoti, l'acquisizione di pacchetti verrà eseguita in tutte le istanze di AzureVMSS. PacketCaptureMachineScope
storageLocation Percorso di archiviazione per una sessione di acquisizione di pacchetti. PacketCaptureStorageLocation (obbligatorio)
bersaglio L'ID della risorsa di destinazione, sono attualmente supportati solo AzureVM e AzureVMSS come tipo di destinazione. stringa (obbligatorio)
targetType Tipo di destinazione della risorsa fornita. 'AzureVM'
'AzureVMSS'
timeLimitInSeconds Durata massima della sessione di acquisizione in secondi. Int

Vincoli:
Valore minimo = 0
Valore massimo = 18000
totalBytesPerSession Dimensioni massime dell'output di acquisizione. Int

Vincoli:
Valore minimo = 0
Valore massimo = 4294967295

PacketCaptureSettings

Nome Descrizione Valore
fileCount Numero di conteggio file. Il valore predefinito del conteggio è 10 e il numero massimo è 10000. Int

Vincoli:
Valore minimo = 0
Valore massimo = 10000
fileSizeInBytes Numero di byte acquisiti per pacchetto. Valore predefinito in byte 104857600 (100 MB) e massimo in byte 4294967295 (4 GB). Int

Vincoli:
Valore minimo = 0
Valore massimo = 4294967295
sessionTimeLimitInSeconds La durata massima della sessione di acquisizione in secondi è 604800s (7 giorni) per un file. Valore predefinito nel secondo 86400s (1 giorno). Int

Vincoli:
Valore minimo = 0
Valore massimo = 604800

PacketCaptureStorageLocation

Nome Descrizione Valore
filePath Questo percorso non è valido se 'Continuous Capture' viene fornito con 'true' o 'false'. Percorso locale valido nella macchina virtuale di destinazione. Deve includere il nome del file di acquisizione (*.cap). Per la macchina virtuale Linux deve iniziare con /var/captures. Obbligatorio se non viene specificato alcun ID di archiviazione, altrimenti facoltativo. corda
localPath Questo percorso è valido se 'Continuous Capture' viene fornito con 'true' o 'false' e obbligatorio se non viene fornito alcun ID di archiviazione, altrimenti facoltativo. Deve includere il nome del file di acquisizione (*.cap). Per la macchina virtuale Linux deve iniziare con /var/captures. corda
storageId ID dell'account di archiviazione per salvare la sessione di acquisizione pacchetti. Obbligatorio se non viene specificato alcun percorso locale o filePath. corda
storagePath URI del percorso di archiviazione per salvare l'acquisizione di pacchetti. Deve essere un URI ben formato che descrive la posizione per salvare l'acquisizione di pacchetti. corda

Definizione di risorsa del modello di Resource Manager

Il tipo di risorsa networkWatchers/packetCaptures può essere distribuito con operazioni destinate a:

  • gruppi di risorse - Vedere i comandi di distribuzione del gruppo di risorse

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.

Formato risorsa

Per creare una risorsa Microsoft.Network/networkWatchers/packetCaptures, aggiungere il codice JSON seguente al modello.

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

Valori delle proprietà

Microsoft.Network/networkWatchers/packetCaptures

Nome Descrizione Valore
apiVersion Versione dell'API '2024-01-01'
nome Nome della risorsa stringa (obbligatorio)
proprietà Proprietà dell'acquisizione di pacchetti. PacketCaptureParametersOrPacketCaptureResultProperties (obbligatorio)
digitare Tipo di risorsa 'Microsoft.Network/networkWatchers/packetCaptures'

PacketCaptureFilter

Nome Descrizione Valore
localIPAddress Indirizzo IP locale da filtrare. Notazione: "127.0.0.1" per la voce di indirizzo singolo. "127.0.0.1-127.0.0.255" per intervallo. "127.0.0.1; 127.0.0.5"? per più voci. Più intervalli non attualmente supportati. Combinazione di intervalli con più voci non attualmente supportate. Valore predefinito = null. corda
localPort Porta locale su cui filtrare. Notazione: "80" per la singola voce di porta". 80-85" per intervallo. "80; 443;" per più voci. Più intervalli non attualmente supportati. Combinazione di intervalli con più voci non attualmente supportate. Valore predefinito = null. corda
protocollo Protocollo da filtrare. 'Any'
'TCP'
'UDP'
remoteIPAddress Indirizzo IP locale da filtrare. Notazione: "127.0.0.1" per la voce di indirizzo singolo. "127.0.0.1-127.0.0.255" per intervallo. "127.0.0.1; 127.0.0.5;" per più voci. Più intervalli non attualmente supportati. Combinazione di intervalli con più voci non attualmente supportate. Valore predefinito = null. corda
remotePort Porta remota su cui filtrare. Notazione: "80" per la singola voce di porta". 80-85" per intervallo. "80; 443;" per più voci. Più intervalli non attualmente supportati. Combinazione di intervalli con più voci non attualmente supportate. Valore predefinito = null. corda

PacketCaptureMachineScope

Nome Descrizione Valore
escludere Elenco di istanze di AzureVMSS che devono essere escluse da AzureVMSS dall'esecuzione dell'acquisizione di pacchetti. string[]
includere Elenco di istanze di AzureVMSS in cui eseguire l'acquisizione di pacchetti. string[]

PacketCaptureParametersOrPacketCaptureResultProperties

Nome Descrizione Valore
bytesToCapturePerPacket Numero di byte acquisiti per pacchetto, i byte rimanenti vengono troncati. Int

Vincoli:
Valore minimo = 0
Valore massimo = 4294967295
captureSettings L'impostazione di acquisizione contiene i valori 'FileCount', 'FileSizeInBytes', 'SessionTimeLimitInSeconds'. PacketCaptureSettings
continuousCapture Questa acquisizione continua è un valore booleano nullable, che può contenere il valore 'null', 'true' o 'false'. Se non si passa questo parametro, verrà considerato come 'null', il valore predefinito è 'null'. Bool
filtri Elenco di filtri di acquisizione pacchetti. packetCaptureFilter[]
portata Elenco di istanze di AzureVMSS che possono essere incluse o escluse per eseguire l'acquisizione di pacchetti. Se sia inclusi che esclusi sono vuoti, l'acquisizione di pacchetti verrà eseguita in tutte le istanze di AzureVMSS. PacketCaptureMachineScope
storageLocation Percorso di archiviazione per una sessione di acquisizione di pacchetti. PacketCaptureStorageLocation (obbligatorio)
bersaglio L'ID della risorsa di destinazione, sono attualmente supportati solo AzureVM e AzureVMSS come tipo di destinazione. stringa (obbligatorio)
targetType Tipo di destinazione della risorsa fornita. 'AzureVM'
'AzureVMSS'
timeLimitInSeconds Durata massima della sessione di acquisizione in secondi. Int

Vincoli:
Valore minimo = 0
Valore massimo = 18000
totalBytesPerSession Dimensioni massime dell'output di acquisizione. Int

Vincoli:
Valore minimo = 0
Valore massimo = 4294967295

PacketCaptureSettings

Nome Descrizione Valore
fileCount Numero di conteggio file. Il valore predefinito del conteggio è 10 e il numero massimo è 10000. Int

Vincoli:
Valore minimo = 0
Valore massimo = 10000
fileSizeInBytes Numero di byte acquisiti per pacchetto. Valore predefinito in byte 104857600 (100 MB) e massimo in byte 4294967295 (4 GB). Int

Vincoli:
Valore minimo = 0
Valore massimo = 4294967295
sessionTimeLimitInSeconds La durata massima della sessione di acquisizione in secondi è 604800s (7 giorni) per un file. Valore predefinito nel secondo 86400s (1 giorno). Int

Vincoli:
Valore minimo = 0
Valore massimo = 604800

PacketCaptureStorageLocation

Nome Descrizione Valore
filePath Questo percorso non è valido se 'Continuous Capture' viene fornito con 'true' o 'false'. Percorso locale valido nella macchina virtuale di destinazione. Deve includere il nome del file di acquisizione (*.cap). Per la macchina virtuale Linux deve iniziare con /var/captures. Obbligatorio se non viene specificato alcun ID di archiviazione, altrimenti facoltativo. corda
localPath Questo percorso è valido se 'Continuous Capture' viene fornito con 'true' o 'false' e obbligatorio se non viene fornito alcun ID di archiviazione, altrimenti facoltativo. Deve includere il nome del file di acquisizione (*.cap). Per la macchina virtuale Linux deve iniziare con /var/captures. corda
storageId ID dell'account di archiviazione per salvare la sessione di acquisizione pacchetti. Obbligatorio se non viene specificato alcun percorso locale o filePath. corda
storagePath URI del percorso di archiviazione per salvare l'acquisizione di pacchetti. Deve essere un URI ben formato che descrive la posizione per salvare l'acquisizione di pacchetti. corda

Definizione di risorsa Terraform (provider AzAPI)

Il tipo di risorsa networkWatchers/packetCaptures può essere distribuito con operazioni destinate a:

  • gruppi di risorse

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.

Formato risorsa

Per creare una risorsa Microsoft.Network/networkWatchers/packetCaptures, aggiungere il formato Terraform seguente al modello.

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

Valori delle proprietà

Microsoft.Network/networkWatchers/packetCaptures

Nome Descrizione Valore
nome Nome della risorsa stringa (obbligatorio)
parent_id ID della risorsa padre per questa risorsa. ID per la risorsa di tipo: networkWatchers
proprietà Proprietà dell'acquisizione di pacchetti. PacketCaptureParametersOrPacketCaptureResultProperties (obbligatorio)
digitare Tipo di risorsa "Microsoft.Network/networkWatchers/packetCaptures@2024-01-01"

PacketCaptureFilter

Nome Descrizione Valore
localIPAddress Indirizzo IP locale da filtrare. Notazione: "127.0.0.1" per la voce di indirizzo singolo. "127.0.0.1-127.0.0.255" per intervallo. "127.0.0.1; 127.0.0.5"? per più voci. Più intervalli non attualmente supportati. Combinazione di intervalli con più voci non attualmente supportate. Valore predefinito = null. corda
localPort Porta locale su cui filtrare. Notazione: "80" per la singola voce di porta". 80-85" per intervallo. "80; 443;" per più voci. Più intervalli non attualmente supportati. Combinazione di intervalli con più voci non attualmente supportate. Valore predefinito = null. corda
protocollo Protocollo da filtrare. 'Any'
'TCP'
'UDP'
remoteIPAddress Indirizzo IP locale da filtrare. Notazione: "127.0.0.1" per la voce di indirizzo singolo. "127.0.0.1-127.0.0.255" per intervallo. "127.0.0.1; 127.0.0.5;" per più voci. Più intervalli non attualmente supportati. Combinazione di intervalli con più voci non attualmente supportate. Valore predefinito = null. corda
remotePort Porta remota su cui filtrare. Notazione: "80" per la singola voce di porta". 80-85" per intervallo. "80; 443;" per più voci. Più intervalli non attualmente supportati. Combinazione di intervalli con più voci non attualmente supportate. Valore predefinito = null. corda

PacketCaptureMachineScope

Nome Descrizione Valore
escludere Elenco di istanze di AzureVMSS che devono essere escluse da AzureVMSS dall'esecuzione dell'acquisizione di pacchetti. string[]
includere Elenco di istanze di AzureVMSS in cui eseguire l'acquisizione di pacchetti. string[]

PacketCaptureParametersOrPacketCaptureResultProperties

Nome Descrizione Valore
bytesToCapturePerPacket Numero di byte acquisiti per pacchetto, i byte rimanenti vengono troncati. Int

Vincoli:
Valore minimo = 0
Valore massimo = 4294967295
captureSettings L'impostazione di acquisizione contiene i valori 'FileCount', 'FileSizeInBytes', 'SessionTimeLimitInSeconds'. PacketCaptureSettings
continuousCapture Questa acquisizione continua è un valore booleano nullable, che può contenere il valore 'null', 'true' o 'false'. Se non si passa questo parametro, verrà considerato come 'null', il valore predefinito è 'null'. Bool
filtri Elenco di filtri di acquisizione pacchetti. packetCaptureFilter[]
portata Elenco di istanze di AzureVMSS che possono essere incluse o escluse per eseguire l'acquisizione di pacchetti. Se sia inclusi che esclusi sono vuoti, l'acquisizione di pacchetti verrà eseguita in tutte le istanze di AzureVMSS. PacketCaptureMachineScope
storageLocation Percorso di archiviazione per una sessione di acquisizione di pacchetti. PacketCaptureStorageLocation (obbligatorio)
bersaglio L'ID della risorsa di destinazione, sono attualmente supportati solo AzureVM e AzureVMSS come tipo di destinazione. stringa (obbligatorio)
targetType Tipo di destinazione della risorsa fornita. 'AzureVM'
'AzureVMSS'
timeLimitInSeconds Durata massima della sessione di acquisizione in secondi. Int

Vincoli:
Valore minimo = 0
Valore massimo = 18000
totalBytesPerSession Dimensioni massime dell'output di acquisizione. Int

Vincoli:
Valore minimo = 0
Valore massimo = 4294967295

PacketCaptureSettings

Nome Descrizione Valore
fileCount Numero di conteggio file. Il valore predefinito del conteggio è 10 e il numero massimo è 10000. Int

Vincoli:
Valore minimo = 0
Valore massimo = 10000
fileSizeInBytes Numero di byte acquisiti per pacchetto. Valore predefinito in byte 104857600 (100 MB) e massimo in byte 4294967295 (4 GB). Int

Vincoli:
Valore minimo = 0
Valore massimo = 4294967295
sessionTimeLimitInSeconds La durata massima della sessione di acquisizione in secondi è 604800s (7 giorni) per un file. Valore predefinito nel secondo 86400s (1 giorno). Int

Vincoli:
Valore minimo = 0
Valore massimo = 604800

PacketCaptureStorageLocation

Nome Descrizione Valore
filePath Questo percorso non è valido se 'Continuous Capture' viene fornito con 'true' o 'false'. Percorso locale valido nella macchina virtuale di destinazione. Deve includere il nome del file di acquisizione (*.cap). Per la macchina virtuale Linux deve iniziare con /var/captures. Obbligatorio se non viene specificato alcun ID di archiviazione, altrimenti facoltativo. corda
localPath Questo percorso è valido se 'Continuous Capture' viene fornito con 'true' o 'false' e obbligatorio se non viene fornito alcun ID di archiviazione, altrimenti facoltativo. Deve includere il nome del file di acquisizione (*.cap). Per la macchina virtuale Linux deve iniziare con /var/captures. corda
storageId ID dell'account di archiviazione per salvare la sessione di acquisizione pacchetti. Obbligatorio se non viene specificato alcun percorso locale o filePath. corda
storagePath URI del percorso di archiviazione per salvare l'acquisizione di pacchetti. Deve essere un URI ben formato che descrive la posizione per salvare l'acquisizione di pacchetti. corda