Udostępnij za pośrednictwem


Microsoft.Network NetworkWatchers/packetCaptures 2023-11-01

Definicja zasobu Bicep

Typ zasobu networkWatchers/packetCaptures 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.

Format zasobu

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

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

Wartości właściwości

Microsoft.Network/networkWatchers/packetCaptures

Nazwa Opis Wartość
nazwa Nazwa zasobu ciąg (wymagany)
rodzic 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 przechwytywania pakietów. PacketCaptureParametersOrPacketCaptureResultProperties (wymagane)

PacketCaptureFilter

Nazwa Opis Wartość
localIPAddress Lokalny adres IP do filtrowania. Notacja: "127.0.0.1" dla wpisu pojedynczego adresu. "127.0.0.1-127.0.0.255" dla zakresu. "127.0.0.1; 127.0.0.5"? dla wielu wpisów. Wiele zakresów nie jest obecnie obsługiwanych. Mieszanie zakresów z wieloma wpisami nie jest obecnie obsługiwane. Wartość domyślna = null. struna
localPort Port lokalny do filtrowania. Notacja: "80" dla pojedynczego wpisu portu. 80-85" dla zakresu. "80; 443;" dla wielu wpisów. Wiele zakresów nie jest obecnie obsługiwanych. Mieszanie zakresów z wieloma wpisami nie jest obecnie obsługiwane. Wartość domyślna = null. struna
protokół Protokół do filtrowania. "Dowolny"
"TCP"
"UDP"
remoteIPAddress Lokalny adres IP do filtrowania. Notacja: "127.0.0.1" dla wpisu pojedynczego adresu. "127.0.0.1-127.0.0.255" dla zakresu. "127.0.0.1; 127.0.0.5;" dla wielu wpisów. Wiele zakresów nie jest obecnie obsługiwanych. Mieszanie zakresów z wieloma wpisami nie jest obecnie obsługiwane. Wartość domyślna = null. struna
remotePort Port zdalny do filtrowania. Notacja: "80" dla pojedynczego wpisu portu. 80-85" dla zakresu. "80; 443;" dla wielu wpisów. Wiele zakresów nie jest obecnie obsługiwanych. Mieszanie zakresów z wieloma wpisami nie jest obecnie obsługiwane. Wartość domyślna = null. struna

PacketCaptureMachineScope

Nazwa Opis Wartość
wykluczać Lista wystąpień usługi AzureVMSS, które należy wykluczyć z usługi AzureVMSS z uruchamiania przechwytywania pakietów. string[]
zawierać Lista wystąpień usługi AzureVMSS do uruchamiania przechwytywania pakietów. string[]

PacketCaptureParametersOrPacketCaptureResultProperties

Nazwa Opis Wartość
bytesToCapturePerPacket Liczba bajtów przechwyconych na pakiet, pozostałe bajty są obcinane. Int

Ograniczenia:
Minimalna wartość = 0
Wartość maksymalna = 4294967295
captureSettings Ustawienie przechwytywania przechowuje wartości "FileCount", "FileSizeInBytes", "SessionTimeLimitInSeconds". PacketCaptureSettings
continuousCapture To ciągłe przechwytywanie jest wartością logiczną dopuszczaną do wartości null, która może zawierać wartość "null", "true" lub "false". Jeśli nie przekażemy tego parametru, zostanie to uznane za "null", wartość domyślna to "null". Bool
Filtry Lista filtrów przechwytywania pakietów. PacketCaptureFilter[]
zakres Lista wystąpień usługi AzureVMSS, które można uwzględnić lub wykluczyć do uruchamiania przechwytywania pakietów. Jeśli zarówno uwzględnione, jak i wykluczone są puste, przechwytywanie pakietów zostanie uruchomione we wszystkich wystąpieniach usługi AzureVMSS. PacketCaptureMachineScope
storageLocation Lokalizacja przechowywania sesji przechwytywania pakietów. PacketCaptureStorageLocation (wymagane)
cel Identyfikator docelowego zasobu, obecnie obsługiwane są tylko maszyny wirtualne AzureVM i AzureVMSS jako typ docelowy. ciąg (wymagany)
targetType Typ docelowy podanego zasobu. "AzureVM"
"AzureVMSS"
timeLimitInSeconds Maksymalny czas trwania sesji przechwytywania w sekundach. Int

