Partager via

Microsoft.Insights dataCollectionRules 2021-04-01

  • Article

Définition de ressource Bicep

Le type de ressource dataCollectionRules 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.Insights/dataCollectionRules, ajoutez le bicep suivant à votre modèle.

resource symbolicname 'Microsoft.Insights/dataCollectionRules@2021-04-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  kind: 'string'
  properties: {
    dataFlows: [
      {
        destinations: [
          'string'
        ]
        streams: [
          'string'
        ]
      }
    ]
    dataSources: {
      extensions: [
        {
          extensionName: 'string'
          extensionSettings: any()
          inputDataSources: [
            'string'
          ]
          name: 'string'
          streams: [
            'string'
          ]
        }
      ]
      performanceCounters: [
        {
          counterSpecifiers: [
            'string'
          ]
          name: 'string'
          samplingFrequencyInSeconds: int
          streams: [
            'string'
          ]
        }
      ]
      syslog: [
        {
          facilityNames: [
            'string'
          ]
          logLevels: [
            'string'
          ]
          name: 'string'
          streams: 'Microsoft-Syslog'
        }
      ]
      windowsEventLogs: [
        {
          name: 'string'
          streams: [
            'string'
          ]
          xPathQueries: [
            'string'
          ]
        }
      ]
    }
    description: 'string'
    destinations: {
      azureMonitorMetrics: {
        name: 'string'
      }
      logAnalytics: [
        {
          name: 'string'
          workspaceResourceId: 'string'
        }
      ]
    }
  }
}

Valeurs de propriété

dataCollectionRules

Nom Description Valeur
nom Nom de la ressource chaîne (obligatoire)
emplacement Emplacement géographique où réside la ressource. chaîne (obligatoire)
étiquettes Balises de ressource. Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles
gentil Type de ressource. 'Linux'
'Windows'
Propriétés Propriétés de ressource. DataCollectionRuleResourceProperties

DataCollectionRuleResourceProperties

Nom Description Valeur
dataFlows Spécification des flux de données. DataFlow[]
dataSources Spécification des sources de données.
Cette propriété est facultative et peut être omise si la règle est destinée à être utilisée via des appels directs au point de terminaison approvisionné.		 DataCollectionRuleDataSources
description Description de la règle de collecte de données. corde
Destinations Spécification des destinations. DataCollectionRuleDestinations

DataFlow

Nom Description Valeur
Destinations Liste des destinations pour ce flux de données. string[]
Flux Liste des flux pour ce flux de données. Tableau de chaînes contenant l’un des éléments suivants :
'Microsoft-Event'
'Microsoft-InsightsMetrics'
'Microsoft-Perf'
'Microsoft-Syslog'
'Microsoft-WindowsEvent'

DataCollectionRuleDataSources

Nom Description Valeur
Extensions Liste des configurations de source de données d’extension de machine virtuelle Azure. ExtensionDataSource[]
performanceCounters Liste des configurations de source de données du compteur de performances. PerfCounterDataSource[]
syslog Liste des configurations de source de données Syslog. SyslogDataSource[]
windowsEventLogs Liste des configurations de source de données du journal des événements Windows. WindowsEventLogDataSource[]

ExtensionDataSource

Nom Description Valeur
extensionName Nom de l’extension de machine virtuelle. chaîne (obligatoire)
extensionSettings Paramètres d’extension. Le format est spécifique pour une extension particulière. Pour Bicep, vous pouvez utiliser la fonction any().
inputDataSources La liste des sources de données dont cette extension a besoin des données. string[]
nom Nom convivial de la source de données.
Ce nom doit être unique dans toutes les sources de données (quel que soit le type) dans la règle de collecte de données.		 corde
Flux Liste des flux auxquels cette source de données sera envoyée.
Un flux indique quel schéma sera utilisé pour ces données et généralement la table dans log Analytique les données seront envoyées.
 Tableau de chaînes contenant l’un des éléments suivants :
