Partager via

Microsoft.Network networkWatchers/packetCaptures 2022-01-01

  • Article

Définition de ressource Bicep

Le type de ressource networkWatchers/packetCaptures peut être déployé avec des opérations qui ciblent :

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.Network/networkWatchers/packetCaptures, ajoutez le bicep suivant à votre modèle.

resource symbolicname 'Microsoft.Network/networkWatchers/packetCaptures@2022-01-01' = {
  parent: resourceSymbolicName
  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
  }
}

Valeurs de propriété

Microsoft.Network/networkWatchers/packetCaptures

Nom Description Valeur
nom Nom de la ressource chaîne (obligatoire)
parent Dans Bicep, vous pouvez spécifier la ressource parente d’une ressource enfant. Vous devez uniquement ajouter cette propriété lorsque la ressource enfant est déclarée en dehors de la ressource parente.

Pour plus d’informations, consultez ressource enfant en dehors de la ressource parente.		 Nom symbolique de la ressource de type : networkWatchers
Propriétés Propriétés de la capture de paquets. PacketCaptureParametersOrPacketCaptureResultProperties (obligatoire)

PacketCaptureFilter

Nom Description Valeur
localIPAddress Adresse IP locale à filtrer. Notation : « 127.0.0.1 » pour l’entrée d’adresse unique. « 127.0.0.1-127.0.0.255 » pour la plage. "127.0.0.1; 127.0.0.5"? pour plusieurs entrées. Plusieurs plages ne sont actuellement pas prises en charge. Mélange de plages avec plusieurs entrées non prises en charge actuellement. Valeur par défaut = null. corde
localPort Port local à filtrer. Notation : « 80 » pour l’entrée de port unique. » 80 à 85 pouces pour la plage. "80; 443 ; » pour plusieurs entrées. Plusieurs plages ne sont actuellement pas prises en charge. Mélange de plages avec plusieurs entrées non prises en charge actuellement. Valeur par défaut = null. corde
protocole Protocole sur lequel filtrer. 'Any'
'TCP'
'UDP'
remoteIPAddress Adresse IP locale à filtrer. Notation : « 127.0.0.1 » pour l’entrée d’adresse unique. « 127.0.0.1-127.0.0.255 » pour la plage. "127.0.0.1; 127.0.0.5 ; » pour plusieurs entrées. Plusieurs plages ne sont actuellement pas prises en charge. Mélange de plages avec plusieurs entrées non prises en charge actuellement. Valeur par défaut = null. corde
remotePort Port distant sur lequel filtrer. Notation : « 80 » pour l’entrée de port unique. » 80 à 85 pouces pour la plage. "80; 443 ; » pour plusieurs entrées. Plusieurs plages ne sont actuellement pas prises en charge. Mélange de plages avec plusieurs entrées non prises en charge actuellement. Valeur par défaut = null. corde

PacketCaptureMachineScope

Nom Description Valeur
exclure Liste des instances AzureVMSS qui doivent être exclues d’AzureVMSS de l’exécution de la capture de paquets. string[]
inclure Liste des instances AzureVMSS sur laquelle exécuter la capture de paquets. string[]

PacketCaptureParametersOrPacketCaptureResultProperties

Nom Description Valeur
octetsToCapturePerPacket Nombre d’octets capturés par paquet, les octets restants sont tronqués. Int

Contraintes:
Valeur minimale = 0
Valeur maximale = 4294967295
Filtres Liste des filtres de capture de paquets. PacketCaptureFilter[]
portée Liste des instances AzureVMSS qui peuvent être incluses ou exclues pour exécuter la capture de paquets. Si les deux sont inclus et exclus sont vides, la capture de paquets s’exécute sur toutes les instances d’AzureVMSS. PacketCaptureMachineScope
storageLocation Emplacement de stockage d’une session de capture de paquets. PacketCaptureStorageLocation (obligatoire)
cible L’ID de la ressource ciblée, seule AzureVM et AzureVMSS comme type cible sont actuellement prises en charge. chaîne (obligatoire)
targetType Type cible de la ressource fournie. 'AzureVM'
'AzureVMSS'
timeLimitInSeconds Durée maximale de la session de capture en secondes. Int

Contraintes:
Valeur minimale = 0
Valeur maximale = 18000
totalBytesPerSession Taille maximale de la sortie de capture. Int

Contraintes:
Valeur minimale = 0
Valeur maximale = 4294967295

PacketCaptureStorageLocation

Nom Description Valeur
filePath Chemin local valide sur la machine virtuelle de ciblage. Doit inclure le nom du fichier de capture (*.cap). Pour la machine virtuelle Linux, elle doit commencer par /var/captures. Obligatoire si aucun ID de stockage n’est fourni, sinon facultatif. corde
storageId ID du compte de stockage pour enregistrer la session de capture de paquets. Obligatoire si aucun chemin de fichier local n’est fourni. corde
storagePath URI du chemin de stockage pour enregistrer la capture de paquets. Doit être un URI bien formé décrivant l’emplacement pour enregistrer la capture de paquets. corde

