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

Microsoft.Network networkWatchers/packetCaptures 2024-07-01

Определение ресурсов Bicep

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

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

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

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

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

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

Microsoft.Network/networkWatchers/packetCaptures

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

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

Фильтр PacketCapture

Имя Описание Ценность
localIPddress Локальный IP-адрес для фильтрации. Нотация: "127.0.0.1" для записи с одним адресом. "127.0.0.1-127.0.0.255" для диапазона. "127.0.0.1; 127.0.0.5"? для нескольких записей. В настоящее время несколько диапазонов не поддерживаются. Сочетание диапазонов с несколькими записями, которые в настоящее время не поддерживаются. По умолчанию = null. струна
локальный порт Локальный порт для фильтрации. Нотация: "80" для одной записи порта". 80-85" для диапазона. "80; 443;" для нескольких записей. В настоящее время несколько диапазонов не поддерживаются. Сочетание диапазонов с несколькими записями, которые в настоящее время не поддерживаются. По умолчанию = null. струна
протокол Протокол для фильтрации. "Любой"
"TCP"
"UDP"
remoteIPПрессест Локальный 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 из записи пакетов. строка[]
включать Список экземпляров AzureVMSS для запуска записи пакетов. строка[]

PacketCaptureParametersOrPacketCaptureResultProperties

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

Ограничения целостности:
Минимальное значение = 0
Максимальное значение = 4294967295
captureSettings Параметр записи содержит значения FileCount, FileSizeInBytes, SessionTimeLimitInSeconds. PacketCaptureSettings (Настройки пакетаCapture)
непрерывныйЗахват Этот непрерывный захват представляет собой логическое значение, допускающее значение NULL, true или false. Если этот параметр не передается, значение по умолчанию равно NULL. булевая переменная (bool)
фильтры Список фильтров отслеживания пакетов. PacketCaptureFilter[]
охват Список экземпляров AzureVMSS, которые можно включить или исключить для выполнения записи пакетов. Если оба включенных и исключенных являются пустыми, запись пакетов будет выполняться во всех экземплярах AzureVMSS. PacketCaptureMachineScope (ПакетЗахватМашиноскоп)
хранилищеРасположение Расположение хранилища для сеанса записи пакетов. PacketCaptureStorageLocation (обязательно)
цель Идентификатор целевого ресурса, в настоящее время поддерживаются только AzureVM и AzureVMSS в качестве целевого типа. строка (обязательно)
тип цели Целевой тип предоставленного ресурса. AzureVM
AzureVMSS
timeLimitInSeconds Максимальная длительность сеанса записи в секундах. int

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

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

PacketCaptureSettings (Настройки пакетаCapture)

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

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

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

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

PacketCaptureStorageLocation (Местоположение)

Имя Описание Ценность
путь к файлу Этот путь недопустим, если "Непрерывный захват" предоставляется с значением 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": "2024-07-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"
  }
}

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

Microsoft.Network/networkWatchers/packetCaptures

Имя Описание Ценность
apiVersion Версия API '2024-07-01'
имя имя ресурса. строка (обязательно)
свойства Свойства записи пакетов. PacketCaptureParametersOrPacketCaptureResultProperties (обязательно)
тип Тип ресурса "Microsoft.Network/networkWatchers/packetCaptures"

Фильтр PacketCapture

Имя Описание Ценность
localIPddress Локальный IP-адрес для фильтрации. Нотация: "127.0.0.1" для записи с одним адресом. "127.0.0.1-127.0.0.255" для диапазона. "127.0.0.1; 127.0.0.5"? для нескольких записей. В настоящее время несколько диапазонов не поддерживаются. Сочетание диапазонов с несколькими записями, которые в настоящее время не поддерживаются. По умолчанию = null. струна
локальный порт Локальный порт для фильтрации. Нотация: "80" для одной записи порта". 80-85" для диапазона. "80; 443;" для нескольких записей. В настоящее время несколько диапазонов не поддерживаются. Сочетание диапазонов с несколькими записями, которые в настоящее время не поддерживаются. По умолчанию = null. струна
протокол Протокол для фильтрации. "Любой"
"TCP"
"UDP"
remoteIPПрессест Локальный 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 из записи пакетов. строка[]
включать Список экземпляров AzureVMSS для запуска записи пакетов. строка[]

PacketCaptureParametersOrPacketCaptureResultProperties

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