'Microsoft-Event'
'Microsoft-InsightsMetrics'
'Microsoft-Perf'
'Microsoft-Syslog'
'Microsoft-WindowsEvent'

PerfCounterDataSource

Nom Description Valeur
counterSpecifiers Liste des noms de spécificateur des compteurs de performances que vous souhaitez collecter.
Utilisez un caractère générique (*) pour collecter un compteur pour toutes les instances.
Pour obtenir la liste des compteurs de performances sur Windows, exécutez la commande « typeperf ».		 string[]
nom Nom convivial de la source de données.
Ce nom doit être unique dans toutes les sources de données (quel que soit le type) dans la règle de collecte de données.		 corde
samplingFrequencyInSeconds Nombre de secondes entre les mesures de compteur consécutives (échantillons). Int
Flux Liste des flux auxquels cette source de données sera envoyée.
Un flux indique quel schéma sera utilisé pour ces données et généralement la table dans log Analytique les données seront envoyées.
 Tableau de chaînes contenant l’un des éléments suivants :
'Microsoft-InsightsMetrics'
'Microsoft-Perf'

SyslogDataSource

Nom Description Valeur
facilityNames Liste des noms des installations. Tableau de chaînes contenant l’un des éléments suivants :
'*'
'alerte'
'audit'
'authentification'
'authpriv'
'horloge'
'cron'
'démon'
'ftp'
'kern'
'local0'
'local1'
'local2'
'local3'
'local4'
'local5'
'local6'
'local7'
'lpr'
'mail'
'mark'
'news'
'nopri'
'ntp'
'syslog'
'user'
'uucp'
logLevels Niveaux de journal à collecter. Tableau de chaînes contenant l’un des éléments suivants :
'*'
'Alerte'
'Critique'
'Déboguer'
'Urgence'
'Erreur'
'Info'
'Remarque'
'Avertissement'
nom Nom convivial de la source de données.
Ce nom doit être unique dans toutes les sources de données (quel que soit le type) dans la règle de collecte de données.		 corde
Flux Liste des flux auxquels cette source de données sera envoyée.
Un flux indique quel schéma sera utilisé pour ces données et généralement la table dans log Analytique les données seront envoyées.
 Tableau de chaînes contenant l’un des éléments suivants :
'Microsoft-Syslog'

WindowsEventLogDataSource

Nom Description Valeur
nom Nom convivial de la source de données.
Ce nom doit être unique dans toutes les sources de données (quel que soit le type) dans la règle de collecte de données.		 corde
Flux Liste des flux auxquels cette source de données sera envoyée.
Un flux indique quel schéma sera utilisé pour ces données et généralement la table dans log Analytique les données seront envoyées.		 Tableau de chaînes contenant l’un des éléments suivants :
'Microsoft-Event'
'Microsoft-WindowsEvent'
xPathQueries Liste des requêtes du journal des événements Windows au format XPATH. string[]

DataCollectionRuleDestinations

Nom Description Valeur
azureMonitorMetrics Destination des métriques Azure Monitor. DestinationsSpecAzureMonitorMetrics
logAnalytics Liste des destinations de journal Analytique. LogAnalyticsDestination[]

DestinationsSpecAzureMonitorMetrics

Nom Description Valeur
nom Nom convivial de la destination.
Ce nom doit être unique sur toutes les destinations (quel que soit le type) dans la règle de collecte de données.
 corde

LogAnalyticsDestination

Nom Description Valeur
nom Nom convivial de la destination.
Ce nom doit être unique sur toutes les destinations (quel que soit le type) dans la règle de collecte de données.		 corde
workspaceResourceId ID de ressource de l’espace de travail Log Analytique. corde

Modèles de démarrage rapide

Les modèles de démarrage rapide suivants déploient ce type de ressource.

Modèle Description
déployer des de mise à l’échelle automatique darktrace

Déployer sur Azure 		Ce modèle vous permet de déployer automatiquement un déploiement de mise à l’échelle automatique de darktrace vSensors
règle de collecte de données pour syslog

