Partilhar via

Microsoft.Network networkWatchers/packetCaptures 2024-01-01

  • Artigo

Definição de recursos do bíceps

O tipo de recurso networkWatchers/packetCaptures pode ser implantado com operações direcionadas:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato do recurso

Para criar um recurso Microsoft.Network/networkWatchers/packetCaptures, adicione o seguinte Bíceps ao seu modelo.

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

Valores de propriedade

Microsoft.Network/networkWatchers/packetCaptures

Designação Descrição Valor
Designação O nome do recurso string (obrigatório)
pai No Bicep, você pode especificar o recurso pai para um recurso filho. Você só precisa adicionar essa propriedade quando o recurso filho é declarado fora do recurso pai.

Para obter mais informações, consulte recurso filho fora do recurso pai.		 Nome simbólico para recurso do tipo: networkWatchers
propriedades Propriedades da captura de pacote. PacketCaptureParametersOrPacketCaptureResultProperties (obrigatório)

PacketCaptureFilter

Designação Descrição Valor
localIPAddress Endereço IP local a ser filtrado. Notação: "127.0.0.1" para entrada de endereço único. "127.0.0.1-127.0.0.255" para o intervalo. "127.0.0.1; 127.0.0.5"? para várias entradas. Vários intervalos não são suportados atualmente. Intervalos de mistura com várias entradas não suportados no momento. Padrão = null. string
localPort Porta local a ser filtrada. Notação: "80" para entrada de porta única." 80-85" para o intervalo. "80; 443;" para entradas múltiplas. Vários intervalos não são suportados atualmente. Intervalos de mistura com várias entradas não suportados no momento. Padrão = null. string
protocolo Protocolo a ser filtrado. 'Qualquer'
'TCP'
'UDP'
endereço IPAddress remoto Endereço IP local a ser filtrado. Notação: "127.0.0.1" para entrada de endereço único. "127.0.0.1-127.0.0.255" para o intervalo. "127.0.0.1; 127.0.0.5;" para entradas múltiplas. Vários intervalos não são suportados atualmente. Intervalos de mistura com várias entradas não suportados no momento. Padrão = null. string
Porta remota Porta remota a ser filtrada. Notação: "80" para entrada de porta única." 80-85" para o intervalo. "80; 443;" para entradas múltiplas. Vários intervalos não são suportados atualmente. Intervalos de mistura com várias entradas não suportados no momento. Padrão = null. string

PacketCaptureMachineScope

Designação Descrição Valor
Excluir Lista de instâncias do AzureVMSS que devem ser excluídas do AzureVMSS da execução da captura de pacotes. string[]
incluem Lista de instâncias do AzureVMSS para executar a captura de pacotes. string[]

PacketCaptureParametersOrPacketCaptureResultProperties

Designação Descrição Valor
bytesToCapturePerPacket Número de bytes capturados por pacote, os bytes restantes são truncados. Int

Restrições:
Valor mínimo = 0
Valor máximo = 4294967295
captureSettings A configuração de captura contém os valores 'FileCount', 'FileSizeInBytes', 'SessionTimeLimitInSeconds'. PacketCaptureSettings
continuousCapture Esta captura contínua é um booleano anulável, que pode conter valor 'null', 'true' ou 'false'. Se não passarmos esse parâmetro, ele será considerado como 'null', o valor padrão é 'null'. Bool
filtros Uma lista de filtros de captura de pacotes. PacketCaptureFilter[]
Âmbito de aplicação Uma lista de instâncias do AzureVMSS que podem ser incluídas ou excluídas para executar a captura de pacotes. Se ambos incluídos e excluídos estiverem vazios, a captura de pacotes será executada em todas as instâncias do AzureVMSS. PacketCaptureMachineScope
armazenamentoLocalização O local de armazenamento para uma sessão de captura de pacotes. PacketCaptureStorageLocation (obrigatório)
público-alvo A ID do recurso de destino, apenas AzureVM e AzureVMSS como tipo de destino são suportados no momento. string (obrigatório)
Tipo de destino Tipo de destino do recurso fornecido. 'AzureVM'
'AzureVMSS'
timeLimitInSeconds Duração máxima da sessão de captura em segundos. Int

Restrições:
Valor mínimo = 0
Valor máximo = 18000
totalBytesPerSession Tamanho máximo da saída de captura. Int

Restrições:
Valor mínimo = 0
Valor máximo = 4294967295

PacketCaptureSettings

Designação Descrição Valor
fileCount Número de contagem de ficheiros. O valor padrão de contagem é 10 e o número máximo é 10000. Int