Définition de ressource de modèle ARM

Le type de ressource networkWatchers/packetCaptures peut être déployé avec des opérations qui ciblent :

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.Network/networkWatchers/packetCaptures, ajoutez le code JSON suivant à votre modèle.

{
  "type": "Microsoft.Network/networkWatchers/packetCaptures",
  "apiVersion": "2022-01-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"
  }
}

Valeurs de propriété

Microsoft.Network/networkWatchers/packetCaptures

Nom Description Valeur
apiVersion Version de l’API '2022-01-01'
nom Nom de la ressource chaîne (obligatoire)
Propriétés Propriétés de la capture de paquets. PacketCaptureParametersOrPacketCaptureResultProperties (obligatoire)
type Type de ressource 'Microsoft.Network/networkWatchers/packetCaptures'

PacketCaptureFilter

Nom Description Valeur
localIPAddress Adresse IP locale à filtrer. Notation : « 127.0.0.1 » pour l’entrée d’adresse unique. « 127.0.0.1-127.0.0.255 » pour la plage. "127.0.0.1; 127.0.0.5"? pour plusieurs entrées. Plusieurs plages ne sont actuellement pas prises en charge. Mélange de plages avec plusieurs entrées non prises en charge actuellement. Valeur par défaut = null. corde
localPort Port local à filtrer. Notation : « 80 » pour l’entrée de port unique. » 80 à 85 pouces pour la plage. "80; 443 ; » pour plusieurs entrées. Plusieurs plages ne sont actuellement pas prises en charge. Mélange de plages avec plusieurs entrées non prises en charge actuellement. Valeur par défaut = null. corde
protocole Protocole sur lequel filtrer. 'Any'
'TCP'
'UDP'
remoteIPAddress Adresse IP locale à filtrer. Notation : « 127.0.0.1 » pour l’entrée d’adresse unique. « 127.0.0.1-127.0.0.255 » pour la plage. "127.0.0.1; 127.0.0.5 ; » pour plusieurs entrées. Plusieurs plages ne sont actuellement pas prises en charge. Mélange de plages avec plusieurs entrées non prises en charge actuellement. Valeur par défaut = null. corde
remotePort Port distant sur lequel filtrer. Notation : « 80 » pour l’entrée de port unique. » 80 à 85 pouces pour la plage. "80; 443 ; » pour plusieurs entrées. Plusieurs plages ne sont actuellement pas prises en charge. Mélange de plages avec plusieurs entrées non prises en charge actuellement. Valeur par défaut = null. corde

PacketCaptureMachineScope

Nom Description Valeur
exclure Liste des instances AzureVMSS qui doivent être exclues d’AzureVMSS de l’exécution de la capture de paquets. string[]
inclure Liste des instances AzureVMSS sur laquelle exécuter la capture de paquets. string[]

PacketCaptureParametersOrPacketCaptureResultProperties

Nom Description Valeur
octetsToCapturePerPacket Nombre d’octets capturés par paquet, les octets restants sont tronqués. Int

Contraintes:
Valeur minimale = 0
Valeur maximale = 4294967295
Filtres Liste des filtres de capture de paquets. PacketCaptureFilter[]
portée Liste des instances AzureVMSS qui peuvent être incluses ou exclues pour exécuter la capture de paquets. Si les deux sont inclus et exclus sont vides, la capture de paquets s’exécute sur toutes les instances d’AzureVMSS. PacketCaptureMachineScope
storageLocation Emplacement de stockage d’une session de capture de paquets. PacketCaptureStorageLocation (obligatoire)
cible L’ID de la ressource ciblée, seule AzureVM et AzureVMSS comme type cible sont actuellement prises en charge. chaîne (obligatoire)
targetType Type cible de la ressource fournie. 'AzureVM'
'AzureVMSS'
timeLimitInSeconds Durée maximale de la session de capture en secondes. Int

Contraintes:
Valeur minimale = 0
Valeur maximale = 18000
totalBytesPerSession Taille maximale de la sortie de capture. Int

Contraintes:
Valeur minimale = 0
Valeur maximale = 4294967295

PacketCaptureStorageLocation

Nom Description Valeur
filePath Chemin local valide sur la machine virtuelle de ciblage. Doit inclure le nom du fichier de capture (*.cap). Pour la machine virtuelle Linux, elle doit commencer par /var/captures. Obligatoire si aucun ID de stockage n’est fourni, sinon facultatif. corde
storageId ID du compte de stockage pour enregistrer la session de capture de paquets. Obligatoire si aucun chemin de fichier local n’est fourni. corde
storagePath URI du chemin de stockage pour enregistrer la capture de paquets. Doit être un URI bien formé décrivant l’emplacement pour enregistrer la capture de paquets. corde

