Share via

Microsoft.Network networkWatchers/packetCaptures 2023-11-01

  • Artículo

Definición de recursos de Bicep

El tipo de recurso networkWatchers/packetCaptures se puede implementar con operaciones destinadas a:

Para obtener una lista de las propiedades modificadas en cada versión de api, consulte registro de cambios.

Formato de los recursos

Para crear un recurso Microsoft.Network/networkWatchers/packetCaptures, agregue el siguiente bicep a la plantilla.

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

Valores de propiedad

networkWatchers/packetCaptures

Nombre Descripción Value
name El nombre del recurso

Vea cómo establecer nombres y tipos para recursos secundarios en Bicep.		 string (obligatorio)
primario En Bicep, puede especificar el recurso primario para un recurso secundario. Solo tiene que agregar esta propiedad cuando el recurso secundario se declara fuera del recurso primario.

Para más información, consulte Recurso secundario fuera del recurso primario.		 Nombre simbólico del recurso de tipo: networkWatchers
properties Propiedades de la captura de paquetes. PacketCaptureParametersOrPacketCaptureResultProperti... (obligatorio)

PacketCaptureParametersOrPacketCaptureResultProperti...

Nombre Descripción Valor
bytesToCapturePerPacket Número de bytes capturados por paquete, se truncan los bytes restantes. int

Restricciones:
Valor mínimo = 0
Valor máximo = 4294967295
captureSettings El valor de captura contiene los valores "FileCount", "FileSizeInBytes", "SessionTimeLimitInSeconds". PacketCaptureSettings
continuousCapture Esta captura continua es un valor booleano que acepta valores NULL, que puede contener el valor "null", "true" o "false". Si no pasamos este parámetro, se consideraría como "null", el valor predeterminado es "null". bool
filters Lista de filtros de captura de paquetes. PacketCaptureFilter[]
scope Lista de instancias de AzureVMSS que se pueden incluir o excluir para ejecutar la captura de paquetes. Si ambos incluidos y excluidos están vacíos, la captura de paquetes se ejecutará en todas las instancias de AzureVMSS. PacketCaptureMachineScope
storageLocation Ubicación de almacenamiento de una sesión de captura de paquetes. PacketCaptureStorageLocation (obligatorio)
Destino El identificador del recurso de destino, actualmente solo se admiten AzureVM y AzureVMSS como tipo de destino. string (obligatorio)
targetType Tipo de destino del recurso proporcionado. "AzureVM"
"AzureVMSS"
timeLimitInSeconds Duración máxima de la sesión de captura en segundos. int

Restricciones:
Valor mínimo = 0
Valor máximo = 18000
totalBytesPerSession Tamaño máximo de la salida de captura. int

Restricciones:
Valor mínimo = 0
Valor máximo = 4294967295

PacketCaptureSettings

Nombre Descripción Valor
fileCount Número de recuento de archivos. El valor predeterminado de count es 10 y el número máximo es 10000. int

Restricciones:
Valor mínimo = 0
Valor máximo = 10000
fileSizeInBytes Número de bytes capturados por paquete. Valor predeterminado en bytes 104857600 (100 MB) y máximo en bytes 4294967295 (4 GB). int

Restricciones:
Valor mínimo = 0
Valor máximo = 4294967295
sessionTimeLimitInSeconds La duración máxima de la sesión de captura en segundos es de 604800s (7 días) para un archivo. Valor predeterminado en los segundos 86400s (1 día). int

Restricciones:
Valor mínimo = 0
Valor máximo = 604800

PacketCaptureFilter

Nombre Descripción Valor
localIPAddress Dirección IP local en la que se va a filtrar. Notación: "127.0.0.1" para la entrada de dirección única. "127.0.0.1-127.0.0.255" para el intervalo. "127.0.0.1; 127.0.0.5"? para varias entradas. Actualmente no se admiten varios intervalos. Actualmente no se admite la combinación de intervalos con varias entradas. Valor predeterminado = null. string
localPort Puerto local en el que se va a filtrar. Notación: "80" para la entrada de puerto único". 80-85" para el rango. "80; 443;" para varias entradas. Actualmente no se admiten varios intervalos. Actualmente no se admite la combinación de intervalos con varias entradas. Valor predeterminado = null. string
protocol Protocolo en el que se va a filtrar. "Cualquiera"
'TCP'
'UDP'
remoteIPAddress Dirección IP local en la que se va a filtrar. Notación: "127.0.0.1" para la entrada de dirección única. "127.0.0.1-127.0.0.255" para el intervalo. "127.0.0.1; 127.0.0.5;" para varias entradas. Actualmente no se admiten varios intervalos. Actualmente no se admite la combinación de intervalos con varias entradas. Valor predeterminado = null. string
remotePort Puerto remoto en el que se va a filtrar. Notación: "80" para la entrada de puerto único". 80-85" para el rango. "80; 443;" para varias entradas. Actualmente no se admiten varios intervalos. Actualmente no se admite la combinación de intervalos con varias entradas. Valor predeterminado = null. string