Restrições:
Valor mínimo = 0
Valor máximo = 10000
fileSizeInBytes Número de bytes capturados por pacote. Valor padrão em bytes 104857600 (100MB) e máximo em bytes 4294967295 (4GB). Int

Restrições:
Valor mínimo = 0
Valor máximo = 4294967295
sessionTimeLimitInSeconds A duração máxima da sessão de captura em segundos é de 604800s (7 dias) para um arquivo. Valor padrão no segundo 86400s (1 dia). Int

Restrições:
Valor mínimo = 0
Valor máximo = 604800

PacketCaptureStorageLocation

Designação Descrição Valor
filePath Este caminho é inválido se 'Captura contínua' for fornecido com 'true' ou 'false'. Um caminho local válido na VM de destino. Deve incluir o nome do arquivo de captura (*.cap). Para a máquina virtual linux, ela deve começar com /var/captures. Obrigatório se nenhum ID de armazenamento for fornecido, caso contrário, opcional. string
localPath Esse caminho é válido se 'Captura contínua' for fornecido com 'true' ou 'false' e necessário se nenhum ID de armazenamento for fornecido, caso contrário, opcional. Deve incluir o nome do arquivo de captura (*.cap). Para a máquina virtual linux, ela deve começar com /var/captures. string
storageId O ID da conta de armazenamento para salvar a sessão de captura de pacotes. Obrigatório se nenhum localPath ou filePath for fornecido. string
storagePath O URI do caminho de armazenamento para salvar a captura de pacote. Deve ser um URI bem formado descrevendo o local para salvar a captura de pacote. string

Definição de recurso de modelo ARM

O tipo de recurso networkWatchers/packetCaptures pode ser implantado com operações direcionadas:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato do recurso

Para criar um recurso Microsoft.Network/networkWatchers/packetCaptures, adicione o seguinte JSON ao seu modelo.

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

Valores de propriedade

Microsoft.Network/networkWatchers/packetCaptures

Designação Descrição Valor
apiVersion A versão api '2024-01-01'
Designação O nome do recurso string (obrigatório)
propriedades Propriedades da captura de pacote. PacketCaptureParametersOrPacketCaptureResultProperties (obrigatório)
tipo O tipo de recurso 'Microsoft.Network/networkWatchers/packetCaptures'

PacketCaptureFilter

Designação Descrição Valor
localIPAddress Endereço IP local a ser filtrado. Notação: "127.0.0.1" para entrada de endereço único. "127.0.0.1-127.0.0.255" para o intervalo. "127.0.0.1; 127.0.0.5"? para várias entradas. Vários intervalos não são suportados atualmente. Intervalos de mistura com várias entradas não suportados no momento. Padrão = null. string
localPort Porta local a ser filtrada. Notação: "80" para entrada de porta única." 80-85" para o intervalo. "80; 443;" para entradas múltiplas. Vários intervalos não são suportados atualmente. Intervalos de mistura com várias entradas não suportados no momento. Padrão = null. string
protocolo Protocolo a ser filtrado. 'Qualquer'
'TCP'
'UDP'
endereço IPAddress remoto Endereço IP local a ser filtrado. Notação: "127.0.0.1" para entrada de endereço único. "127.0.0.1-127.0.0.255" para o intervalo. "127.0.0.1; 127.0.0.5;" para entradas múltiplas. Vários intervalos não são suportados atualmente. Intervalos de mistura com várias entradas não suportados no momento. Padrão = null. string
Porta remota Porta remota a ser filtrada. Notação: "80" para entrada de porta única." 80-85" para o intervalo. "80; 443;" para entradas múltiplas. Vários intervalos não são suportados atualmente. Intervalos de mistura com várias entradas não suportados no momento. Padrão = null. string

PacketCaptureMachineScope

Designação Descrição Valor
Excluir Lista de instâncias do AzureVMSS que devem ser excluídas do AzureVMSS da execução da captura de pacotes. string[]
incluem Lista de instâncias do AzureVMSS para executar a captura de pacotes. string[]

PacketCaptureParametersOrPacketCaptureResultProperties

Designação Descrição Valor
bytesToCapturePerPacket Número de bytes capturados por pacote, os bytes restantes são truncados. Int