Ограничения целостности:
Минимальное значение = 0
Максимальное значение = 4294967295
captureSettings Параметр записи содержит значения FileCount, FileSizeInBytes, SessionTimeLimitInSeconds. PacketCaptureSettings (Настройки пакетаCapture)
непрерывныйЗахват Этот непрерывный захват представляет собой логическое значение, допускающее значение NULL, true или false. Если этот параметр не передается, значение по умолчанию равно NULL. булевая переменная (bool)
фильтры Список фильтров отслеживания пакетов. PacketCaptureFilter[]
охват Список экземпляров AzureVMSS, которые можно включить или исключить для выполнения записи пакетов. Если оба включенных и исключенных являются пустыми, запись пакетов будет выполняться во всех экземплярах AzureVMSS. PacketCaptureMachineScope (ПакетЗахватМашиноскоп)
хранилищеРасположение Расположение хранилища для сеанса записи пакетов. PacketCaptureStorageLocation (обязательно)
цель Идентификатор целевого ресурса, в настоящее время поддерживаются только AzureVM и AzureVMSS в качестве целевого типа. строка (обязательно)
тип цели Целевой тип предоставленного ресурса. AzureVM
AzureVMSS
timeLimitInSeconds Максимальная длительность сеанса записи в секундах. int

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

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

PacketCaptureSettings (Настройки пакетаCapture)

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

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

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

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

PacketCaptureStorageLocation (Местоположение)

Имя Описание Ценность
путь к файлу Этот путь недопустим, если "Непрерывный захват" предоставляется с значением 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@2024-07-01"
  name = "string"
  parent_id = "string"
  body = {
    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
    }
  }
}

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

Microsoft.Network/networkWatchers/packetCaptures

Имя Описание Ценность
имя имя ресурса. строка (обязательно)
идентификатор_родителя Идентификатор ресурса, который является родительским для этого ресурса. Идентификатор ресурса типа: networkWatchers
свойства Свойства записи пакетов. PacketCaptureParametersOrPacketCaptureResultProperties (обязательно)
тип Тип ресурса "Microsoft.Network/networkWatchers/packetCaptures@2024-07-01"

Фильтр PacketCapture

Имя Описание Ценность
localIPddress Локальный IP-адрес для фильтрации. Нотация: "127.0.0.1" для записи с одним адресом. "127.0.0.1-127.0.0.255" для диапазона. "127.0.0.1; 127.0.0.5"? для нескольких записей. В настоящее время несколько диапазонов не поддерживаются. Сочетание диапазонов с несколькими записями, которые в настоящее время не поддерживаются. По умолчанию = null. струна
локальный порт Локальный порт для фильтрации. Нотация: "80" для одной записи порта". 80-85" для диапазона. "80; 443;" для нескольких записей. В настоящее время несколько диапазонов не поддерживаются. Сочетание диапазонов с несколькими записями, которые в настоящее время не поддерживаются. По умолчанию = null. струна
протокол Протокол для фильтрации. "Любой"
"TCP"
"UDP"
remoteIPПрессест Локальный 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 из записи пакетов. строка[]
включать Список экземпляров AzureVMSS для запуска записи пакетов. строка[]

PacketCaptureParametersOrPacketCaptureResultProperties

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

Ограничения целостности:
Минимальное значение = 0
Максимальное значение = 4294967295
captureSettings Параметр записи содержит значения FileCount, FileSizeInBytes, SessionTimeLimitInSeconds. PacketCaptureSettings (Настройки пакетаCapture)
непрерывныйЗахват Этот непрерывный захват представляет собой логическое значение, допускающее значение NULL, true или false. Если этот параметр не передается, значение по умолчанию равно NULL. булевая переменная (bool)
фильтры Список фильтров отслеживания пакетов. PacketCaptureFilter[]
охват Список экземпляров AzureVMSS, которые можно включить или исключить для выполнения записи пакетов. Если оба включенных и исключенных являются пустыми, запись пакетов будет выполняться во всех экземплярах AzureVMSS. PacketCaptureMachineScope (ПакетЗахватМашиноскоп)
хранилищеРасположение Расположение хранилища для сеанса записи пакетов. PacketCaptureStorageLocation (обязательно)
цель Идентификатор целевого ресурса, в настоящее время поддерживаются только AzureVM и AzureVMSS в качестве целевого типа. строка (обязательно)
тип цели Целевой тип предоставленного ресурса. AzureVM
AzureVMSS
timeLimitInSeconds Максимальная длительность сеанса записи в секундах. int

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

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

PacketCaptureSettings (Настройки пакетаCapture)

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

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

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

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

PacketCaptureStorageLocation (Местоположение)

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