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

Microsoft.Network networkWatchers/packetCaptures 2023-02-01

  • Статья

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

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

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

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

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

resource symbolicname 'Microsoft.Network/networkWatchers/packetCaptures@2023-02-01' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    bytesToCapturePerPacket: int
    filters: [
      {
        localIPAddress: 'string'
        localPort: 'string'
        protocol: 'string'
        remoteIPAddress: 'string'
        remotePort: 'string'
      }
    ]
    scope: {
      exclude: [
        'string'
      ]
      include: [
        'string'
      ]
    }
    storageLocation: {
      filePath: 'string'
      storageId: 'string'
      storagePath: 'string'
    }
    target: 'string'
    targetType: 'string'
    timeLimitInSeconds: int
    totalBytesPerSession: int
  }
}

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

networkWatchers/packetCaptures

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

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

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

PacketCaptureParametersOrPacketCaptureResultProperti...

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

Ограничения:
Минимальное значение = 0
Максимальное значение = 4294967295
filters Список фильтров записи пакетов. PacketCaptureFilter[]
область Список экземпляров AzureVMSS, которые можно включить или исключить для выполнения записи пакетов. Если включенные и исключенные значения пусты, запись пакетов будет выполняться на всех экземплярах AzureVMSS. PacketCaptureMachineScope
storageLocation Место хранения для сеанса записи пакетов. PacketCaptureStorageLocation (обязательно)
target В настоящее время поддерживаются идентификатор целевого ресурса, только AzureVM и AzureVMSS в качестве целевого типа. строка (обязательно)
targetType Целевой тип предоставленного ресурса. AzureVM
AzureVMSS
timeLimitInSeconds Максимальная продолжительность сеанса записи в секундах. INT

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

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

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 Допустимый локальный путь на целевой виртуальной машине. Должно содержать имя файла записи (*.cap). Для виртуальной машины Linux она должна начинаться с /var/captures. Требуется, если идентификатор хранилища не указан, в противном случае — необязательный. строка
storageId Идентификатор учетной записи хранения для сохранения сеанса записи пакетов. Требуется, если путь к локальному файлу не указан. строка
storagePath Универсальный код ресурса (URI) пути к хранилищу для сохранения записи пакетов. Должен быть правильным универсальным кодом ресурса (URI), описывающим расположение для сохранения записи пакетов. строка

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

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

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

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

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

{
  "type": "Microsoft.Network/networkWatchers/packetCaptures",
  "apiVersion": "2023-02-01",
  "name": "string",
  "properties": {
    "bytesToCapturePerPacket": "int",
    "filters": [
      {
        "localIPAddress": "string",
        "localPort": "string",
        "protocol": "string",
        "remoteIPAddress": "string",
        "remotePort": "string"
      }
    ],
    "scope": {
      "exclude": [ "string" ],
      "include": [ "string" ]
    },
    "storageLocation": {
      "filePath": "string",
      "storageId": "string",
      "storagePath": "string"
    },
    "target": "string",
    "targetType": "string",
    "timeLimitInSeconds": "int",
    "totalBytesPerSession": "int"
  }
}

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

networkWatchers/packetCaptures

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

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

PacketCaptureParametersOrPacketCaptureResultProperti...

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

Ограничения:
Минимальное значение = 0
Максимальное значение = 4294967295
filters Список фильтров записи пакетов. PacketCaptureFilter[]
область Список экземпляров AzureVMSS, которые можно включить или исключить для выполнения записи пакетов. Если включенные и исключенные значения пусты, запись пакетов будет выполняться на всех экземплярах AzureVMSS. PacketCaptureMachineScope
storageLocation Место хранения для сеанса записи пакетов. PacketCaptureStorageLocation (обязательно)
target В настоящее время поддерживаются идентификатор целевого ресурса, только AzureVM и AzureVMSS в качестве целевого типа. строка (обязательно)
targetType Целевой тип предоставленного ресурса. AzureVM
AzureVMSS
timeLimitInSeconds Максимальная продолжительность сеанса записи в секундах. INT

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

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

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 Допустимый локальный путь на целевой виртуальной машине. Должно содержать имя файла записи (*.cap). Для виртуальной машины Linux она должна начинаться с /var/captures. Требуется, если идентификатор хранилища не указан, в противном случае — необязательный. строка
storageId Идентификатор учетной записи хранения для сохранения сеанса записи пакетов. Требуется, если путь к локальному файлу не указан. строка
storagePath Универсальный код ресурса (URI) пути к хранилищу для сохранения записи пакетов. Должен быть правильным универсальным кодом ресурса (URI), описывающим расположение для сохранения записи пакетов. строка

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

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

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

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

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

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/networkWatchers/packetCaptures@2023-02-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      bytesToCapturePerPacket = int
      filters = [
        {
          localIPAddress = "string"
          localPort = "string"
          protocol = "string"
          remoteIPAddress = "string"
          remotePort = "string"
        }
      ]
      scope = {
        exclude = [
          "string"
        ]
        include = [
          "string"
        ]
      }
      storageLocation = {
        filePath = "string"
        storageId = "string"
        storagePath = "string"
      }
      target = "string"
      targetType = "string"
      timeLimitInSeconds = int
      totalBytesPerSession = int
    }
  })
}

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

networkWatchers/packetCaptures

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

PacketCaptureParametersOrPacketCaptureResultProperti...

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

Ограничения:
Минимальное значение = 0
Максимальное значение = 4294967295
filters Список фильтров записи пакетов. PacketCaptureFilter[]
область Список экземпляров AzureVMSS, которые можно включить или исключить для выполнения записи пакетов. Если включенные и исключенные значения пусты, запись пакетов будет выполняться на всех экземплярах AzureVMSS. PacketCaptureMachineScope
storageLocation Место хранения для сеанса записи пакетов. PacketCaptureStorageLocation (обязательно)
target В настоящее время поддерживаются идентификатор целевого ресурса, только AzureVM и AzureVMSS в качестве целевого типа. строка (обязательно)
targetType Целевой тип предоставленного ресурса. AzureVM
AzureVMSS
timeLimitInSeconds Максимальная продолжительность сеанса записи в секундах. INT

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

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

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 Допустимый локальный путь на целевой виртуальной машине. Должно содержать имя файла записи (*.cap). Для виртуальной машины Linux она должна начинаться с /var/captures. Требуется, если идентификатор хранилища не указан, в противном случае — необязательный. строка
storageId Идентификатор учетной записи хранения для сохранения сеанса записи пакетов. Требуется, если локальный путь к файлу не указан. строка
storagePath Универсальный код ресурса (URI) пути к хранилищу для сохранения записи пакетов. Должен быть правильно сформированным универсальным кодом ресурса (URI), описывающим расположение для сохранения записи пакетов. строка