Поделиться через

Microsoft.Network NetworkWatchers/packetCaptures 2023-11-01

  • Статья

Определение ресурса Bicep

Тип ресурса networkWatchers/packetCaptures можно развернуть с помощью операций, предназначенных для:

Список измененных свойств в каждой версии API см. в журнале изменений.

Формат ресурсов

Чтобы создать ресурс Microsoft.Network/networkWatchers/packetCaptures, добавьте следующий Bicep в шаблон.

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

Значения свойств

networkWatchers/packetCaptures

Имя Описание Значение
name имя ресурса.

Узнайте, как задать имена и типы для дочерних ресурсов в Bicep.		 string (обязательно)
родитель В Bicep можно указать родительский ресурс для дочернего ресурса. Это свойство необходимо добавить только в том случае, если дочерний ресурс объявлен за пределами родительского ресурса.

Дополнительные сведения см. в разделе Дочерний ресурс за пределами родительского ресурса.		 Символьное имя ресурса типа: networkWatchers
properties Свойства записи пакетов. PacketCaptureParametersOrPacketCaptureResultProperti... (обязательно)

PacketCaptureParametersOrPacketCaptureResultProperti...

Имя Описание Значение
bytesToCapturePerPacket Количество байтов, захваченных на пакет, остальные байты усекаются. INT

Ограничения:
Минимальное значение = 0
Максимальное значение = 4294967295
captureSettings Параметр записи содержит значения "FileCount", "FileSizeInBytes", "SessionTimeLimitInSeconds". PacketCaptureSettings
continuousCapture Этот непрерывный захват является логическим значением, допускаемым значением NULL, которое может содержать значение null, true или false. Если мы не передадим этот параметр, он будет рассматриваться как null, значение по умолчанию — null. bool
filters Список фильтров записи пакетов. PacketCaptureFilter[]
область Список экземпляров AzureVMSS, которые можно включить или исключить для выполнения записи пакетов. Если как включенные, так и исключенные являются пустыми, запись пакетов будет выполняться на всех экземплярах AzureVMSS. PacketCaptureMachineScope
storageLocation Место хранения для сеанса записи пакетов. PacketCaptureStorageLocation (обязательно)
target Идентификатор целевого ресурса, только AzureVM и AzureVMSS в качестве целевого типа в настоящее время поддерживаются. string (обязательно)
targetType Тип целевого объекта предоставленного ресурса. AzureVM
AzureVMSS
timeLimitInSeconds Максимальная продолжительность сеанса записи в секундах. INT

Ограничения:
Минимальное значение = 0
Максимальное значение = 18000
totalBytesPerSession Максимальный размер выходных данных захвата. INT

Ограничения:
Минимальное значение = 0
Максимальное значение = 4294967295

PacketCaptureSettings

Имя Описание Значение
fileCount Число файлов. Значение count по умолчанию равно 10, а максимальное число — 10000. INT

Ограничения:
Минимальное значение = 0
Максимальное значение = 10000
fileSizeInBytes Число байтов, захваченных на пакет. Значение по умолчанию в байтах 104857600 (100 МБ) и максимальное значение в байтах 4294967295 (4 ГБ). INT

Ограничения:
Минимальное значение = 0
Максимальное значение = 4294967295
sessionTimeLimitInSeconds Максимальная продолжительность сеанса записи в секундах составляет 604800 с (7 дней) для файла. Значение по умолчанию во второй 86400s (1 день). INT

Ограничения:
Минимальное значение = 0
Максимальное значение = 604800

PacketCaptureFilter

Имя Описание Значение
localIPAddress Локальный IP-адрес для фильтрации. Нотация: "127.0.0.1" для записи с одним адресом. "127.0.0.1-127.0.0.255" для диапазона. "127.0.0.1; 127.0.0.5"? для нескольких записей. Несколько диапазонов в настоящее время не поддерживаются. Смешивание диапазонов с несколькими записями в настоящее время не поддерживается. По умолчанию — null. строка
localPort Локальный порт для фильтрации. Нотация: "80" для входа с одним портом". 80-85 дюймов для диапазона. "80; 443;" для нескольких записей. Несколько диапазонов в настоящее время не поддерживаются. Смешивание диапазонов с несколькими записями в настоящее время не поддерживается. По умолчанию — null. строка
protocol Протокол для фильтрации. "Любой"
"TCP"
'UDP'
remoteIPAddress Локальный IP-адрес для фильтрации. Нотация: "127.0.0.1" для записи с одним адресом. "127.0.0.1-127.0.0.255" для диапазона. "127.0.0.1; 127.0.0.5;" для нескольких записей. Несколько диапазонов в настоящее время не поддерживаются. Смешивание диапазонов с несколькими записями в настоящее время не поддерживается. По умолчанию — null. строка
remotePort Удаленный порт для фильтрации. Нотация: "80" для входа с одним портом". 80-85 дюймов для диапазона. "80; 443;" для нескольких записей. Несколько диапазонов в настоящее время не поддерживаются. Смешивание диапазонов с несколькими записями в настоящее время не поддерживается. По умолчанию — null. строка