Déployer sur Azure 		Ce modèle crée une règle de collecte de données définissant la source de données (Syslog) et l’espace de travail de destination.

Définition de ressource de modèle ARM

Le type de ressource dataCollectionRules 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.Insights/dataCollectionRules, ajoutez le code JSON suivant à votre modèle.

{
  "type": "Microsoft.Insights/dataCollectionRules",
  "apiVersion": "2021-04-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "kind": "string",
  "properties": {
    "dataFlows": [
      {
        "destinations": [ "string" ],
        "streams": [ "string" ]
      }
    ],
    "dataSources": {
      "extensions": [
        {
          "extensionName": "string",
          "extensionSettings": {},
          "inputDataSources": [ "string" ],
          "name": "string",
          "streams": [ "string" ]
        }
      ],
      "performanceCounters": [
        {
          "counterSpecifiers": [ "string" ],
          "name": "string",
          "samplingFrequencyInSeconds": "int",
          "streams": [ "string" ]
        }
      ],
      "syslog": [
        {
          "facilityNames": [ "string" ],
          "logLevels": [ "string" ],
          "name": "string",
          "streams": "Microsoft-Syslog"
        }
      ],
      "windowsEventLogs": [
        {
          "name": "string",
          "streams": [ "string" ],
          "xPathQueries": [ "string" ]
        }
      ]
    },
    "description": "string",
    "destinations": {
      "azureMonitorMetrics": {
        "name": "string"
      },
      "logAnalytics": [
        {
          "name": "string",
          "workspaceResourceId": "string"
        }
      ]
    }
  }
}

Valeurs de propriété

dataCollectionRules

Nom Description Valeur
type Type de ressource 'Microsoft.Insights/dataCollectionRules'
apiVersion Version de l’API de ressource '2021-04-01'
nom Nom de la ressource chaîne (obligatoire)
emplacement Emplacement géographique où réside la ressource. chaîne (obligatoire)
étiquettes Balises de ressource. Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles
gentil Type de ressource. 'Linux'
'Windows'
Propriétés Propriétés de ressource. DataCollectionRuleResourceProperties

DataCollectionRuleResourceProperties

Nom Description Valeur
dataFlows Spécification des flux de données. DataFlow[]
dataSources Spécification des sources de données.
Cette propriété est facultative et peut être omise si la règle est destinée à être utilisée via des appels directs au point de terminaison approvisionné.		 DataCollectionRuleDataSources
description Description de la règle de collecte de données. corde
Destinations Spécification des destinations. DataCollectionRuleDestinations

DataFlow

Nom Description Valeur
Destinations Liste des destinations pour ce flux de données. string[]
Flux Liste des flux pour ce flux de données. Tableau de chaînes contenant l’un des éléments suivants :
'Microsoft-Event'
'Microsoft-InsightsMetrics'
'Microsoft-Perf'
'Microsoft-Syslog'
'Microsoft-WindowsEvent'

DataCollectionRuleDataSources

Nom Description Valeur
Extensions Liste des configurations de source de données d’extension de machine virtuelle Azure. ExtensionDataSource[]
performanceCounters Liste des configurations de source de données du compteur de performances. PerfCounterDataSource[]
syslog Liste des configurations de source de données Syslog. SyslogDataSource[]
windowsEventLogs Liste des configurations de source de données du journal des événements Windows. WindowsEventLogDataSource[]

ExtensionDataSource

Nom Description Valeur
extensionName Nom de l’extension de machine virtuelle. chaîne (obligatoire)
extensionSettings Paramètres d’extension. Le format est spécifique pour une extension particulière.
inputDataSources La liste des sources de données dont cette extension a besoin des données. string[]
nom Nom convivial de la source de données.
Ce nom doit être unique dans toutes les sources de données (quel que soit le type) dans la règle de collecte de données.		 corde
Flux Liste des flux auxquels cette source de données sera envoyée.
Un flux indique quel schéma sera utilisé pour ces données et généralement la table dans log Analytique les données seront envoyées.
 Tableau de chaînes contenant l’un des éléments suivants :