Ograniczenia:
Minimalna wartość = 0
Wartość maksymalna = 18000
totalBytesPerSession Maksymalny rozmiar danych wyjściowych przechwytywania. Int

Ograniczenia:
Minimalna wartość = 0
Wartość maksymalna = 4294967295

PacketCaptureSettings

Nazwa Opis Wartość
fileCount Liczba plików. Wartość domyślna liczby to 10, a maksymalna liczba to 10000. Int

Ograniczenia:
Minimalna wartość = 0
Wartość maksymalna = 10000
fileSizeInBytes Liczba bajtów przechwyconych na pakiet. Wartość domyślna w bajtach 104857600 (100 MB) i maksimum w bajtach 4294967295 (4 GB). Int

Ograniczenia:
Minimalna wartość = 0
Wartość maksymalna = 4294967295
sessionTimeLimitInSeconds Maksymalny czas trwania sesji przechwytywania w sekundach to 604800s (7 dni) dla pliku. Wartość domyślna w sekundach 86400 (1 dzień). Int

Ograniczenia:
Minimalna wartość = 0
Wartość maksymalna = 604800

PacketCaptureStorageLocation

Nazwa Opis Wartość
filePath Ta ścieżka jest nieprawidłowa, jeśli element "Continuous Capture" jest dostarczany z wartością "true" lub "false". Prawidłowa ścieżka lokalna na docelowej maszynie wirtualnej. Musi zawierać nazwę pliku przechwytywania (*.cap). W przypadku maszyny wirtualnej z systemem Linux musi zaczynać się od /var/captures. Wymagane, jeśli nie podano identyfikatora magazynu, w przeciwnym razie opcjonalne. struna
localPath Ta ścieżka jest prawidłowa, jeśli parametr "Continuous Capture" jest dostarczany z wartością "true" lub "false" i wymagany, jeśli nie podano identyfikatora magazynu, w przeciwnym razie opcjonalnie. Musi zawierać nazwę pliku przechwytywania (*.cap). W przypadku maszyny wirtualnej z systemem Linux musi zaczynać się od /var/captures. struna
storageId Identyfikator konta magazynu do zapisania sesji przechwytywania pakietów. Wymagane, jeśli nie podano ścieżki localPath lub filePath. struna
storagePath Identyfikator URI ścieżki magazynu do zapisania przechwytywania pakietów. Musi być poprawnie sformułowanym identyfikatorem URI opisującym lokalizację w celu zapisania przechwytywania pakietów. struna

Definicja zasobu szablonu usługi ARM

Typ zasobu networkWatchers/packetCaptures 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.

Format zasobu

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

{
  "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"
  }
}

Wartości właściwości

Microsoft.Network/networkWatchers/packetCaptures

Nazwa Opis Wartość
apiVersion Wersja interfejsu API '2023-11-01'
nazwa Nazwa zasobu ciąg (wymagany)
Właściwości Właściwości przechwytywania pakietów. PacketCaptureParametersOrPacketCaptureResultProperties (wymagane)
typ Typ zasobu "Microsoft.Network/networkWatchers/packetCaptures"

PacketCaptureFilter