PacketCaptureMachineScope

Nombre Descripción Valor
exclude Lista de instancias de AzureVMSS que se deben excluir de AzureVMSS de la captura de paquetes en ejecución. string[]
include Lista de instancias de AzureVMSS en las que ejecutar la captura de paquetes. string[]

PacketCaptureStorageLocation

Nombre Descripción Valor
filePath Esta ruta de acceso no es válida si se proporciona "Captura continua" con "true" o "false". Ruta de acceso local válida en la máquina virtual de destino. Debe incluir el nombre del archivo de captura (*.cap). Para la máquina virtual Linux, debe comenzar con /var/captures. Obligatorio si no se proporciona ningún identificador de almacenamiento; de lo contrario, es opcional. string
localPath Esta ruta de acceso es válida si se proporciona "Captura continua" con "true" o "false" y es necesario si no se proporciona ningún identificador de almacenamiento; de lo contrario, es opcional. Debe incluir el nombre del archivo de captura (*.cap). Para la máquina virtual Linux, debe comenzar con /var/captures. string
storageId Identificador de la cuenta de almacenamiento para guardar la sesión de captura de paquetes. Obligatorio si no se proporciona localPath o filePath. string
storagePath URI de la ruta de acceso de almacenamiento para guardar la captura de paquetes. Debe ser un URI bien formado que describa la ubicación para guardar la captura de paquetes. string

Definición de recursos de plantilla de ARM

El tipo de recurso networkWatchers/packetCaptures se puede implementar con operaciones destinadas a:

Para obtener una lista de las propiedades modificadas en cada versión de api, consulte registro de cambios.

Formato de los recursos

Para crear un recurso Microsoft.Network/networkWatchers/packetCaptures, agregue el siguiente json a la plantilla.

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

Valores de propiedad

networkWatchers/packetCaptures

Nombre Descripción Value
type Tipo de recurso "Microsoft.Network/networkWatchers/packetCaptures"
apiVersion La versión de la API de recursos '2023-11-01'
name El nombre del recurso

Consulte cómo establecer nombres y tipos para recursos secundarios en plantillas de ARM json.		 string (obligatorio)
properties Propiedades de la captura de paquetes. PacketCaptureParametersOrPacketCaptureResultProperti... (obligatorio)

PacketCaptureParametersOrPacketCaptureResultProperti...

Nombre Descripción Valor
bytesToCapturePerPacket Número de bytes capturados por paquete, se truncan los bytes restantes. int

Restricciones:
Valor mínimo = 0
Valor máximo = 4294967295
captureSettings El valor de captura contiene los valores "FileCount", "FileSizeInBytes", "SessionTimeLimitInSeconds". PacketCaptureSettings
continuousCapture Esta captura continua es un valor booleano que acepta valores NULL, que puede contener el valor "null", "true" o "false". Si no pasamos este parámetro, se consideraría como "null", el valor predeterminado es "null". bool
filters Lista de filtros de captura de paquetes. PacketCaptureFilter[]
scope Lista de instancias de AzureVMSS que se pueden incluir o excluir para ejecutar la captura de paquetes. Si ambos incluidos y excluidos están vacíos, la captura de paquetes se ejecutará en todas las instancias de AzureVMSS. PacketCaptureMachineScope
storageLocation Ubicación de almacenamiento de una sesión de captura de paquetes. PacketCaptureStorageLocation (obligatorio)
Destino El identificador del recurso de destino, actualmente solo se admiten AzureVM y AzureVMSS como tipo de destino. string (obligatorio)
targetType Tipo de destino del recurso proporcionado. "AzureVM"
"AzureVMSS"
timeLimitInSeconds Duración máxima de la sesión de captura en segundos. int

Restricciones:
Valor mínimo = 0
Valor máximo = 18000
totalBytesPerSession Tamaño máximo de la salida de captura. int

Restricciones:
Valor mínimo = 0
Valor máximo = 4294967295

PacketCaptureSettings

Nombre Descripción Valor
fileCount Número de recuento de archivos. El valor predeterminado de count es 10 y el número máximo es 10000. int

Restricciones:
Valor mínimo = 0
Valor máximo = 10000
fileSizeInBytes Número de bytes capturados por paquete. Valor predeterminado en bytes 104857600 (100 MB) y máximo en bytes 4294967295 (4 GB). int