'Microsoft-Event'
'Microsoft-InsightsMetrics'
'Microsoft-Perf'
'Microsoft-Syslog'
'Microsoft-WindowsEvent'

PerfCounterDataSource

Nom Description Valeur
counterSpecifiers Liste des noms de spécificateur des compteurs de performances que vous souhaitez collecter.
Utilisez un caractère générique (*) pour collecter un compteur pour toutes les instances.
Pour obtenir la liste des compteurs de performances sur Windows, exécutez la commande « typeperf ».		 string[]
nom Nom convivial de la source de données.
Ce nom doit être unique dans toutes les sources de données (quel que soit le type) dans la règle de collecte de données.		 corde
samplingFrequencyInSeconds Nombre de secondes entre les mesures de compteur consécutives (échantillons). Int
Flux Liste des flux auxquels cette source de données sera envoyée.
Un flux indique quel schéma sera utilisé pour ces données et généralement la table dans log Analytique les données seront envoyées.
 Tableau de chaînes contenant l’un des éléments suivants :
'Microsoft-InsightsMetrics'
'Microsoft-Perf'

SyslogDataSource

Nom Description Valeur
facilityNames Liste des noms des installations. Tableau de chaînes contenant l’un des éléments suivants :
'*'
'alerte'
'audit'
'authentification'
'authpriv'
'horloge'
'cron'
'démon'
'ftp'
'kern'
'local0'
'local1'
'local2'
'local3'
'local4'
'local5'
'local6'
'local7'
'lpr'
'mail'
'mark'
'news'
'nopri'
'ntp'
'syslog'
'user'
'uucp'
logLevels Niveaux de journal à collecter. Tableau de chaînes contenant l’un des éléments suivants :
'*'
'Alerte'
'Critique'
'Déboguer'
'Urgence'
'Erreur'
'Info'
'Remarque'
'Avertissement'
nom Nom convivial de la source de données.
Ce nom doit être unique dans toutes les sources de données (quel que soit le type) dans la règle de collecte de données.		 corde
Flux Liste des flux auxquels cette source de données sera envoyée.
Un flux indique quel schéma sera utilisé pour ces données et généralement la table dans log Analytique les données seront envoyées.
 Tableau de chaînes contenant l’un des éléments suivants :
'Microsoft-Syslog'

WindowsEventLogDataSource

Nom Description Valeur
nom Nom convivial de la source de données.
Ce nom doit être unique dans toutes les sources de données (quel que soit le type) dans la règle de collecte de données.		 corde
Flux Liste des flux auxquels cette source de données sera envoyée.
Un flux indique quel schéma sera utilisé pour ces données et généralement la table dans log Analytique les données seront envoyées.		 Tableau de chaînes contenant l’un des éléments suivants :
'Microsoft-Event'
'Microsoft-WindowsEvent'
xPathQueries Liste des requêtes du journal des événements Windows au format XPATH. string[]

DataCollectionRuleDestinations

Nom Description Valeur
azureMonitorMetrics Destination des métriques Azure Monitor. DestinationsSpecAzureMonitorMetrics
logAnalytics Liste des destinations de journal Analytique. LogAnalyticsDestination[]

DestinationsSpecAzureMonitorMetrics

Nom Description Valeur
nom Nom convivial de la destination.
Ce nom doit être unique sur toutes les destinations (quel que soit le type) dans la règle de collecte de données.
 corde

LogAnalyticsDestination

Nom Description Valeur
nom Nom convivial de la destination.
Ce nom doit être unique sur toutes les destinations (quel que soit le type) dans la règle de collecte de données.		 corde
workspaceResourceId ID de ressource de l’espace de travail Log Analytique. corde

Modèles de démarrage rapide

Les modèles de démarrage rapide suivants déploient ce type de ressource.

Modèle Description
déployer des de mise à l’échelle automatique darktrace