PacketCaptureMachineScope

Имя Описание Значение
исключение Список экземпляров AzureVMSS, которые должны быть исключены из AzureVMSS из выполняемой записи пакетов. string[]
include Список экземпляров AzureVMSS для записи пакетов. string[]

PacketCaptureStorageLocation

Имя Описание Значение
filePath Этот путь недопустим, если параметру "Непрерывный сбор" предоставлено значение "true" или "false". Допустимый локальный путь на целевой виртуальной машине. Должно содержать имя файла записи (*.cap). Для виртуальной машины Linux она должна начинаться с /var/captures. Требуется, если идентификатор хранилища не указан, в противном случае — необязательный. строка
localPath Этот путь является допустимым, если параметру "Непрерывный сбор" предоставлено значение "true" или "false", и требуется, если идентификатор хранилища не указан, в противном случае необязательный. Должно содержать имя файла записи (*.cap). Для виртуальной машины Linux она должна начинаться с /var/captures. строка
storageId Идентификатор учетной записи хранения для сохранения сеанса записи пакетов. Требуется, если не указан параметр localPath или filePath. строка
storagePath Универсальный код ресурса (URI) пути к хранилищу для сохранения записи пакетов. Должен быть правильно сформированным универсальным кодом ресурса (URI), описывающим расположение для сохранения записи пакетов. строка

Определение ресурса шаблона ARM

Тип ресурса networkWatchers/packetCaptures можно развернуть с помощью операций, предназначенных для:

Список измененных свойств в каждой версии API см. в журнале изменений.

Формат ресурсов

Чтобы создать ресурс Microsoft.Network/networkWatchers/packetCaptures, добавьте следующий код JSON в шаблон.

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

Значения свойств

networkWatchers/packetCaptures

Имя Описание Значение
тип Тип ресурса Microsoft.Network/networkWatchers/packetCaptures
версия_API Версия API ресурсов '2023-11-01'
name имя ресурса.

Узнайте, как задать имена и типы для дочерних ресурсов в шаблонах JSON ARM.		 строка (обязательно)
properties Свойства записи пакетов. PacketCaptureParametersOrPacketCaptureResultProperti... (обязательно)

PacketCaptureParametersOrPacketCaptureResultProperti...

Имя Описание Значение
bytesToCapturePerPacket Количество байтов, захваченных на пакет, остальные байты усекаются. INT

Ограничения:
Минимальное значение = 0
Максимальное значение = 4294967295
captureSettings Параметр записи содержит значения "FileCount", "FileSizeInBytes", "SessionTimeLimitInSeconds". PacketCaptureSettings
continuousCapture Этот непрерывный захват является логическим значением, допускаемым значением NULL, которое может содержать значение null, true или false. Если мы не передадим этот параметр, он будет рассматриваться как null, а значение по умолчанию — null. bool
filters Список фильтров записи пакетов. PacketCaptureFilter[]
область Список экземпляров AzureVMSS, которые можно включить или исключить для выполнения записи пакетов. Если включенные и исключенные значения пусты, запись пакетов будет выполняться на всех экземплярах AzureVMSS. PacketCaptureMachineScope
storageLocation Место хранения для сеанса записи пакетов. PacketCaptureStorageLocation (обязательно)
target В настоящее время поддерживаются идентификатор целевого ресурса, только AzureVM и AzureVMSS в качестве целевого типа. строка (обязательно)
targetType Целевой тип предоставленного ресурса. AzureVM
AzureVMSS
timeLimitInSeconds Максимальная продолжительность сеанса записи в секундах. INT

Ограничения:
Минимальное значение = 0
Максимальное значение = 18000
totalBytesPerSession Максимальный размер выходных данных записи. INT

Ограничения:
Минимальное значение = 0
Максимальное значение = 4294967295

PacketCaptureSettings

Имя Описание Значение
fileCount Число файлов. Значение count по умолчанию равно 10, а максимальное число — 10 000. INT

Ограничения:
Минимальное значение = 0
Максимальное значение = 10000
fileSizeInBytes Число байтов, захваченных на пакет. Значение по умолчанию в байтах 104857600 (100 МБ) и максимальное значение в байтах 4294967295 (4 ГБ). INT