Nazwa Opis Wartość
localIPAddress Lokalny adres IP do filtrowania. Notacja: "127.0.0.1" dla wpisu pojedynczego adresu. "127.0.0.1-127.0.0.255" dla zakresu. "127.0.0.1; 127.0.0.5"? dla wielu wpisów. Wiele zakresów nie jest obecnie obsługiwanych. Mieszanie zakresów z wieloma wpisami nie jest obecnie obsługiwane. Wartość domyślna = null. struna
localPort Port lokalny do filtrowania. Notacja: "80" dla pojedynczego wpisu portu. 80-85" dla zakresu. "80; 443;" dla wielu wpisów. Wiele zakresów nie jest obecnie obsługiwanych. Mieszanie zakresów z wieloma wpisami nie jest obecnie obsługiwane. Wartość domyślna = null. struna
protokół Protokół do filtrowania. "Dowolny"
"TCP"
"UDP"
remoteIPAddress Lokalny adres IP do filtrowania. Notacja: "127.0.0.1" dla wpisu pojedynczego adresu. "127.0.0.1-127.0.0.255" dla zakresu. "127.0.0.1; 127.0.0.5;" dla wielu wpisów. Wiele zakresów nie jest obecnie obsługiwanych. Mieszanie zakresów z wieloma wpisami nie jest obecnie obsługiwane. Wartość domyślna = null. struna
remotePort Port zdalny do filtrowania. Notacja: "80" dla pojedynczego wpisu portu. 80-85" dla zakresu. "80; 443;" dla wielu wpisów. Wiele zakresów nie jest obecnie obsługiwanych. Mieszanie zakresów z wieloma wpisami nie jest obecnie obsługiwane. Wartość domyślna = null. struna

PacketCaptureMachineScope

Nazwa Opis Wartość
wykluczać Lista wystąpień usługi AzureVMSS, które należy wykluczyć z usługi AzureVMSS z uruchamiania przechwytywania pakietów. string[]
zawierać Lista wystąpień usługi AzureVMSS do uruchamiania przechwytywania pakietów. string[]

PacketCaptureParametersOrPacketCaptureResultProperties

Nazwa Opis Wartość
bytesToCapturePerPacket Liczba bajtów przechwyconych na pakiet, pozostałe bajty są obcinane. Int

Ograniczenia:
Minimalna wartość = 0
Wartość maksymalna = 4294967295
captureSettings Ustawienie przechwytywania przechowuje wartości "FileCount", "FileSizeInBytes", "SessionTimeLimitInSeconds". PacketCaptureSettings
continuousCapture To ciągłe przechwytywanie jest wartością logiczną dopuszczaną do wartości null, która może zawierać wartość "null", "true" lub "false". Jeśli nie przekażemy tego parametru, zostanie to uznane za "null", wartość domyślna to "null". Bool
Filtry Lista filtrów przechwytywania pakietów. PacketCaptureFilter[]
zakres Lista wystąpień usługi AzureVMSS, które można uwzględnić lub wykluczyć do uruchamiania przechwytywania pakietów. Jeśli zarówno uwzględnione, jak i wykluczone są puste, przechwytywanie pakietów zostanie uruchomione we wszystkich wystąpieniach usługi AzureVMSS. PacketCaptureMachineScope
storageLocation Lokalizacja przechowywania sesji przechwytywania pakietów. PacketCaptureStorageLocation (wymagane)
cel Identyfikator docelowego zasobu, obecnie obsługiwane są tylko maszyny wirtualne AzureVM i AzureVMSS jako typ docelowy. ciąg (wymagany)
targetType Typ docelowy podanego zasobu. "AzureVM"
"AzureVMSS"
timeLimitInSeconds Maksymalny czas trwania sesji przechwytywania w sekundach. Int

Ograniczenia:
Minimalna wartość = 0
Wartość maksymalna = 18000
totalBytesPerSession Maksymalny rozmiar danych wyjściowych przechwytywania. Int

Ograniczenia:
Minimalna wartość = 0
Wartość maksymalna = 4294967295

PacketCaptureSettings

Nazwa Opis Wartość
fileCount Liczba plików. Wartość domyślna liczby to 10, a maksymalna liczba to 10000. Int

Ograniczenia:
Minimalna wartość = 0
Wartość maksymalna = 10000
fileSizeInBytes Liczba bajtów przechwyconych na pakiet. Wartość domyślna w bajtach 104857600 (100 MB) i maksimum w bajtach 4294967295 (4 GB). Int

Ograniczenia:
Minimalna wartość = 0
Wartość maksymalna = 4294967295
sessionTimeLimitInSeconds Maksymalny czas trwania sesji przechwytywania w sekundach to 604800s (7 dni) dla pliku. Wartość domyślna w sekundach 86400 (1 dzień). Int

Ograniczenia:
Minimalna wartość = 0
Wartość maksymalna = 604800