Restricciones:
Valor mínimo = 0
Valor máximo = 4294967295
sessionTimeLimitInSeconds La duración máxima de la sesión de captura en segundos es de 604800s (7 días) para un archivo. Valor predeterminado en los segundos 86400s (1 día). int

Restricciones:
Valor mínimo = 0
Valor máximo = 604800

PacketCaptureFilter

Nombre Descripción Valor
localIPAddress Dirección IP local en la que se va a filtrar. Notación: "127.0.0.1" para la entrada de dirección única. "127.0.0.1-127.0.0.255" para el intervalo. "127.0.0.1; 127.0.0.5"? para varias entradas. Actualmente no se admiten varios intervalos. Actualmente no se admite la combinación de intervalos con varias entradas. Default = null. string
localPort Puerto local en el que se va a filtrar. Notación: "80" para una entrada de puerto único". 80-85" para rango. "80; 443;" para varias entradas. Actualmente no se admiten varios intervalos. Actualmente no se admite la combinación de rangos con varias entradas. Default = null. string
protocol Protocolo en el que se va a filtrar. "Cualquiera"
'TCP'
'UDP'
remoteIPAddress Dirección IP local en la que se va a filtrar. Notación: "127.0.0.1" para la entrada de dirección única. "127.0.0.1-127.0.0.255" para el rango. "127.0.0.1; 127.0.0.5;" para varias entradas. Actualmente no se admiten varios intervalos. Actualmente no se admite la combinación de rangos con varias entradas. Default = null. string
remotePort Puerto remoto en el que se va a filtrar. Notación: "80" para una entrada de puerto único". 80-85" para rango. "80; 443;" para varias entradas. Actualmente no se admiten varios intervalos. Actualmente no se admite la combinación de rangos con varias entradas. Default = null. string

PacketCaptureMachineScope

Nombre Descripción Valor
exclude Lista de instancias de AzureVMSS que se deben excluir de AzureVMSS de la captura de paquetes en ejecución. string[]
include Lista de instancias de AzureVMSS en las que ejecutar la captura de paquetes. string[]

PacketCaptureStorageLocation

Nombre Descripción Valor
filePath Esta ruta de acceso no es válida si se proporciona "Captura continua" con "true" o "false". Ruta de acceso local válida en la máquina virtual de destino. Debe incluir el nombre del archivo de captura (*.cap). Para la máquina virtual Linux, debe empezar con /var/captures. Obligatorio si no se proporciona ningún identificador de almacenamiento; de lo contrario, es opcional. string
localPath Esta ruta de acceso es válida si se proporciona "Captura continua" con "true" o "false" y es necesario si no se proporciona ningún identificador de almacenamiento; de lo contrario, es opcional. Debe incluir el nombre del archivo de captura (*.cap). Para la máquina virtual Linux, debe empezar con /var/captures. string
storageId Identificador de la cuenta de almacenamiento para guardar la sesión de captura de paquetes. Obligatorio si no se proporciona ningún valor localPath o filePath. string
storagePath URI de la ruta de acceso de almacenamiento para guardar la captura de paquetes. Debe ser un URI bien formado que describa la ubicación para guardar la captura de paquetes. string

Definición de recursos de Terraform (proveedor AzAPI)

El tipo de recurso networkWatchers/packetCaptures se puede implementar con operaciones destinadas a:

  • Grupos de recursos

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Formato de los recursos

Para crear un recurso Microsoft.Network/networkWatchers/packetCaptures, agregue el siguiente terraform a la plantilla.

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

Valores de propiedad

networkWatchers/packetCaptures

Nombre Descripción Value
type Tipo de recurso "Microsoft.Network/networkWatchers/packetCaptures@2023-11-01"
name El nombre del recurso string (obligatorio)
parent_id Identificador del recurso que es el elemento primario de este recurso. Identificador del recurso de tipo: networkWatchers
properties Propiedades de la captura de paquetes. PacketCaptureParametersOrPacketCaptureResultProperti... (obligatorio)

PacketCaptureParametersOrPacketCaptureResultProperti...

Nombre Descripción Valor
bytesToCapturePerPacket Número de bytes capturados por paquete, los bytes restantes se truncan. int