Déployer sur Azure 		Ce modèle vous permet de déployer automatiquement un déploiement de mise à l’échelle automatique de darktrace vSensors
règle de collecte de données pour syslog

Déployer sur Azure 		Ce modèle crée une règle de collecte de données définissant la source de données (Syslog) et l’espace de travail de destination.

Définition de ressource Terraform (fournisseur AzAPI)

Le type de ressource dataCollectionRules 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.Insights/dataCollectionRules, ajoutez terraform suivant à votre modèle.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Insights/dataCollectionRules@2021-04-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      dataFlows = [
        {
          destinations = [
            "string"
          ]
          streams = [
            "string"
          ]
        }
      ]
      dataSources = {
        extensions = [
          {
            extensionName = "string"
            inputDataSources = [
              "string"
            ]
            name = "string"
            streams = [
              "string"
            ]
          }
        ]
        performanceCounters = [
          {
            counterSpecifiers = [
              "string"
            ]
            name = "string"
            samplingFrequencyInSeconds = int
            streams = [
              "string"
            ]
          }
        ]
        syslog = [
          {
            facilityNames = [
              "string"
            ]
            logLevels = [
              "string"
            ]
            name = "string"
            streams = "Microsoft-Syslog"
          }
        ]
        windowsEventLogs = [
          {
            name = "string"
            streams = [
              "string"
            ]
            xPathQueries = [
              "string"
            ]
          }
        ]
      }
      description = "string"
      destinations = {
        azureMonitorMetrics = {
          name = "string"
        }
        logAnalytics = [
          {
            name = "string"
            workspaceResourceId = "string"
          }
        ]
      }
    }
    kind = "string"
  })
}

Valeurs de propriété

dataCollectionRules

Nom Description Valeur
type Type de ressource « Microsoft.Insights/dataCollectionRules@2021-04-01 »
nom Nom de la ressource chaîne (obligatoire)
emplacement Emplacement géographique où réside la ressource. chaîne (obligatoire)
parent_id Pour effectuer un déploiement sur un groupe de ressources, utilisez l’ID de ce groupe de ressources. chaîne (obligatoire)
étiquettes Balises de ressource. Dictionnaire de noms et de valeurs d’étiquettes.
gentil Type de ressource. « Linux »
« Windows »
Propriétés Propriétés de ressource. DataCollectionRuleResourceProperties

DataCollectionRuleResourceProperties

Nom Description Valeur
dataFlows Spécification des flux de données. DataFlow[]
dataSources Spécification des sources de données.
Cette propriété est facultative et peut être omise si la règle est destinée à être utilisée via des appels directs au point de terminaison approvisionné.		 DataCollectionRuleDataSources
description Description de la règle de collecte de données. corde
Destinations Spécification des destinations. DataCollectionRuleDestinations

DataFlow

Nom Description Valeur
Destinations Liste des destinations pour ce flux de données. string[]
Flux Liste des flux pour ce flux de données. Tableau de chaînes contenant l’un des éléments suivants :
« Microsoft-Event »
« Microsoft-InsightsMetrics »
« Microsoft-Perf »
« Microsoft-Syslog »
« Microsoft-WindowsEvent »

DataCollectionRuleDataSources

Nom Description Valeur
Extensions Liste des configurations de source de données d’extension de machine virtuelle Azure. ExtensionDataSource[]
performanceCounters Liste des configurations de source de données du compteur de performances. PerfCounterDataSource[]
syslog Liste des configurations de source de données Syslog. SyslogDataSource[]
windowsEventLogs Liste des configurations de source de données du journal des événements Windows. WindowsEventLogDataSource[]

ExtensionDataSource

Nom Description Valeur
extensionName Nom de l’extension de machine virtuelle. chaîne (obligatoire)
extensionSettings Paramètres d’extension. Le format est spécifique pour une extension particulière.
inputDataSources La liste des sources de données dont cette extension a besoin des données. string[]
nom Nom convivial de la source de données.
Ce nom doit être unique dans toutes les sources de données (quel que soit le type) dans la règle de collecte de données.		 corde
Flux Liste des flux auxquels cette source de données sera envoyée.
Un flux indique quel schéma sera utilisé pour ces données et généralement la table dans log Analytique les données seront envoyées.
 Tableau de chaînes contenant l’un des éléments suivants :