PacketCaptureStorageLocation

Nazwa Opis Wartość
filePath Ta ścieżka jest nieprawidłowa, jeśli element "Continuous Capture" jest dostarczany z wartością "true" lub "false". Prawidłowa ścieżka lokalna na docelowej maszynie wirtualnej. Musi zawierać nazwę pliku przechwytywania (*.cap). W przypadku maszyny wirtualnej z systemem Linux musi zaczynać się od /var/captures. Wymagane, jeśli nie podano identyfikatora magazynu, w przeciwnym razie opcjonalne. struna
localPath Ta ścieżka jest prawidłowa, jeśli parametr "Continuous Capture" jest dostarczany z wartością "true" lub "false" i wymagany, jeśli nie podano identyfikatora magazynu, w przeciwnym razie opcjonalnie. Musi zawierać nazwę pliku przechwytywania (*.cap). W przypadku maszyny wirtualnej z systemem Linux musi zaczynać się od /var/captures. struna
storageId Identyfikator konta magazynu do zapisania sesji przechwytywania pakietów. Wymagane, jeśli nie podano ścieżki localPath lub filePath. struna
storagePath Identyfikator URI ścieżki magazynu do zapisania przechwytywania pakietów. Musi być poprawnie sformułowanym identyfikatorem URI opisującym lokalizację w celu zapisania przechwytywania pakietów. struna

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

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

  • grupy zasobów

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

Format zasobu

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

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

Wartości właściwości

Microsoft.Network/networkWatchers/packetCaptures

Nazwa Opis Wartość
nazwa Nazwa zasobu ciąg (wymagany)
parent_id Identyfikator zasobu, który jest elementem nadrzędnym dla tego zasobu. Identyfikator zasobu typu: networkWatchers
Właściwości Właściwości przechwytywania pakietów. PacketCaptureParametersOrPacketCaptureResultProperties (wymagane)
typ Typ zasobu "Microsoft.Network/networkWatchers/packetCaptures@2023-11-01"

PacketCaptureFilter

Nazwa Opis Wartość
localIPAddress Lokalny adres IP do filtrowania. Notacja: "127.0.0.1" dla wpisu pojedynczego adresu. "127.0.0.1-127.0.0.255" dla zakresu. "127.0.0.1; 127.0.0.5"? dla wielu wpisów. Wiele zakresów nie jest obecnie obsługiwanych. Mieszanie zakresów z wieloma wpisami nie jest obecnie obsługiwane. Wartość domyślna = null. struna
localPort Port lokalny do filtrowania. Notacja: "80" dla pojedynczego wpisu portu. 80-85" dla zakresu. "80; 443;" dla wielu wpisów. Wiele zakresów nie jest obecnie obsługiwanych. Mieszanie zakresów z wieloma wpisami nie jest obecnie obsługiwane. Wartość domyślna = null. struna
protokół Protokół do filtrowania. "Dowolny"
"TCP"
"UDP"
remoteIPAddress Lokalny adres IP do filtrowania. Notacja: "127.0.0.1" dla wpisu pojedynczego adresu. "127.0.0.1-127.0.0.255" dla zakresu. "127.0.0.1; 127.0.0.5;" dla wielu wpisów. Wiele zakresów nie jest obecnie obsługiwanych. Mieszanie zakresów z wieloma wpisami nie jest obecnie obsługiwane. Wartość domyślna = null. struna
remotePort Port zdalny do filtrowania. Notacja: "80" dla pojedynczego wpisu portu. 80-85" dla zakresu. "80; 443;" dla wielu wpisów. Wiele zakresów nie jest obecnie obsługiwanych. Mieszanie zakresów z wieloma wpisami nie jest obecnie obsługiwane. Wartość domyślna = null. struna

PacketCaptureMachineScope

Nazwa Opis Wartość
wykluczać Lista wystąpień usługi AzureVMSS, które należy wykluczyć z usługi AzureVMSS z uruchamiania przechwytywania pakietów. string[]
zawierać Lista wystąpień usługi AzureVMSS do uruchamiania przechwytywania pakietów. string[]

PacketCaptureParametersOrPacketCaptureResultProperties