Restricciones:
Valor mínimo = 0
Valor máximo = 4294967295
captureSettings La configuración de captura contiene los valores "FileCount", "FileSizeInBytes", "SessionTimeLimitInSeconds". PacketCaptureSettings
continuousCapture Esta captura continua es un valor booleano que acepta valores NULL, que puede contener "null", "true" o "false". Si no se pasa este parámetro, se consideraría como 'null', el valor predeterminado es 'null'. bool
filters Una lista de filtros de captura de paquetes. PacketCaptureFilter[]
scope Lista de instancias de AzureVMSS que se pueden incluir o excluir para ejecutar la captura de paquetes. Si ambos incluidos y excluidos están vacíos, la captura de paquetes se ejecutará en todas las instancias de AzureVMSS. PacketCaptureMachineScope
storageLocation Ubicación de almacenamiento de una sesión de captura de paquetes. PacketCaptureStorageLocation (obligatorio)
Destino El identificador del recurso de destino, actualmente solo se admiten AzureVM y AzureVMSS como tipo de destino. string (obligatorio)
targetType Tipo de destino del recurso proporcionado. "AzureVM"
"AzureVMSS"
timeLimitInSeconds Duración máxima de la sesión de captura en segundos. int

Restricciones:
Valor mínimo = 0
Valor máximo = 18000
totalBytesPerSession Tamaño máximo de la salida de captura. int

Restricciones:
Valor mínimo = 0
Valor máximo = 4294967295

PacketCaptureSettings

Nombre Descripción Valor
fileCount Número de recuento de archivos. El valor predeterminado de count es 10 y el número máximo es 10000. int

Restricciones:
Valor mínimo = 0
Valor máximo = 10000
fileSizeInBytes Número de bytes capturados por paquete. Valor predeterminado en bytes 104857600 (100 MB) y máximo en bytes 4294967295 (4 GB). int

Restricciones:
Valor mínimo = 0
Valor máximo = 4294967295
sessionTimeLimitInSeconds La duración máxima de la sesión de captura en segundos es de 604800s (7 días) para un archivo. Valor predeterminado en segundo 86400s (1 día). int

Restricciones:
Valor mínimo = 0
Valor máximo = 604800

PacketCaptureFilter

Nombre Descripción Valor
localIPAddress Dirección IP local en la que se va a filtrar. Notación: "127.0.0.1" para la entrada de dirección única. "127.0.0.1-127.0.0.255" para el rango. "127.0.0.1; 127.0.0.5"? para varias entradas. Actualmente no se admiten varios intervalos. Actualmente no se admite la combinación de rangos con varias entradas. Default = null. string
localPort Puerto local en el que se va a filtrar. Notación: "80" para una entrada de puerto único". 80-85" para rango. "80; 443;" para varias entradas. Actualmente no se admiten varios intervalos. Actualmente no se admite la combinación de rangos con varias entradas. Default = null. string
protocol Protocolo en el que se va a filtrar. "Cualquiera"
"TCP"
"UDP"
remoteIPAddress Dirección IP local en la que se va a filtrar. Notación: "127.0.0.1" para la entrada de dirección única. "127.0.0.1-127.0.0.255" para el rango. "127.0.0.1; 127.0.0.5;" para varias entradas. Actualmente no se admiten varios intervalos. Actualmente no se admite la combinación de rangos con varias entradas. Default = null. string
remotePort Puerto remoto en el que se va a filtrar. Notación: "80" para una entrada de puerto único". 80-85" para rango. "80; 443;" para varias entradas. Actualmente no se admiten varios intervalos. Actualmente no se admite la combinación de rangos con varias entradas. Default = null. string

PacketCaptureMachineScope

Nombre Descripción Valor
exclude Lista de instancias de AzureVMSS que se deben excluir de AzureVMSS de la captura de paquetes en ejecución. string[]
include Lista de instancias de AzureVMSS en las que ejecutar la captura de paquetes. string[]

PacketCaptureStorageLocation

Nombre Descripción Valor
filePath Esta ruta de acceso no es válida si se proporciona "Captura continua" con "true" o "false". Ruta de acceso local válida en la máquina virtual de destino. Debe incluir el nombre del archivo de captura (*.cap). Para la máquina virtual Linux, debe empezar con /var/captures. Obligatorio si no se proporciona ningún identificador de almacenamiento; de lo contrario, es opcional. string
localPath Esta ruta de acceso es válida si se proporciona "Captura continua" con "true" o "false" y es necesario si no se proporciona ningún identificador de almacenamiento; de lo contrario, es opcional. Debe incluir el nombre del archivo de captura (*.cap). Para la máquina virtual Linux, debe empezar con /var/captures. string
storageId Identificador de la cuenta de almacenamiento para guardar la sesión de captura de paquetes. Obligatorio si no se proporciona ningún valor localPath o filePath. string
storagePath URI de la ruta de acceso de almacenamiento para guardar la captura de paquetes. Debe ser un URI bien formado que describa la ubicación para guardar la captura de paquetes. string