Ограничения:
Минимальное значение = 0
Максимальное значение = 4294967295
sessionTimeLimitInSeconds Максимальная продолжительность сеанса записи в секундах составляет 604800 с (7 дней) для файла. Значение по умолчанию в секунде 86400 (1 день). INT

Ограничения:
Минимальное значение = 0
Максимальное значение = 604800

PacketCaptureFilter

Имя Описание Значение
localIPAddress Локальный IP-адрес для фильтрации. Нотация: "127.0.0.1" для записи с одним адресом. "127.0.0.1-127.0.0.255" для диапазона. "127.0.0.1; 127.0.0.5"? для нескольких записей. Несколько диапазонов в настоящее время не поддерживаются. Смешивание диапазонов с несколькими записями в настоящее время не поддерживается. По умолчанию = null. строка
localPort Локальный порт для фильтрации. Нотация: "80" для входа с одним портом". 80–85 дюймов для диапазона. "80; 443;" для нескольких записей. Несколько диапазонов в настоящее время не поддерживаются. Смешивание диапазонов с несколькими записями в настоящее время не поддерживается. По умолчанию = null. строка
protocol Протокол для фильтрации. "Любой"
"TCP"
"UDP"
remoteIPAddress Локальный IP-адрес для фильтрации. Нотация: "127.0.0.1" для записи с одним адресом. "127.0.0.1-127.0.0.255" для диапазона. "127.0.0.1; 127.0.0.5;" для нескольких записей. Несколько диапазонов в настоящее время не поддерживаются. Смешивание диапазонов с несколькими записями в настоящее время не поддерживается. По умолчанию = null. строка
remotePort Удаленный порт для фильтрации. Нотация: "80" для входа с одним портом". 80–85 дюймов для диапазона. "80; 443;" для нескольких записей. Несколько диапазонов в настоящее время не поддерживаются. Смешивание диапазонов с несколькими записями в настоящее время не поддерживается. По умолчанию = null. строка

PacketCaptureMachineScope

Имя Описание Значение
исключение Список экземпляров AzureVMSS, которые должны быть исключены из AzureVMSS из записи пакетов. string[]
include Список экземпляров AzureVMSS для записи пакетов. string[]

PacketCaptureStorageLocation

Имя Описание Значение
filePath Этот путь недопустим, если параметру "Непрерывный сбор" предоставлено значение "true" или "false". Допустимый локальный путь на целевой виртуальной машине. Должно содержать имя файла записи (*.cap). Для виртуальной машины Linux она должна начинаться с /var/captures. Требуется, если идентификатор хранилища не указан, в противном случае — необязательный. строка
localPath Этот путь является допустимым, если параметру "Непрерывный сбор" предоставляется значение "true" или "false", и требуется, если идентификатор хранилища не указан. В противном случае это необязательно. Должно содержать имя файла записи (*.cap). Для виртуальной машины Linux она должна начинаться с /var/captures. строка
storageId Идентификатор учетной записи хранения для сохранения сеанса записи пакетов. Требуется, если не указан параметр localPath или filePath. строка
storagePath Универсальный код ресурса (URI) пути к хранилищу для сохранения записи пакетов. Должен быть правильным универсальным кодом ресурса (URI), описывающим расположение для сохранения записи пакетов. строка

Определение ресурса Terraform (поставщик AzAPI)

Тип ресурса networkWatchers/packetCaptures можно развернуть с помощью операций, предназначенных для:

  • Группы ресурсов

Список измененных свойств в каждой версии API см. в журнале изменений.

Формат ресурсов

Чтобы создать ресурс Microsoft.Network/networkWatchers/packetCaptures, добавьте в шаблон следующую terraform.

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
    }
  })
}

Значения свойств

networkWatchers/packetCaptures

Имя Описание Значение
тип Тип ресурса "Microsoft.Network/networkWatchers/packetCaptures@2023-11-01"
name имя ресурса. строка (обязательно)
parent_id Идентификатор ресурса, который является родительским для этого ресурса. Идентификатор ресурса типа networkWatchers
properties Свойства записи пакетов. PacketCaptureParametersOrPacketCaptureResultProperti... (обязательно)

PacketCaptureParametersOrPacketCaptureResultProperti...

Имя Описание Значение
bytesToCapturePerPacket Количество байтов, захваченных на пакет, остальные байты усекаются. INT