Nazwa Opis Wartość
bytesToCapturePerPacket Liczba bajtów przechwyconych na pakiet, pozostałe bajty są obcinane. Int

Ograniczenia:
Minimalna wartość = 0
Wartość maksymalna = 4294967295
captureSettings Ustawienie przechwytywania przechowuje wartości "FileCount", "FileSizeInBytes", "SessionTimeLimitInSeconds". PacketCaptureSettings
continuousCapture To ciągłe przechwytywanie jest wartością logiczną dopuszczaną do wartości null, która może zawierać wartość "null", "true" lub "false". Jeśli nie przekażemy tego parametru, zostanie to uznane za "null", wartość domyślna to "null". Bool
Filtry Lista filtrów przechwytywania pakietów. PacketCaptureFilter[]
zakres Lista wystąpień usługi AzureVMSS, które można uwzględnić lub wykluczyć do uruchamiania przechwytywania pakietów. Jeśli zarówno uwzględnione, jak i wykluczone są puste, przechwytywanie pakietów zostanie uruchomione we wszystkich wystąpieniach usługi AzureVMSS. PacketCaptureMachineScope
storageLocation Lokalizacja przechowywania sesji przechwytywania pakietów. PacketCaptureStorageLocation (wymagane)
cel Identyfikator docelowego zasobu, obecnie obsługiwane są tylko maszyny wirtualne AzureVM i AzureVMSS jako typ docelowy. ciąg (wymagany)
targetType Typ docelowy podanego zasobu. "AzureVM"
"AzureVMSS"
timeLimitInSeconds Maksymalny czas trwania sesji przechwytywania w sekundach. Int

Ograniczenia:
Minimalna wartość = 0
Wartość maksymalna = 18000
totalBytesPerSession Maksymalny rozmiar danych wyjściowych przechwytywania. Int

Ograniczenia:
Minimalna wartość = 0
Wartość maksymalna = 4294967295

PacketCaptureSettings

Nazwa Opis Wartość
fileCount Liczba plików. Wartość domyślna liczby to 10, a maksymalna liczba to 10000. Int

Ograniczenia:
Minimalna wartość = 0
Wartość maksymalna = 10000
fileSizeInBytes Liczba bajtów przechwyconych na pakiet. Wartość domyślna w bajtach 104857600 (100 MB) i maksimum w bajtach 4294967295 (4 GB). Int

Ograniczenia:
Minimalna wartość = 0
Wartość maksymalna = 4294967295
sessionTimeLimitInSeconds Maksymalny czas trwania sesji przechwytywania w sekundach to 604800s (7 dni) dla pliku. Wartość domyślna w sekundach 86400 (1 dzień). Int

Ograniczenia:
Minimalna wartość = 0
Wartość maksymalna = 604800

PacketCaptureStorageLocation

Nazwa Opis Wartość
filePath Ta ścieżka jest nieprawidłowa, jeśli element "Continuous Capture" jest dostarczany z wartością "true" lub "false". Prawidłowa ścieżka lokalna na docelowej maszynie wirtualnej. Musi zawierać nazwę pliku przechwytywania (*.cap). W przypadku maszyny wirtualnej z systemem Linux musi zaczynać się od /var/captures. Wymagane, jeśli nie podano identyfikatora magazynu, w przeciwnym razie opcjonalne. struna
localPath Ta ścieżka jest prawidłowa, jeśli parametr "Continuous Capture" jest dostarczany z wartością "true" lub "false" i wymagany, jeśli nie podano identyfikatora magazynu, w przeciwnym razie opcjonalnie. Musi zawierać nazwę pliku przechwytywania (*.cap). W przypadku maszyny wirtualnej z systemem Linux musi zaczynać się od /var/captures. struna
storageId Identyfikator konta magazynu do zapisania sesji przechwytywania pakietów. Wymagane, jeśli nie podano ścieżki localPath lub filePath. struna
storagePath Identyfikator URI ścieżki magazynu do zapisania przechwytywania pakietów. Musi być poprawnie sformułowanym identyfikatorem URI opisującym lokalizację w celu zapisania przechwytywania pakietów. struna