Restrições:
Valor mínimo = 0
Valor máximo = 4294967295
captureSettings A configuração de captura contém os valores 'FileCount', 'FileSizeInBytes', 'SessionTimeLimitInSeconds'. PacketCaptureSettings
continuousCapture Esta captura contínua é um booleano anulável, que pode conter valor 'null', 'true' ou 'false'. Se não passarmos esse parâmetro, ele será considerado como 'null', o valor padrão é 'null'. Bool
filtros Uma lista de filtros de captura de pacotes. PacketCaptureFilter[]
Âmbito de aplicação Uma lista de instâncias do AzureVMSS que podem ser incluídas ou excluídas para executar a captura de pacotes. Se ambos incluídos e excluídos estiverem vazios, a captura de pacotes será executada em todas as instâncias do AzureVMSS. PacketCaptureMachineScope
armazenamentoLocalização O local de armazenamento para uma sessão de captura de pacotes. PacketCaptureStorageLocation (obrigatório)
público-alvo A ID do recurso de destino, apenas AzureVM e AzureVMSS como tipo de destino são suportados no momento. string (obrigatório)
Tipo de destino Tipo de destino do recurso fornecido. 'AzureVM'
'AzureVMSS'
timeLimitInSeconds Duração máxima da sessão de captura em segundos. Int

Restrições:
Valor mínimo = 0
Valor máximo = 18000
totalBytesPerSession Tamanho máximo da saída de captura. Int

Restrições:
Valor mínimo = 0
Valor máximo = 4294967295

PacketCaptureSettings

Designação Descrição Valor
fileCount Número de contagem de ficheiros. O valor padrão de contagem é 10 e o número máximo é 10000. Int

Restrições:
Valor mínimo = 0
Valor máximo = 10000
fileSizeInBytes Número de bytes capturados por pacote. Valor padrão em bytes 104857600 (100MB) e máximo em bytes 4294967295 (4GB). Int

Restrições:
Valor mínimo = 0
Valor máximo = 4294967295
sessionTimeLimitInSeconds A duração máxima da sessão de captura em segundos é de 604800s (7 dias) para um arquivo. Valor padrão no segundo 86400s (1 dia). Int

Restrições:
Valor mínimo = 0
Valor máximo = 604800

PacketCaptureStorageLocation

Designação Descrição Valor
filePath Este caminho é inválido se 'Captura contínua' for fornecido com 'true' ou 'false'. Um caminho local válido na VM de destino. Deve incluir o nome do arquivo de captura (*.cap). Para a máquina virtual linux, ela deve começar com /var/captures. Obrigatório se nenhum ID de armazenamento for fornecido, caso contrário, opcional. string
localPath Esse caminho é válido se 'Captura contínua' for fornecido com 'true' ou 'false' e necessário se nenhum ID de armazenamento for fornecido, caso contrário, opcional. Deve incluir o nome do arquivo de captura (*.cap). Para a máquina virtual linux, ela deve começar com /var/captures. string
storageId O ID da conta de armazenamento para salvar a sessão de captura de pacotes. Obrigatório se nenhum localPath ou filePath for fornecido. string
storagePath O URI do caminho de armazenamento para salvar a captura de pacote. Deve ser um URI bem formado descrevendo o local para salvar a captura de pacote. string

Definição de recursos Terraform (provedor AzAPI)

O tipo de recurso networkWatchers/packetCaptures pode ser implantado com operações direcionadas:

  • Grupos de recursos

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato do recurso

Para criar um recurso Microsoft.Network/networkWatchers/packetCaptures, adicione o seguinte Terraform ao seu modelo.

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

Valores de propriedade

Microsoft.Network/networkWatchers/packetCaptures

Designação Descrição Valor
Designação O nome do recurso string (obrigatório)
parent_id A ID do recurso que é o pai para este recurso. ID do recurso do tipo: networkWatchers
propriedades Propriedades da captura de pacote. PacketCaptureParametersOrPacketCaptureResultProperties (obrigatório)
tipo O tipo de recurso "Microsoft.Network/networkWatchers/packetCaptures@2024-01-01"

PacketCaptureFilter