« Microsoft-Event »
« Microsoft-InsightsMetrics »
« Microsoft-Perf »
« Microsoft-Syslog »
« Microsoft-WindowsEvent »

PerfCounterDataSource

Nom Description Valeur
counterSpecifiers Liste des noms de spécificateur des compteurs de performances que vous souhaitez collecter.
Utilisez un caractère générique (*) pour collecter un compteur pour toutes les instances.
Pour obtenir la liste des compteurs de performances sur Windows, exécutez la commande « typeperf ».		 string[]
nom Nom convivial de la source de données.
Ce nom doit être unique dans toutes les sources de données (quel que soit le type) dans la règle de collecte de données.		 corde
samplingFrequencyInSeconds Nombre de secondes entre les mesures de compteur consécutives (échantillons). Int
Flux Liste des flux auxquels cette source de données sera envoyée.
Un flux indique quel schéma sera utilisé pour ces données et généralement la table dans log Analytique les données seront envoyées.
 Tableau de chaînes contenant l’un des éléments suivants :
« Microsoft-InsightsMetrics »
« Microsoft-Perf »

SyslogDataSource

Nom Description Valeur
facilityNames Liste des noms des installations. Tableau de chaînes contenant l’un des éléments suivants :
"*"
« alerte »
« audit »
« auth »
« authpriv »
« horloge »
« cron »
« démon »
« ftp »
« kern »
« local0 »
« local1 »
« local2 »
« local3 »
« local4 »
« local5 »
« local6 »
« local7 »
« lpr »
« courrier »
« mark »
« news »
« nopri »
« ntp »
« syslog »
« user »
« uucp »
logLevels Niveaux de journal à collecter. Tableau de chaînes contenant l’un des éléments suivants :
"*"
« Alerte »
« Critique »
« Déboguer »
« Urgence »
« Erreur »
« Info »
« Avis »
« Avertissement »
nom Nom convivial de la source de données.
Ce nom doit être unique dans toutes les sources de données (quel que soit le type) dans la règle de collecte de données.		 corde
Flux Liste des flux auxquels cette source de données sera envoyée.
Un flux indique quel schéma sera utilisé pour ces données et généralement la table dans log Analytique les données seront envoyées.
 Tableau de chaînes contenant l’un des éléments suivants :
« Microsoft-Syslog »

WindowsEventLogDataSource

Nom Description Valeur
nom Nom convivial de la source de données.
Ce nom doit être unique dans toutes les sources de données (quel que soit le type) dans la règle de collecte de données.		 corde
Flux Liste des flux auxquels cette source de données sera envoyée.
Un flux indique quel schéma sera utilisé pour ces données et généralement la table dans log Analytique les données seront envoyées.		 Tableau de chaînes contenant l’un des éléments suivants :
« Microsoft-Event »
« Microsoft-WindowsEvent »
xPathQueries Liste des requêtes du journal des événements Windows au format XPATH. string[]

DataCollectionRuleDestinations

Nom Description Valeur
azureMonitorMetrics Destination des métriques Azure Monitor. DestinationsSpecAzureMonitorMetrics
logAnalytics Liste des destinations de journal Analytique. LogAnalyticsDestination[]

DestinationsSpecAzureMonitorMetrics

Nom Description Valeur
nom Nom convivial de la destination.
Ce nom doit être unique sur toutes les destinations (quel que soit le type) dans la règle de collecte de données.
 corde

LogAnalyticsDestination

Nom Description Valeur
nom Nom convivial de la destination.
Ce nom doit être unique sur toutes les destinations (quel que soit le type) dans la règle de collecte de données.		 corde
workspaceResourceId ID de ressource de l’espace de travail Log Analytique. corde