Ограничения:
Минимальное значение = 0
Максимальное значение = 4294967295
captureSettings Параметр записи содержит значения "FileCount", "FileSizeInBytes", "SessionTimeLimitInSeconds". PacketCaptureSettings
continuousCapture Этот непрерывный захват является логическим значением, допускаемым значением NULL, которое может содержать значение null, true или false. Если мы не передадим этот параметр, он будет рассматриваться как null, а значение по умолчанию — null. bool
filters Список фильтров записи пакетов. PacketCaptureFilter[]
область Список экземпляров AzureVMSS, которые можно включить или исключить для выполнения записи пакетов. Если включенные и исключенные значения пусты, запись пакетов будет выполняться на всех экземплярах AzureVMSS. PacketCaptureMachineScope
storageLocation Место хранения для сеанса записи пакетов. PacketCaptureStorageLocation (обязательно)
target В настоящее время поддерживаются идентификатор целевого ресурса, только AzureVM и AzureVMSS в качестве целевого типа. строка (обязательно)
targetType Целевой тип предоставленного ресурса. AzureVM
AzureVMSS
timeLimitInSeconds Максимальная продолжительность сеанса записи в секундах. INT

Ограничения:
Минимальное значение = 0
Максимальное значение = 18000
totalBytesPerSession Максимальный размер выходных данных записи. INT

Ограничения:
Минимальное значение = 0
Максимальное значение = 4294967295

PacketCaptureSettings

Имя Описание Значение
fileCount Число файлов. Значение count по умолчанию равно 10, а максимальное число — 10 000. INT

Ограничения:
Минимальное значение = 0
Максимальное значение = 10000
fileSizeInBytes Число байтов, захваченных на пакет. Значение по умолчанию в байтах 104857600 (100 МБ) и максимальное значение в байтах 4294967295 (4 ГБ). INT

Ограничения:
Минимальное значение = 0
Максимальное значение = 4294967295
sessionTimeLimitInSeconds Максимальная продолжительность сеанса записи в секундах составляет 604800 с (7 дней) для файла. Значение по умолчанию в секунде 86400 (1 день). INT

Ограничения:
Минимальное значение = 0
Максимальное значение = 604800

PacketCaptureFilter

Имя Описание Значение
localIPAddress Локальный IP-адрес для фильтрации. Нотация: "127.0.0.1" для записи с одним адресом. "127.0.0.1-127.0.0.255" для диапазона. "127.0.0.1; 127.0.0.5"? для нескольких записей. Несколько диапазонов в настоящее время не поддерживаются. Смешивание диапазонов с несколькими записями в настоящее время не поддерживается. По умолчанию = null. строка
localPort Локальный порт для фильтрации. Нотация: "80" для входа с одним портом". 80–85 дюймов для диапазона. "80; 443;" для нескольких записей. Несколько диапазонов в настоящее время не поддерживаются. Смешивание диапазонов с несколькими записями в настоящее время не поддерживается. По умолчанию = null. строка
protocol Протокол для фильтрации. "Любой"
"TCP"
"UDP"
remoteIPAddress Локальный IP-адрес для фильтрации. Нотация: "127.0.0.1" для записи с одним адресом. "127.0.0.1-127.0.0.255" для диапазона. "127.0.0.1; 127.0.0.5;" для нескольких записей. Несколько диапазонов в настоящее время не поддерживаются. Смешивание диапазонов с несколькими записями в настоящее время не поддерживается. По умолчанию = null. строка
remotePort Удаленный порт для фильтрации. Нотация: "80" для входа с одним портом". 80–85 дюймов для диапазона. "80; 443;" для нескольких записей. Несколько диапазонов в настоящее время не поддерживаются. Смешивание диапазонов с несколькими записями в настоящее время не поддерживается. По умолчанию — null. строка

PacketCaptureMachineScope

Имя Описание Значение
исключение Список экземпляров AzureVMSS, которые должны быть исключены из AzureVMSS из выполняемой записи пакетов. string[]
include Список экземпляров AzureVMSS для записи пакетов. string[]

PacketCaptureStorageLocation

Имя Описание Значение
filePath Этот путь недопустим, если параметру "Непрерывный сбор" предоставлено значение "true" или "false". Допустимый локальный путь на целевой виртуальной машине. Должно содержать имя файла записи (*.cap). Для виртуальной машины Linux она должна начинаться с /var/captures. Требуется, если идентификатор хранилища не указан, в противном случае — необязательный. строка
localPath Этот путь является допустимым, если параметру "Непрерывный сбор" предоставлено значение "true" или "false", и требуется, если идентификатор хранилища не указан, в противном случае необязательный. Должно содержать имя файла записи (*.cap). Для виртуальной машины Linux она должна начинаться с /var/captures. строка
storageId Идентификатор учетной записи хранения для сохранения сеанса записи пакетов. Требуется, если не указан параметр localPath или filePath. строка
storagePath Универсальный код ресурса (URI) пути к хранилищу для сохранения записи пакетов. Должен быть правильно сформированным универсальным кодом ресурса (URI), описывающим расположение для сохранения записи пакетов. строка