Définition de ressource Terraform (fournisseur AzAPI)

Le type de ressource networkWatchers/packetCaptures peut être déployé avec des opérations qui ciblent :

  • groupes de ressources

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.Network/networkWatchers/packetCaptures, ajoutez le terraform suivant à votre modèle.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/networkWatchers/packetCaptures@2022-01-01"
  name = "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
    }
  })
}

Valeurs de propriété

Microsoft.Network/networkWatchers/packetCaptures

Nom Description Valeur
nom Nom de la ressource chaîne (obligatoire)
parent_id ID de la ressource qui est le parent de cette ressource. ID de ressource de type : networkWatchers
Propriétés Propriétés de la capture de paquets. PacketCaptureParametersOrPacketCaptureResultProperties (obligatoire)
type Type de ressource « Microsoft.Network/networkWatchers/packetCaptures@2022-01-01 »

PacketCaptureFilter

Nom Description Valeur
localIPAddress Adresse IP locale à filtrer. Notation : « 127.0.0.1 » pour l’entrée d’adresse unique. « 127.0.0.1-127.0.0.255 » pour la plage. "127.0.0.1; 127.0.0.5"? pour plusieurs entrées. Plusieurs plages ne sont actuellement pas prises en charge. Mélange de plages avec plusieurs entrées non prises en charge actuellement. Valeur par défaut = null. corde
localPort Port local à filtrer. Notation : « 80 » pour l’entrée de port unique. » 80 à 85 pouces pour la plage. "80; 443 ; » pour plusieurs entrées. Plusieurs plages ne sont actuellement pas prises en charge. Mélange de plages avec plusieurs entrées non prises en charge actuellement. Valeur par défaut = null. corde
protocole Protocole sur lequel filtrer. 'Any'
'TCP'
'UDP'
remoteIPAddress Adresse IP locale à filtrer. Notation : « 127.0.0.1 » pour l’entrée d’adresse unique. « 127.0.0.1-127.0.0.255 » pour la plage. "127.0.0.1; 127.0.0.5 ; » pour plusieurs entrées. Plusieurs plages ne sont actuellement pas prises en charge. Mélange de plages avec plusieurs entrées non prises en charge actuellement. Valeur par défaut = null. corde
remotePort Port distant sur lequel filtrer. Notation : « 80 » pour l’entrée de port unique. » 80 à 85 pouces pour la plage. "80; 443 ; » pour plusieurs entrées. Plusieurs plages ne sont actuellement pas prises en charge. Mélange de plages avec plusieurs entrées non prises en charge actuellement. Valeur par défaut = null. corde

PacketCaptureMachineScope

Nom Description Valeur
exclure Liste des instances AzureVMSS qui doivent être exclues d’AzureVMSS de l’exécution de la capture de paquets. string[]
inclure Liste des instances AzureVMSS sur laquelle exécuter la capture de paquets. string[]

PacketCaptureParametersOrPacketCaptureResultProperties

Nom Description Valeur
octetsToCapturePerPacket Nombre d’octets capturés par paquet, les octets restants sont tronqués. Int

Contraintes:
Valeur minimale = 0
Valeur maximale = 4294967295
Filtres Liste des filtres de capture de paquets. PacketCaptureFilter[]
portée Liste des instances AzureVMSS qui peuvent être incluses ou exclues pour exécuter la capture de paquets. Si les deux sont inclus et exclus sont vides, la capture de paquets s’exécute sur toutes les instances d’AzureVMSS. PacketCaptureMachineScope
storageLocation Emplacement de stockage d’une session de capture de paquets. PacketCaptureStorageLocation (obligatoire)
cible L’ID de la ressource ciblée, seule AzureVM et AzureVMSS comme type cible sont actuellement prises en charge. chaîne (obligatoire)
targetType Type cible de la ressource fournie. 'AzureVM'
'AzureVMSS'
timeLimitInSeconds Durée maximale de la session de capture en secondes. Int

Contraintes:
Valeur minimale = 0
Valeur maximale = 18000
totalBytesPerSession Taille maximale de la sortie de capture. Int

Contraintes:
Valeur minimale = 0
Valeur maximale = 4294967295

PacketCaptureStorageLocation

Nom Description Valeur
filePath Chemin local valide sur la machine virtuelle de ciblage. Doit inclure le nom du fichier de capture (*.cap). Pour la machine virtuelle Linux, elle doit commencer par /var/captures. Obligatoire si aucun ID de stockage n’est fourni, sinon facultatif. corde
storageId ID du compte de stockage pour enregistrer la session de capture de paquets. Obligatoire si aucun chemin de fichier local n’est fourni. corde
storagePath URI du chemin de stockage pour enregistrer la capture de paquets. Doit être un URI bien formé décrivant l’emplacement pour enregistrer la capture de paquets. corde