Compartilhar via

Microsoft.Network networkWatchers/packetCaptures 2024-01-01

  • Artigo

Definição de recurso do Bicep

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 de log de alterações.

Formato de recurso

Para criar um recurso Microsoft.Network/networkWatchers/packetCaptures, adicione o Bicep a seguir ao modelo.

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

Nome Descrição Valor
nome O nome do recurso cadeia de caracteres (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 do recurso do tipo: networkWatchers
Propriedades Propriedades da captura de pacotes. PacketCaptureParametersOrPacketCaptureResultProperties (obrigatório)

PacketCaptureFilter

Nome Descrição Valor
localIPAddress Endereço IP local no qual será filtrado. Notação: "127.0.0.1" para entrada de endereço único. "127.0.0.1-127.0.0.255" para intervalo. "127.0.0.1; 127.0.0.5"? para várias entradas. No momento, não há suporte para vários intervalos. Intervalos de combinação com várias entradas não compatíveis no momento. Padrão = nulo. corda
localPort Porta local a ser filtrada. Notação: "80" para entrada de porta única." 80-85" para intervalo. "80; 443;" para várias entradas. No momento, não há suporte para vários intervalos. Intervalos de combinação com várias entradas não compatíveis no momento. Padrão = nulo. corda
protocolo Protocolo no qual será filtrado. 'Any'
'TCP'
'UDP'
remoteIPAddress Endereço IP local no qual será filtrado. Notação: "127.0.0.1" para entrada de endereço único. "127.0.0.1-127.0.0.255" para intervalo. "127.0.0.1; 127.0.0.5;" para várias entradas. No momento, não há suporte para vários intervalos. Intervalos de combinação com várias entradas não compatíveis no momento. Padrão = nulo. corda
remotePort Porta remota a ser filtrada. Notação: "80" para entrada de porta única." 80-85" para intervalo. "80; 443;" para várias entradas. No momento, não há suporte para vários intervalos. Intervalos de combinação com várias entradas não compatíveis no momento. Padrão = nulo. corda

PacketCaptureMachineScope

Nome 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[]
incluir Lista de instâncias do AzureVMSS em que executar a captura de pacote. string[]

PacketCaptureParametersOrPacketCaptureResultProperties

Nome 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 Essa captura contínua é um valor booliano anulável, que pode conter valor 'nulo', 'true' ou 'false'. Se não passarmos esse parâmetro, ele será considerado como 'nulo', o valor padrão será 'nulo'. Bool
Filtros Uma lista de filtros de captura de pacotes. PacketCaptureFilter []
âmbito Uma lista de instâncias do AzureVMSS que podem ser incluídas ou excluídas para executar a captura de pacotes. Se incluídos e excluídos estiverem vazios, a captura de pacotes será executada em todas as instâncias do AzureVMSS. PacketCaptureMachineScope
storageLocation O local de armazenamento de uma sessão de captura de pacotes. PacketCaptureStorageLocation (obrigatório)
alvo Atualmente, há suporte para a ID do recurso de destino, apenas a AzureVM e o AzureVMSS como tipo de destino. cadeia de caracteres (obrigatório)
targetType 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

Nome Descrição Valor
fileCount Número de contagem de arquivos. O valor padrão da 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 (100 MB) e máximo em bytes 4294967295 (4 GB). 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 na segunda 86400s (1 dia). int

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

PacketCaptureStorageLocation

Nome Descrição Valor
filePath Esse caminho será 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 nenhuma ID de armazenamento for fornecida, caso contrário, opcional. corda
localPath Esse caminho será válido se a 'Captura Contínua' for fornecida com 'true' ou 'false' e for necessária se nenhuma ID de armazenamento for fornecida, 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. corda
storageId A ID da conta de armazenamento para salvar a sessão de captura de pacotes. Obrigatório se nenhum localPath ou filePath for fornecido. corda
storagePath O URI do caminho de armazenamento para salvar a captura de pacotes. Deve ser um URI bem formado descrevendo o local para salvar a captura de pacotes. corda

Definição de recurso de modelo do 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 de log de alterações.

Formato de recurso

Para criar um recurso Microsoft.Network/networkWatchers/packetCaptures, adicione o JSON a seguir ao 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

Nome Descrição Valor
apiVersion A versão da API '2024-01-01'
nome O nome do recurso cadeia de caracteres (obrigatório)
Propriedades Propriedades da captura de pacotes. PacketCaptureParametersOrPacketCaptureResultProperties (obrigatório)
tipo O tipo de recurso 'Microsoft.Network/networkWatchers/packetCaptures'

PacketCaptureFilter

Nome Descrição Valor
localIPAddress Endereço IP local no qual será filtrado. Notação: "127.0.0.1" para entrada de endereço único. "127.0.0.1-127.0.0.255" para intervalo. "127.0.0.1; 127.0.0.5"? para várias entradas. No momento, não há suporte para vários intervalos. Intervalos de combinação com várias entradas não compatíveis no momento. Padrão = nulo. corda
localPort Porta local a ser filtrada. Notação: "80" para entrada de porta única." 80-85" para intervalo. "80; 443;" para várias entradas. No momento, não há suporte para vários intervalos. Intervalos de combinação com várias entradas não compatíveis no momento. Padrão = nulo. corda
protocolo Protocolo no qual será filtrado. 'Any'
'TCP'
'UDP'
remoteIPAddress Endereço IP local no qual será filtrado. Notação: "127.0.0.1" para entrada de endereço único. "127.0.0.1-127.0.0.255" para intervalo. "127.0.0.1; 127.0.0.5;" para várias entradas. No momento, não há suporte para vários intervalos. Intervalos de combinação com várias entradas não compatíveis no momento. Padrão = nulo. corda
remotePort Porta remota a ser filtrada. Notação: "80" para entrada de porta única." 80-85" para intervalo. "80; 443;" para várias entradas. No momento, não há suporte para vários intervalos. Intervalos de combinação com várias entradas não compatíveis no momento. Padrão = nulo. corda

PacketCaptureMachineScope

Nome 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[]
incluir Lista de instâncias do AzureVMSS em que executar a captura de pacote. string[]

PacketCaptureParametersOrPacketCaptureResultProperties

Nome 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 Essa captura contínua é um valor booliano anulável, que pode conter valor 'nulo', 'true' ou 'false'. Se não passarmos esse parâmetro, ele será considerado como 'nulo', o valor padrão será 'nulo'. Bool
Filtros Uma lista de filtros de captura de pacotes. PacketCaptureFilter []
âmbito Uma lista de instâncias do AzureVMSS que podem ser incluídas ou excluídas para executar a captura de pacotes. Se incluídos e excluídos estiverem vazios, a captura de pacotes será executada em todas as instâncias do AzureVMSS. PacketCaptureMachineScope
storageLocation O local de armazenamento de uma sessão de captura de pacotes. PacketCaptureStorageLocation (obrigatório)
alvo Atualmente, há suporte para a ID do recurso de destino, apenas a AzureVM e o AzureVMSS como tipo de destino. cadeia de caracteres (obrigatório)
targetType 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

Nome Descrição Valor
fileCount Número de contagem de arquivos. O valor padrão da 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 (100 MB) e máximo em bytes 4294967295 (4 GB). 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 na segunda 86400s (1 dia). int

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

PacketCaptureStorageLocation

Nome Descrição Valor
filePath Esse caminho será 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 nenhuma ID de armazenamento for fornecida, caso contrário, opcional. corda
localPath Esse caminho será válido se a 'Captura Contínua' for fornecida com 'true' ou 'false' e for necessária se nenhuma ID de armazenamento for fornecida, 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. corda
storageId A ID da conta de armazenamento para salvar a sessão de captura de pacotes. Obrigatório se nenhum localPath ou filePath for fornecido. corda
storagePath O URI do caminho de armazenamento para salvar a captura de pacotes. Deve ser um URI bem formado descrevendo o local para salvar a captura de pacotes. corda

Definição de recurso do Terraform (provedor de 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 de log de alterações.

Formato de recurso

Para criar um recurso Microsoft.Network/networkWatchers/packetCaptures, adicione o Terraform a seguir 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

Nome Descrição Valor
nome O nome do recurso cadeia de caracteres (obrigatório)
parent_id A ID do recurso que é o pai desse recurso. ID do recurso do tipo: networkWatchers
Propriedades Propriedades da captura de pacotes. PacketCaptureParametersOrPacketCaptureResultProperties (obrigatório)
tipo O tipo de recurso "Microsoft.Network/networkWatchers/packetCaptures@2024-01-01"

PacketCaptureFilter

Nome Descrição Valor
localIPAddress Endereço IP local no qual será filtrado. Notação: "127.0.0.1" para entrada de endereço único. "127.0.0.1-127.0.0.255" para intervalo. "127.0.0.1; 127.0.0.5"? para várias entradas. No momento, não há suporte para vários intervalos. Intervalos de combinação com várias entradas não compatíveis no momento. Padrão = nulo. corda
localPort Porta local a ser filtrada. Notação: "80" para entrada de porta única." 80-85" para intervalo. "80; 443;" para várias entradas. No momento, não há suporte para vários intervalos. Intervalos de combinação com várias entradas não compatíveis no momento. Padrão = nulo. corda
protocolo Protocolo no qual será filtrado. 'Any'
'TCP'
'UDP'
remoteIPAddress Endereço IP local no qual será filtrado. Notação: "127.0.0.1" para entrada de endereço único. "127.0.0.1-127.0.0.255" para intervalo. "127.0.0.1; 127.0.0.5;" para várias entradas. No momento, não há suporte para vários intervalos. Intervalos de combinação com várias entradas não compatíveis no momento. Padrão = nulo. corda
remotePort Porta remota a ser filtrada. Notação: "80" para entrada de porta única." 80-85" para intervalo. "80; 443;" para várias entradas. No momento, não há suporte para vários intervalos. Intervalos de combinação com várias entradas não compatíveis no momento. Padrão = nulo. corda

PacketCaptureMachineScope

Nome 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[]
incluir Lista de instâncias do AzureVMSS em que executar a captura de pacote. string[]

PacketCaptureParametersOrPacketCaptureResultProperties

Nome 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 Essa captura contínua é um valor booliano anulável, que pode conter valor 'nulo', 'true' ou 'false'. Se não passarmos esse parâmetro, ele será considerado como 'nulo', o valor padrão será 'nulo'. Bool
Filtros Uma lista de filtros de captura de pacotes. PacketCaptureFilter []
âmbito Uma lista de instâncias do AzureVMSS que podem ser incluídas ou excluídas para executar a captura de pacotes. Se incluídos e excluídos estiverem vazios, a captura de pacotes será executada em todas as instâncias do AzureVMSS. PacketCaptureMachineScope
storageLocation O local de armazenamento de uma sessão de captura de pacotes. PacketCaptureStorageLocation (obrigatório)
alvo Atualmente, há suporte para a ID do recurso de destino, apenas a AzureVM e o AzureVMSS como tipo de destino. cadeia de caracteres (obrigatório)
targetType 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

Nome Descrição Valor
fileCount Número de contagem de arquivos. O valor padrão da 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 (100 MB) e máximo em bytes 4294967295 (4 GB). 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 na segunda 86400s (1 dia). int

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

PacketCaptureStorageLocation

Nome Descrição Valor
filePath Esse caminho será 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 nenhuma ID de armazenamento for fornecida, caso contrário, opcional. corda
localPath Esse caminho será válido se a 'Captura Contínua' for fornecida com 'true' ou 'false' e for necessária se nenhuma ID de armazenamento for fornecida, 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. corda
storageId A ID da conta de armazenamento para salvar a sessão de captura de pacotes. Obrigatório se nenhum localPath ou filePath for fornecido. corda
storagePath O URI do caminho de armazenamento para salvar a captura de pacotes. Deve ser um URI bem formado descrevendo o local para salvar a captura de pacotes. corda