Designação Descrição Valor
localIPAddress Endereço IP local a ser filtrado. Notação: "127.0.0.1" para entrada de endereço único. "127.0.0.1-127.0.0.255" para o intervalo. "127.0.0.1; 127.0.0.5"? para várias entradas. Vários intervalos não são suportados atualmente. Intervalos de mistura com várias entradas não suportados no momento. Padrão = null. string
localPort Porta local a ser filtrada. Notação: "80" para entrada de porta única." 80-85" para o intervalo. "80; 443;" para entradas múltiplas. Vários intervalos não são suportados atualmente. Intervalos de mistura com várias entradas não suportados no momento. Padrão = null. string
protocolo Protocolo a ser filtrado. 'Qualquer'
'TCP'
'UDP'
endereço IPAddress remoto Endereço IP local a ser filtrado. Notação: "127.0.0.1" para entrada de endereço único. "127.0.0.1-127.0.0.255" para o intervalo. "127.0.0.1; 127.0.0.5;" para entradas múltiplas. Vários intervalos não são suportados atualmente. Intervalos de mistura com várias entradas não suportados no momento. Padrão = null. string
Porta remota Porta remota a ser filtrada. Notação: "80" para entrada de porta única." 80-85" para o intervalo. "80; 443;" para entradas múltiplas. Vários intervalos não são suportados atualmente. Intervalos de mistura com várias entradas não suportados no momento. Padrão = null. string

PacketCaptureMachineScope

Designação Descrição Valor
Excluir Lista de instâncias do AzureVMSS que devem ser excluídas do AzureVMSS da execução da captura de pacotes. string[]
incluem Lista de instâncias do AzureVMSS para executar a captura de pacotes. string[]

PacketCaptureParametersOrPacketCaptureResultProperties

Designação Descrição Valor
bytesToCapturePerPacket Número de bytes capturados por pacote, os bytes restantes são truncados. Int

Restrições:
Valor mínimo = 0
Valor máximo = 4294967295
captureSettings A configuração de captura contém os valores 'FileCount', 'FileSizeInBytes', 'SessionTimeLimitInSeconds'. PacketCaptureSettings
continuousCapture Esta captura contínua é um booleano anulável, que pode conter valor 'null', 'true' ou 'false'. Se não passarmos esse parâmetro, ele será considerado como 'null', o valor padrão é 'null'. Bool
filtros Uma lista de filtros de captura de pacotes. PacketCaptureFilter[]
Âmbito de aplicação Uma lista de instâncias do AzureVMSS que podem ser incluídas ou excluídas para executar a captura de pacotes. Se ambos incluídos e excluídos estiverem vazios, a captura de pacotes será executada em todas as instâncias do AzureVMSS. PacketCaptureMachineScope
armazenamentoLocalização O local de armazenamento para uma sessão de captura de pacotes. PacketCaptureStorageLocation (obrigatório)
público-alvo A ID do recurso de destino, apenas AzureVM e AzureVMSS como tipo de destino são suportados no momento. string (obrigatório)
Tipo de destino Tipo de destino do recurso fornecido. 'AzureVM'
'AzureVMSS'
timeLimitInSeconds Duração máxima da sessão de captura em segundos. Int

Restrições:
Valor mínimo = 0
Valor máximo = 18000
totalBytesPerSession Tamanho máximo da saída de captura. Int

Restrições:
Valor mínimo = 0
Valor máximo = 4294967295

PacketCaptureSettings

Designação Descrição Valor
fileCount Número de contagem de ficheiros. O valor padrão de contagem é 10 e o número máximo é 10000. Int

Restrições:
Valor mínimo = 0
Valor máximo = 10000
fileSizeInBytes Número de bytes capturados por pacote. Valor padrão em bytes 104857600 (100MB) e máximo em bytes 4294967295 (4GB). Int

Restrições:
Valor mínimo = 0
Valor máximo = 4294967295
sessionTimeLimitInSeconds A duração máxima da sessão de captura em segundos é de 604800s (7 dias) para um arquivo. Valor padrão no segundo 86400s (1 dia). Int

Restrições:
Valor mínimo = 0
Valor máximo = 604800

PacketCaptureStorageLocation

Designação Descrição Valor
filePath Este caminho é inválido se 'Captura contínua' for fornecido com 'true' ou 'false'. Um caminho local válido na VM de destino. Deve incluir o nome do arquivo de captura (*.cap). Para a máquina virtual linux, ela deve começar com /var/captures. Obrigatório se nenhum ID de armazenamento for fornecido, caso contrário, opcional. string
localPath Esse caminho é válido se 'Captura contínua' for fornecido com 'true' ou 'false' e necessário se nenhum ID de armazenamento for fornecido, caso contrário, opcional. Deve incluir o nome do arquivo de captura (*.cap). Para a máquina virtual linux, ela deve começar com /var/captures. string
storageId O ID da conta de armazenamento para salvar a sessão de captura de pacotes. Obrigatório se nenhum localPath ou filePath for fornecido. string
storagePath O URI do caminho de armazenamento para salvar a captura de pacote. Deve ser um URI bem formado descrevendo o local para salvar a captura de pacote. string