Microsoft.Insights dataCollectionRules 2023-03-11
Définition de ressource Bicep
Le type de ressource dataCollectionRules peut être déployé avec des opérations qui ciblent :
- groupes de ressources - Consultez commandes de déploiement de 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 le bicep suivant à votre modèle.
resource symbolicname 'Microsoft.Insights/dataCollectionRules@2023-03-11' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
kind: 'string'
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
properties: {
agentSettings: {
logs: [
{
name: 'string'
value: 'string'
}
]
}
dataCollectionEndpointId: 'string'
dataFlows: [
{
builtInTransform: 'string'
captureOverflow: bool
destinations: [
'string'
]
outputStream: 'string'
streams: [
'string'
]
transformKql: 'string'
}
]
dataSources: {
dataImports: {
eventHub: {
consumerGroup: 'string'
name: 'string'
stream: 'string'
}
}
extensions: [
{
extensionName: 'string'
extensionSettings: any()
inputDataSources: [
'string'
]
name: 'string'
streams: [
'string'
]
}
]
iisLogs: [
{
logDirectories: [
'string'
]
name: 'string'
streams: [
'string'
]
transformKql: 'string'
}
]
logFiles: [
{
filePatterns: [
'string'
]
format: 'string'
name: 'string'
settings: {
text: {
recordStartTimestampFormat: 'string'
}
}
streams: [
'string'
]
transformKql: 'string'
}
]
performanceCounters: [
{
counterSpecifiers: [
'string'
]
name: 'string'
samplingFrequencyInSeconds: int
streams: [
'string'
]
transformKql: 'string'
}
]
platformTelemetry: [
{
name: 'string'
streams: [
'string'
]
}
]
prometheusForwarder: [
{
labelIncludeFilter: {
{customized property}: 'string'
}
name: 'string'
streams: 'Microsoft-PrometheusMetrics'
}
]
syslog: [
{
facilityNames: [
'string'
]
logLevels: [
'string'
]
name: 'string'
streams: 'Microsoft-Syslog'
transformKql: 'string'
}
]
windowsEventLogs: [
{
name: 'string'
streams: [
'string'
]
transformKql: 'string'
xPathQueries: [
'string'
]
}
]
windowsFirewallLogs: [
{
name: 'string'
profileFilter: [
'string'
]
streams: [
'string'
]
}
]
}
description: 'string'
destinations: {
azureDataExplorer: [
{
databaseName: 'string'
name: 'string'
resourceId: 'string'
}
]
azureMonitorMetrics: {
name: 'string'
}
eventHubs: [
{
eventHubResourceId: 'string'
name: 'string'
}
]
eventHubsDirect: [
{
eventHubResourceId: 'string'
name: 'string'
}
]
logAnalytics: [
{
name: 'string'
workspaceResourceId: 'string'
}
]
microsoftFabric: [
{
artifactId: 'string'
databaseName: 'string'
ingestionUri: 'string'
name: 'string'
tenantId: 'string'
}
]
monitoringAccounts: [
{
accountResourceId: 'string'
name: 'string'
}
]
storageAccounts: [
{
containerName: 'string'
name: 'string'
storageAccountResourceId: 'string'
}
]
storageBlobsDirect: [
{
containerName: 'string'
name: 'string'
storageAccountResourceId: 'string'
}
]
storageTablesDirect: [
{
name: 'string'
storageAccountResourceId: 'string'
tableName: 'string'
}
]
}
references: {
enrichmentData: {
storageBlobs: [
{
blobUrl: 'string'
lookupType: 'string'
name: 'string'
resourceId: 'string'
}
]
}
}
streamDeclarations: {
{customized property}: {
columns: [
{
name: 'string'
type: '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' |
| identité | Identité de service managée de la ressource. | DataCollectionRuleResourceIdentity |
| Propriétés | Propriétés de ressource. | DataCollectionRuleResourceProperties |
DataCollectionRuleResourceIdentity
| Nom | Description | Valeur |
|---|---|---|
| type | Type d’identité de service managé (où les types SystemAssigned et UserAssigned sont autorisés). | 'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' (obligatoire) |
| userAssignedIdentities | Ensemble d’identités affectées par l’utilisateur associées à la ressource. Les clés de dictionnaire userAssignedIdentities seront des ID de ressource ARM sous la forme : « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Les valeurs de dictionnaire peuvent être des objets vides ({}) dans les requêtes. | UserAssignedIdentities |
UserAssignedIdentities
| Nom | Description | Valeur |
|---|---|---|
| {propriété personnalisée} | UserAssignedIdentity |
UserAssignedIdentity
Cet objet ne contient aucune propriété à définir pendant le déploiement. Toutes les propriétés sont ReadOnly.
DataCollectionRuleResourceProperties
| Nom | Description | Valeur |
|---|---|---|
| agentSettings | Paramètres de l’agent utilisés pour modifier le comportement de l’agent sur un hôte donné | DataCollectionRuleAgentSettings |
| dataCollectionEndpointId | ID de ressource du point de terminaison de collecte de données avec lequel cette règle peut être utilisée. | corde |
| 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 |
| références | Définit toutes les références qui peuvent être utilisées dans d’autres sections de la DCR | DataCollectionRuleReferences |
| streamDeclarations | Déclaration de flux personnalisés utilisés dans cette règle. | DataCollectionRuleStreamDeclarations |
DataCollectionRuleAgentSettings
| Nom | Description | Valeur |
|---|---|---|
| Journaux | Tous les paramètres applicables à l’agent de journaux (AMA) | AgentSetting[] |
AgentSetting
| Nom | Description | Valeur |
|---|---|---|
| nom | Nom du paramètre. Doit faire partie de la liste des paramètres pris en charge |
'MaxDiskQuotaInMB' 'UseTimeReceivedForForwardedEvents' |
| valeur | Valeur du paramètre | corde |
DataFlow
| Nom | Description | Valeur |
|---|---|---|
| builtInTransform | Transformation builtIn pour transformer des données de flux | corde |
| captureOverflow | Indicateur pour activer la colonne de dépassement de capacité dans les destinations LA | Bool |
| Destinations | Liste des destinations pour ce flux de données. | string[] |
| outputStream | Flux de sortie de la transformation. Obligatoire uniquement si la transformation modifie les données en un autre flux. | corde |
| 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' |
| transformKql | Requête KQL pour transformer des données de flux. | corde |
DataCollectionRuleDataSources
| Nom | Description | Valeur |
|---|---|---|
| dataImports | Spécifications des sources de données basées sur extraction | DataSourcesSpecDataImports |
| Extensions | Liste des configurations de source de données d’extension de machine virtuelle Azure. | ExtensionDataSource[] |
| iisLogs | Liste des configurations sources des journaux IIS. | IisLogsDataSource[] |
| logFiles | Liste des configurations sources des fichiers journaux. | LogFilesDataSource[] |
| performanceCounters | Liste des configurations de source de données du compteur de performances. | PerfCounterDataSource[] |
| platformTelemetry | Liste des configurations de télémétrie de plateforme | PlatformTelemetryDataSource[] |
| prometheusForwarder | Liste des configurations de source de données du redirecteur Prometheus. | PrometheusForwarderDataSource[] |
| 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[] |
| windowsFirewallLogs | Liste des configurations sources du pare-feu Windows. | WindowsFirewallLogsDataSource[] |
DataSourcesSpecDataImports
| Nom | Description | Valeur |
|---|---|---|
| eventHub | Définition de la configuration Event Hub. | DataImportSourcesEventHub |
DataImportSourcesEventHub
| Nom | Description | Valeur |
|---|---|---|
| consumerGroup | Nom du groupe de consommateurs Event Hub | corde |
| 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 |
| ruisseau | Flux à collecter à partir d’EventHub | corde |
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' |
IisLogsDataSource
| Nom | Description | Valeur |
|---|---|---|
| logDirectories | Emplacement du fichier chemins d’accès absolus | 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 | Flux IIS | string[] (obligatoire) |
| transformKql | Requête KQL pour transformer la source de données. | corde |
LogFilesDataSource
| Nom | Description | Valeur |
|---|---|---|
| filePatterns | Modèles de fichiers où se trouvent les fichiers journaux | string[] (obligatoire) |
| format | Format de données des fichiers journaux | 'json' 'text' (obligatoire) |
| 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 |
| Paramètres | Paramètres spécifiques aux fichiers journaux. | LogFilesDataSourceSettings |
| Flux | Liste des flux auxquels cette source de données sera envoyée. Un flux indique quel schéma sera utilisé pour cette source de données |
string[] (obligatoire) |
| transformKql | Requête KQL pour transformer la source de données. | corde |
LogFilesDataSourceSettings
| Nom | Description | Valeur |
|---|---|---|
| SMS | Paramètres de texte | LogFileSettingsText |
LogFileSettingsText
| Nom | Description | Valeur |
|---|---|---|
| recordStartTimestampFormat | Un des formats d’horodatage pris en charge | 'ISO 8601' 'M/D/AAAA HH :MM :SS AM/PM' 'MMM d hh :mm :ss' 'Mon DD, AAAA HH :MM :SS' 'AAAA-MM-DD HH :MM :SS' 'dd/MMM/aaaa :HH :mm :ss zzz' 'ddMMyy HH :mm :ss' 'yyMMdd HH :mm :ss' 'aaaa-MM-ddTHH :mm :ssK' (obligatoire) |
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' |
| transformKql | Requête KQL pour transformer la source de données. | corde |
PlatformTelemetryDataSource
| 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 de télémétrie de plateforme à collecter | string[] (obligatoire) |
PrometheusForwarderDataSource
| Nom | Description | Valeur |
|---|---|---|
| labelIncludeFilter | Liste des filtres d’inclusion d’étiquettes sous la forme de paires « name-value ». Actuellement, une seule étiquette est prise en charge : « microsoft_metrics_include_label ». Les valeurs d’étiquette ne respectent pas la casse. |
PrometheusForwarderDataSourceLabelIncludeFilter |
| 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. | Tableau de chaînes contenant l’un des éléments suivants : 'Microsoft-PrometheusMetrics' |
PrometheusForwarderDataSourceLabelIncludeFilter
| Nom | Description | Valeur |
|---|---|---|
| {propriété personnalisée} | corde |
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' |
| transformKql | Requête KQL pour transformer la source de données. | corde |
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' |
| transformKql | Requête KQL pour transformer la source de données. | corde |
| xPathQueries | Liste des requêtes du journal des événements Windows au format XPATH. | string[] |
WindowsFirewallLogsDataSource
| 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 |
| profileFilter | Filtre de profil des journaux de pare-feu | Tableau de chaînes contenant l’un des éléments suivants : 'Domaine' 'Private' 'Public' |
| Flux | Flux des journaux de pare-feu | string[] (obligatoire) |
DataCollectionRuleDestinations
| Nom | Description | Valeur |
|---|---|---|
| azureDataExplorer | Liste des destinations Azure Data Explorer. | AdxDestination [] |
| azureMonitorMetrics | Destination des métriques Azure Monitor. | DestinationsSpecAzureMonitorMetrics |
| eventHubs | Liste des destinations Event Hubs. | EventHubDestination[] |
| eventHubsDirect | Liste des destinations Event Hubs Direct. | EventHubDirectDestination[] |
| logAnalytics | Liste des destinations de journal Analytique. | LogAnalyticsDestination[] |
| microsoftFabric | Liste des destinations Microsoft Fabric. | microsoftFabricDestination[] |
| monitoringAccounts | Liste des destinations de compte de surveillance. | MonitoringAccountDestination[] |
| storageAccounts | Liste des destinations des comptes de stockage. | StorageBlobDestination[] |
| storageBlobsDirect | Liste des destinations Blob Direct du stockage. Pour être utilisé uniquement pour l’envoi de données directement à stocker à partir de l’agent. | StorageBlobDestination[] |
| storageTablesDirect | Liste des destinations directes de table de stockage. | StorageTableDestination[] |
AdxDestination
| Nom | Description | Valeur |
|---|---|---|
| databaseName | Nom de la base de données dans laquelle les données seront ingérées. | corde |
| 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 |
| resourceId | ID de ressource ARM de la ressource Adx. | corde |
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 |
EventHubDestination
| Nom | Description | Valeur |
|---|---|---|
| eventHubResourceId | ID de ressource du hub d’événements. | corde |
| 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 |
EventHubDirectDestination
| Nom | Description | Valeur |
|---|---|---|
| eventHubResourceId | ID de ressource du hub d’événements. | corde |
| 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 |
MicrosoftFabricDestination
| Nom | Description | Valeur |
|---|---|---|
| artifactId | ID d’artefact de la ressource Microsoft Fabric. | corde |
| databaseName | Nom de la base de données dans laquelle les données seront ingérées. | corde |
| ingestionUri | Uri d’ingestion de la ressource Microsoft Fabric. | corde |
| 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 |
| tenantId | ID de locataire de la ressource Microsoft Fabric. | corde |
MonitoringAccountDestination
| Nom | Description | Valeur |
|---|---|---|
| accountResourceId | ID de ressource du compte de surveillance. | corde |
| 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 |
StorageBlobDestination
| Nom | Description | Valeur |
|---|---|---|
| containerName | Nom du conteneur de l’objet blob de stockage. | corde |
| 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 |
| storageAccountResourceId | ID de ressource du compte de stockage. | corde |
StorageTableDestination
| 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 |
| storageAccountResourceId | ID de ressource du compte de stockage. | corde |
| tableName | Nom de la table de stockage. | corde |
DataCollectionRuleReferences
| Nom | Description | Valeur |
|---|---|---|
| enrichData | Toutes les sources de données d’enrichissement référencées dans les flux de données | ReferencesSpecEnrichmentData |
ReferencesSpecEnrichmentData
| Nom | Description | Valeur |
|---|---|---|
| storageBlobs | Tous les objets blob de stockage utilisés comme sources de données d’enrichissement | StorageBlob[] |
StorageBlob
| Nom | Description | Valeur |
|---|---|---|
| blobUrl | URL de l’objet blob de stockage | corde |
| lookupType | Type de recherche à effectuer sur l’objet blob | 'Cidr' 'String' |
| nom | Nom de la source de données d’enrichissement utilisée comme alias lors du référencement de cette source de données dans les flux de données | corde |
| resourceId | ID de ressource du compte de stockage qui héberge l’objet blob | corde |
DataCollectionRuleStreamDeclarations
| Nom | Description | Valeur |
|---|---|---|
| {propriété personnalisée} | StreamDeclaration |
StreamDeclaration
| Nom | Description | Valeur |
|---|---|---|
| colonnes | Liste des colonnes utilisées par les données de ce flux. | ColumnDefinition[] |
ColumnDefinition
| Nom | Description | Valeur |
|---|---|---|
| nom | Nom de la colonne. | corde |
| type | Type des données de colonne. | 'boolean' 'datetime' 'dynamique' 'int' 'long' 'real' 'string' |
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
|
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
|
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 :
- groupes de ressources - Consultez commandes de déploiement de 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 le code JSON suivant à votre modèle.
{
"type": "Microsoft.Insights/dataCollectionRules",
"apiVersion": "2023-03-11",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"kind": "string",
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {}
}
},
"properties": {
"agentSettings": {
"logs": [
{
"name": "string",
"value": "string"
}
]
},
"dataCollectionEndpointId": "string",
"dataFlows": [
{
"builtInTransform": "string",
"captureOverflow": "bool",
"destinations": [ "string" ],
"outputStream": "string",
"streams": [ "string" ],
"transformKql": "string"
}
],
"dataSources": {
"dataImports": {
"eventHub": {
"consumerGroup": "string",
"name": "string",
"stream": "string"
}
},
"extensions": [
{
"extensionName": "string",
"extensionSettings": {},
"inputDataSources": [ "string" ],
"name": "string",
"streams": [ "string" ]
}
],
"iisLogs": [
{
"logDirectories": [ "string" ],
"name": "string",
"streams": [ "string" ],
"transformKql": "string"
}
],
"logFiles": [
{
"filePatterns": [ "string" ],
"format": "string",
"name": "string",
"settings": {
"text": {
"recordStartTimestampFormat": "string"
}
},
"streams": [ "string" ],
"transformKql": "string"
}
],
"performanceCounters": [
{
"counterSpecifiers": [ "string" ],
"name": "string",
"samplingFrequencyInSeconds": "int",
"streams": [ "string" ],
"transformKql": "string"
}
],
"platformTelemetry": [
{
"name": "string",
"streams": [ "string" ]
}
],
"prometheusForwarder": [
{
"labelIncludeFilter": {
"{customized property}": "string"
},
"name": "string",
"streams": "Microsoft-PrometheusMetrics"
}
],
"syslog": [
{
"facilityNames": [ "string" ],
"logLevels": [ "string" ],
"name": "string",
"streams": "Microsoft-Syslog",
"transformKql": "string"
}
],
"windowsEventLogs": [
{
"name": "string",
"streams": [ "string" ],
"transformKql": "string",
"xPathQueries": [ "string" ]
}
],
"windowsFirewallLogs": [
{
"name": "string",
"profileFilter": [ "string" ],
"streams": [ "string" ]
}
]
},
"description": "string",
"destinations": {
"azureDataExplorer": [
{
"databaseName": "string",
"name": "string",
"resourceId": "string"
}
],
"azureMonitorMetrics": {
"name": "string"
},
"eventHubs": [
{
"eventHubResourceId": "string",
"name": "string"
}
],
"eventHubsDirect": [
{
"eventHubResourceId": "string",
"name": "string"
}
],
"logAnalytics": [
{
"name": "string",
"workspaceResourceId": "string"
}
],
"microsoftFabric": [
{
"artifactId": "string",
"databaseName": "string",
"ingestionUri": "string",
"name": "string",
"tenantId": "string"
}
],
"monitoringAccounts": [
{
"accountResourceId": "string",
"name": "string"
}
],
"storageAccounts": [
{
"containerName": "string",
"name": "string",
"storageAccountResourceId": "string"
}
],
"storageBlobsDirect": [
{
"containerName": "string",
"name": "string",
"storageAccountResourceId": "string"
}
],
"storageTablesDirect": [
{
"name": "string",
"storageAccountResourceId": "string",
"tableName": "string"
}
]
},
"references": {
"enrichmentData": {
"storageBlobs": [
{
"blobUrl": "string",
"lookupType": "string",
"name": "string",
"resourceId": "string"
}
]
}
},
"streamDeclarations": {
"{customized property}": {
"columns": [
{
"name": "string",
"type": "string"
}
]
}
}
}
}
Valeurs de propriété
dataCollectionRules
| Nom | Description | Valeur |
|---|---|---|
| type | Type de ressource | 'Microsoft.Insights/dataCollectionRules' |
| apiVersion | Version de l’API de ressource | '2023-03-11' |
| 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' |
| identité | Identité de service managée de la ressource. | DataCollectionRuleResourceIdentity |
| Propriétés | Propriétés de ressource. | DataCollectionRuleResourceProperties |
DataCollectionRuleResourceIdentity
| Nom | Description | Valeur |
|---|---|---|
| type | Type d’identité de service managé (où les types SystemAssigned et UserAssigned sont autorisés). | 'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' (obligatoire) |
| userAssignedIdentities | Ensemble d’identités affectées par l’utilisateur associées à la ressource. Les clés de dictionnaire userAssignedIdentities seront des ID de ressource ARM sous la forme : « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Les valeurs de dictionnaire peuvent être des objets vides ({}) dans les requêtes. | UserAssignedIdentities |
UserAssignedIdentities
| Nom | Description | Valeur |
|---|---|---|
| {propriété personnalisée} | UserAssignedIdentity |
UserAssignedIdentity
Cet objet ne contient aucune propriété à définir pendant le déploiement. Toutes les propriétés sont ReadOnly.
DataCollectionRuleResourceProperties
| Nom | Description | Valeur |
|---|---|---|
| agentSettings | Paramètres de l’agent utilisés pour modifier le comportement de l’agent sur un hôte donné | DataCollectionRuleAgentSettings |
| dataCollectionEndpointId | ID de ressource du point de terminaison de collecte de données avec lequel cette règle peut être utilisée. | corde |
| 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 |
| références | Définit toutes les références qui peuvent être utilisées dans d’autres sections de la DCR | DataCollectionRuleReferences |
| streamDeclarations | Déclaration de flux personnalisés utilisés dans cette règle. | DataCollectionRuleStreamDeclarations |
DataCollectionRuleAgentSettings
| Nom | Description | Valeur |
|---|---|---|
| Journaux | Tous les paramètres applicables à l’agent de journaux (AMA) | AgentSetting[] |
AgentSetting
| Nom | Description | Valeur |
|---|---|---|
| nom | Nom du paramètre. Doit faire partie de la liste des paramètres pris en charge |
'MaxDiskQuotaInMB' 'UseTimeReceivedForForwardedEvents' |
| valeur | Valeur du paramètre | corde |
DataFlow
| Nom | Description | Valeur |
|---|---|---|
| builtInTransform | Transformation builtIn pour transformer des données de flux | corde |
| captureOverflow | Indicateur pour activer la colonne de dépassement de capacité dans les destinations LA | Bool |
| Destinations | Liste des destinations pour ce flux de données. | string[] |
| outputStream | Flux de sortie de la transformation. Obligatoire uniquement si la transformation modifie les données en un autre flux. | corde |
| 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' |
| transformKql | Requête KQL pour transformer des données de flux. | corde |
DataCollectionRuleDataSources
| Nom | Description | Valeur |
|---|---|---|
| dataImports | Spécifications des sources de données basées sur extraction | DataSourcesSpecDataImports |
| Extensions | Liste des configurations de source de données d’extension de machine virtuelle Azure. | ExtensionDataSource[] |
| iisLogs | Liste des configurations sources des journaux IIS. | IisLogsDataSource[] |
| logFiles | Liste des configurations sources des fichiers journaux. | LogFilesDataSource[] |
| performanceCounters | Liste des configurations de source de données du compteur de performances. | PerfCounterDataSource[] |
| platformTelemetry | Liste des configurations de télémétrie de plateforme | PlatformTelemetryDataSource[] |
| prometheusForwarder | Liste des configurations de source de données du redirecteur Prometheus. | PrometheusForwarderDataSource[] |
| 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[] |
| windowsFirewallLogs | Liste des configurations sources du pare-feu Windows. | WindowsFirewallLogsDataSource[] |
DataSourcesSpecDataImports
| Nom | Description | Valeur |
|---|---|---|
| eventHub | Définition de la configuration Event Hub. | DataImportSourcesEventHub |
DataImportSourcesEventHub
| Nom | Description | Valeur |
|---|---|---|
| consumerGroup | Nom du groupe de consommateurs Event Hub | corde |
| 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 |
| ruisseau | Flux à collecter à partir d’EventHub | corde |
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' |
IisLogsDataSource
| Nom | Description | Valeur |
|---|---|---|
| logDirectories | Emplacement du fichier chemins d’accès absolus | 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 | Flux IIS | string[] (obligatoire) |
| transformKql | Requête KQL pour transformer la source de données. | corde |
LogFilesDataSource
| Nom | Description | Valeur |
|---|---|---|
| filePatterns | Modèles de fichiers où se trouvent les fichiers journaux | string[] (obligatoire) |
| format | Format de données des fichiers journaux | 'json' 'text' (obligatoire) |
| 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 |
| Paramètres | Paramètres spécifiques aux fichiers journaux. | LogFilesDataSourceSettings |
| Flux | Liste des flux auxquels cette source de données sera envoyée. Un flux indique quel schéma sera utilisé pour cette source de données |
string[] (obligatoire) |
| transformKql | Requête KQL pour transformer la source de données. | corde |
LogFilesDataSourceSettings
| Nom | Description | Valeur |
|---|---|---|
| SMS | Paramètres de texte | LogFileSettingsText |
LogFileSettingsText
| Nom | Description | Valeur |
|---|---|---|
| recordStartTimestampFormat | Un des formats d’horodatage pris en charge | 'ISO 8601' 'M/D/AAAA HH :MM :SS AM/PM' 'MMM d hh :mm :ss' 'Mon DD, AAAA HH :MM :SS' 'AAAA-MM-DD HH :MM :SS' 'dd/MMM/aaaa :HH :mm :ss zzz' 'ddMMyy HH :mm :ss' 'yyMMdd HH :mm :ss' 'aaaa-MM-ddTHH :mm :ssK' (obligatoire) |
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' |
| transformKql | Requête KQL pour transformer la source de données. | corde |
PlatformTelemetryDataSource
| 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 de télémétrie de plateforme à collecter | string[] (obligatoire) |
PrometheusForwarderDataSource
| Nom | Description | Valeur |
|---|---|---|
| labelIncludeFilter | Liste des filtres d’inclusion d’étiquettes sous la forme de paires « name-value ». Actuellement, une seule étiquette est prise en charge : « microsoft_metrics_include_label ». Les valeurs d’étiquette ne respectent pas la casse. |
PrometheusForwarderDataSourceLabelIncludeFilter |
| 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. | Tableau de chaînes contenant l’un des éléments suivants : 'Microsoft-PrometheusMetrics' |
PrometheusForwarderDataSourceLabelIncludeFilter
| Nom | Description | Valeur |
|---|---|---|
| {propriété personnalisée} | corde |
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' |
| transformKql | Requête KQL pour transformer la source de données. | corde |
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' |
| transformKql | Requête KQL pour transformer la source de données. | corde |
| xPathQueries | Liste des requêtes du journal des événements Windows au format XPATH. | string[] |
WindowsFirewallLogsDataSource
| 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 |
| profileFilter | Filtre de profil des journaux de pare-feu | Tableau de chaînes contenant l’un des éléments suivants : 'Domaine' 'Private' 'Public' |
| Flux | Flux des journaux de pare-feu | string[] (obligatoire) |
DataCollectionRuleDestinations
| Nom | Description | Valeur |
|---|---|---|
| azureDataExplorer | Liste des destinations Azure Data Explorer. | AdxDestination [] |
| azureMonitorMetrics | Destination des métriques Azure Monitor. | DestinationsSpecAzureMonitorMetrics |
| eventHubs | Liste des destinations Event Hubs. | EventHubDestination[] |
| eventHubsDirect | Liste des destinations Event Hubs Direct. | EventHubDirectDestination[] |
| logAnalytics | Liste des destinations de journal Analytique. | LogAnalyticsDestination[] |
| microsoftFabric | Liste des destinations Microsoft Fabric. | microsoftFabricDestination[] |
| monitoringAccounts | Liste des destinations de compte de surveillance. | MonitoringAccountDestination[] |
| storageAccounts | Liste des destinations des comptes de stockage. | StorageBlobDestination[] |
| storageBlobsDirect | Liste des destinations Blob Direct du stockage. Pour être utilisé uniquement pour l’envoi de données directement à stocker à partir de l’agent. | StorageBlobDestination[] |
| storageTablesDirect | Liste des destinations directes de table de stockage. | StorageTableDestination[] |
AdxDestination
| Nom | Description | Valeur |
|---|---|---|
| databaseName | Nom de la base de données dans laquelle les données seront ingérées. | corde |
| 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 |
| resourceId | ID de ressource ARM de la ressource Adx. | corde |
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 |
EventHubDestination
| Nom | Description | Valeur |
|---|---|---|
| eventHubResourceId | ID de ressource du hub d’événements. | corde |
| 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 |
EventHubDirectDestination
| Nom | Description | Valeur |
|---|---|---|
| eventHubResourceId | ID de ressource du hub d’événements. | corde |
| 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 |
MicrosoftFabricDestination
| Nom | Description | Valeur |
|---|---|---|
| artifactId | ID d’artefact de la ressource Microsoft Fabric. | corde |
| databaseName | Nom de la base de données dans laquelle les données seront ingérées. | corde |
| ingestionUri | Uri d’ingestion de la ressource Microsoft Fabric. | corde |
| 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 |
| tenantId | ID de locataire de la ressource Microsoft Fabric. | corde |
MonitoringAccountDestination
| Nom | Description | Valeur |
|---|---|---|
| accountResourceId | ID de ressource du compte de surveillance. | corde |
| 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 |
StorageBlobDestination
| Nom | Description | Valeur |
|---|---|---|
| containerName | Nom du conteneur de l’objet blob de stockage. | corde |
| 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 |
| storageAccountResourceId | ID de ressource du compte de stockage. | corde |
StorageTableDestination
| 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 |
| storageAccountResourceId | ID de ressource du compte de stockage. | corde |
| tableName | Nom de la table de stockage. | corde |
DataCollectionRuleReferences
| Nom | Description | Valeur |
|---|---|---|
| enrichData | Toutes les sources de données d’enrichissement référencées dans les flux de données | ReferencesSpecEnrichmentData |
ReferencesSpecEnrichmentData
| Nom | Description | Valeur |
|---|---|---|
| storageBlobs | Tous les objets blob de stockage utilisés comme sources de données d’enrichissement | StorageBlob[] |
StorageBlob
| Nom | Description | Valeur |
|---|---|---|
| blobUrl | URL de l’objet blob de stockage | corde |
| lookupType | Type de recherche à effectuer sur l’objet blob | 'Cidr' 'String' |
| nom | Nom de la source de données d’enrichissement utilisée comme alias lors du référencement de cette source de données dans les flux de données | corde |
| resourceId | ID de ressource du compte de stockage qui héberge l’objet blob | corde |
DataCollectionRuleStreamDeclarations
| Nom | Description | Valeur |
|---|---|---|
| {propriété personnalisée} | StreamDeclaration |
StreamDeclaration
| Nom | Description | Valeur |
|---|---|---|
| colonnes | Liste des colonnes utilisées par les données de ce flux. | ColumnDefinition[] |
ColumnDefinition
| Nom | Description | Valeur |
|---|---|---|
| nom | Nom de la colonne. | corde |
| type | Type des données de colonne. | 'boolean' 'datetime' 'dynamique' 'int' 'long' 'real' 'string' |
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
|
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
|
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@2023-03-11"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
identity {
type = "string"
identity_ids = []
}
body = jsonencode({
properties = {
agentSettings = {
logs = [
{
name = "string"
value = "string"
}
]
}
dataCollectionEndpointId = "string"
dataFlows = [
{
builtInTransform = "string"
captureOverflow = bool
destinations = [
"string"
]
outputStream = "string"
streams = [
"string"
]
transformKql = "string"
}
]
dataSources = {
dataImports = {
eventHub = {
consumerGroup = "string"
name = "string"
stream = "string"
}
}
extensions = [
{
extensionName = "string"
inputDataSources = [
"string"
]
name = "string"
streams = [
"string"
]
}
]
iisLogs = [
{
logDirectories = [
"string"
]
name = "string"
streams = [
"string"
]
transformKql = "string"
}
]
logFiles = [
{
filePatterns = [
"string"
]
format = "string"
name = "string"
settings = {
text = {
recordStartTimestampFormat = "string"
}
}
streams = [
"string"
]
transformKql = "string"
}
]
performanceCounters = [
{
counterSpecifiers = [
"string"
]
name = "string"
samplingFrequencyInSeconds = int
streams = [
"string"
]
transformKql = "string"
}
]
platformTelemetry = [
{
name = "string"
streams = [
"string"
]
}
]
prometheusForwarder = [
{
labelIncludeFilter = {
{customized property} = "string"
}
name = "string"
streams = "Microsoft-PrometheusMetrics"
}
]
syslog = [
{
facilityNames = [
"string"
]
logLevels = [
"string"
]
name = "string"
streams = "Microsoft-Syslog"
transformKql = "string"
}
]
windowsEventLogs = [
{
name = "string"
streams = [
"string"
]
transformKql = "string"
xPathQueries = [
"string"
]
}
]
windowsFirewallLogs = [
{
name = "string"
profileFilter = [
"string"
]
streams = [
"string"
]
}
]
}
description = "string"
destinations = {
azureDataExplorer = [
{
databaseName = "string"
name = "string"
resourceId = "string"
}
]
azureMonitorMetrics = {
name = "string"
}
eventHubs = [
{
eventHubResourceId = "string"
name = "string"
}
]
eventHubsDirect = [
{
eventHubResourceId = "string"
name = "string"
}
]
logAnalytics = [
{
name = "string"
workspaceResourceId = "string"
}
]
microsoftFabric = [
{
artifactId = "string"
databaseName = "string"
ingestionUri = "string"
name = "string"
tenantId = "string"
}
]
monitoringAccounts = [
{
accountResourceId = "string"
name = "string"
}
]
storageAccounts = [
{
containerName = "string"
name = "string"
storageAccountResourceId = "string"
}
]
storageBlobsDirect = [
{
containerName = "string"
name = "string"
storageAccountResourceId = "string"
}
]
storageTablesDirect = [
{
name = "string"
storageAccountResourceId = "string"
tableName = "string"
}
]
}
references = {
enrichmentData = {
storageBlobs = [
{
blobUrl = "string"
lookupType = "string"
name = "string"
resourceId = "string"
}
]
}
}
streamDeclarations = {
{customized property} = {
columns = [
{
name = "string"
type = "string"
}
]
}
}
}
kind = "string"
})
}
Valeurs de propriété
dataCollectionRules
| Nom | Description | Valeur |
|---|---|---|
| type | Type de ressource | « Microsoft.Insights/dataCollectionRules@2023-03-11 » |
| 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 » |
| identité | Identité de service managée de la ressource. | DataCollectionRuleResourceIdentity |
| Propriétés | Propriétés de ressource. | DataCollectionRuleResourceProperties |
DataCollectionRuleResourceIdentity
| Nom | Description | Valeur |
|---|---|---|
| type | Type d’identité de service managé (où les types SystemAssigned et UserAssigned sont autorisés). | « SystemAssigned » « SystemAssigned,UserAssigned » « UserAssigned » (obligatoire) |
| identity_ids | Ensemble d’identités affectées par l’utilisateur associées à la ressource. Les clés de dictionnaire userAssignedIdentities seront des ID de ressource ARM sous la forme : « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Les valeurs de dictionnaire peuvent être des objets vides ({}) dans les requêtes. | Tableau d’ID d’identité utilisateur. |
UserAssignedIdentities
| Nom | Description | Valeur |
|---|---|---|
| {propriété personnalisée} | UserAssignedIdentity |
UserAssignedIdentity
Cet objet ne contient aucune propriété à définir pendant le déploiement. Toutes les propriétés sont ReadOnly.
DataCollectionRuleResourceProperties
| Nom | Description | Valeur |
|---|---|---|
| agentSettings | Paramètres de l’agent utilisés pour modifier le comportement de l’agent sur un hôte donné | DataCollectionRuleAgentSettings |
| dataCollectionEndpointId | ID de ressource du point de terminaison de collecte de données avec lequel cette règle peut être utilisée. | corde |
| 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 |
| références | Définit toutes les références qui peuvent être utilisées dans d’autres sections de la DCR | DataCollectionRuleReferences |
| streamDeclarations | Déclaration de flux personnalisés utilisés dans cette règle. | DataCollectionRuleStreamDeclarations |
DataCollectionRuleAgentSettings
| Nom | Description | Valeur |
|---|---|---|
| Journaux | Tous les paramètres applicables à l’agent de journaux (AMA) | AgentSetting[] |
AgentSetting
| Nom | Description | Valeur |
|---|---|---|
| nom | Nom du paramètre. Doit faire partie de la liste des paramètres pris en charge |
« MaxDiskQuotaInMB » « UseTimeReceivedForForwardedEvents » |
| valeur | Valeur du paramètre | corde |
DataFlow
| Nom | Description | Valeur |
|---|---|---|
| builtInTransform | Transformation builtIn pour transformer des données de flux | corde |
| captureOverflow | Indicateur pour activer la colonne de dépassement de capacité dans les destinations LA | Bool |
| Destinations | Liste des destinations pour ce flux de données. | string[] |
| outputStream | Flux de sortie de la transformation. Obligatoire uniquement si la transformation modifie les données en un autre flux. | corde |
| 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 » |
| transformKql | Requête KQL pour transformer des données de flux. | corde |
DataCollectionRuleDataSources
| Nom | Description | Valeur |
|---|---|---|
| dataImports | Spécifications des sources de données basées sur extraction | DataSourcesSpecDataImports |
| Extensions | Liste des configurations de source de données d’extension de machine virtuelle Azure. | ExtensionDataSource[] |
| iisLogs | Liste des configurations sources des journaux IIS. | IisLogsDataSource[] |
| logFiles | Liste des configurations sources des fichiers journaux. | LogFilesDataSource[] |
| performanceCounters | Liste des configurations de source de données du compteur de performances. | PerfCounterDataSource[] |
| platformTelemetry | Liste des configurations de télémétrie de plateforme | PlatformTelemetryDataSource[] |
| prometheusForwarder | Liste des configurations de source de données du redirecteur Prometheus. | PrometheusForwarderDataSource[] |
| 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[] |
| windowsFirewallLogs | Liste des configurations sources du pare-feu Windows. | WindowsFirewallLogsDataSource[] |
DataSourcesSpecDataImports
| Nom | Description | Valeur |
|---|---|---|
| eventHub | Définition de la configuration Event Hub. | DataImportSourcesEventHub |
DataImportSourcesEventHub
| Nom | Description | Valeur |
|---|---|---|
| consumerGroup | Nom du groupe de consommateurs Event Hub | corde |
| 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 |
| ruisseau | Flux à collecter à partir d’EventHub | corde |
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 » |
IisLogsDataSource
| Nom | Description | Valeur |
|---|---|---|
| logDirectories | Emplacement du fichier chemins d’accès absolus | 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 | Flux IIS | string[] (obligatoire) |
| transformKql | Requête KQL pour transformer la source de données. | corde |
LogFilesDataSource
| Nom | Description | Valeur |
|---|---|---|
| filePatterns | Modèles de fichiers où se trouvent les fichiers journaux | string[] (obligatoire) |
| format | Format de données des fichiers journaux | « json » « text » (obligatoire) |
| 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 |
| Paramètres | Paramètres spécifiques aux fichiers journaux. | LogFilesDataSourceSettings |
| Flux | Liste des flux auxquels cette source de données sera envoyée. Un flux indique quel schéma sera utilisé pour cette source de données |
string[] (obligatoire) |
| transformKql | Requête KQL pour transformer la source de données. | corde |
LogFilesDataSourceSettings
| Nom | Description | Valeur |
|---|---|---|
| SMS | Paramètres de texte | LogFileSettingsText |
LogFileSettingsText
| Nom | Description | Valeur |
|---|---|---|
| recordStartTimestampFormat | Un des formats d’horodatage pris en charge | « ISO 8601 » « M/D/AAAA HH :MM :SS AM/PM » « MMM d hh :mm :ss » « Mon DD, AAAA HH :MM :SS » « AAAA-MM-DD HH :MM :SS » « dd/MMM/aaaa :HH :mm :ss zzz » « ddMMyy HH :mm :ss » « yyMMdd HH :mm :ss » « aaaa-MM-ddTHH :mm :ssK » (obligatoire) |
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 » |
| transformKql | Requête KQL pour transformer la source de données. | corde |
PlatformTelemetryDataSource
| 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 de télémétrie de plateforme à collecter | string[] (obligatoire) |
PrometheusForwarderDataSource
| Nom | Description | Valeur |
|---|---|---|
| labelIncludeFilter | Liste des filtres d’inclusion d’étiquettes sous la forme de paires « name-value ». Actuellement, une seule étiquette est prise en charge : « microsoft_metrics_include_label ». Les valeurs d’étiquette ne respectent pas la casse. |
PrometheusForwarderDataSourceLabelIncludeFilter |
| 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. | Tableau de chaînes contenant l’un des éléments suivants : « Microsoft-PrometheusMetrics » |
PrometheusForwarderDataSourceLabelIncludeFilter
| Nom | Description | Valeur |
|---|---|---|
| {propriété personnalisée} | corde |
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 » |
| transformKql | Requête KQL pour transformer la source de données. | corde |
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 » |
| transformKql | Requête KQL pour transformer la source de données. | corde |
| xPathQueries | Liste des requêtes du journal des événements Windows au format XPATH. | string[] |
WindowsFirewallLogsDataSource
| 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 |
| profileFilter | Filtre de profil des journaux de pare-feu | Tableau de chaînes contenant l’un des éléments suivants : « Domaine » « Privé » « Public » |
| Flux | Flux des journaux de pare-feu | string[] (obligatoire) |
DataCollectionRuleDestinations
| Nom | Description | Valeur |
|---|---|---|
| azureDataExplorer | Liste des destinations Azure Data Explorer. | AdxDestination [] |
| azureMonitorMetrics | Destination des métriques Azure Monitor. | DestinationsSpecAzureMonitorMetrics |
| eventHubs | Liste des destinations Event Hubs. | EventHubDestination[] |
| eventHubsDirect | Liste des destinations Event Hubs Direct. | EventHubDirectDestination[] |
| logAnalytics | Liste des destinations de journal Analytique. | LogAnalyticsDestination[] |
| microsoftFabric | Liste des destinations Microsoft Fabric. | microsoftFabricDestination[] |
| monitoringAccounts | Liste des destinations de compte de surveillance. | MonitoringAccountDestination[] |
| storageAccounts | Liste des destinations des comptes de stockage. | StorageBlobDestination[] |
| storageBlobsDirect | Liste des destinations Blob Direct du stockage. Pour être utilisé uniquement pour l’envoi de données directement à stocker à partir de l’agent. | StorageBlobDestination[] |
| storageTablesDirect | Liste des destinations directes de table de stockage. | StorageTableDestination[] |
AdxDestination
| Nom | Description | Valeur |
|---|---|---|
| databaseName | Nom de la base de données dans laquelle les données seront ingérées. | corde |
| 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 |
| resourceId | ID de ressource ARM de la ressource Adx. | corde |
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 |
EventHubDestination
| Nom | Description | Valeur |
|---|---|---|
| eventHubResourceId | ID de ressource du hub d’événements. | corde |
| 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 |
EventHubDirectDestination
| Nom | Description | Valeur |
|---|---|---|
| eventHubResourceId | ID de ressource du hub d’événements. | corde |
| 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 |
MicrosoftFabricDestination
| Nom | Description | Valeur |
|---|---|---|
| artifactId | ID d’artefact de la ressource Microsoft Fabric. | corde |
| databaseName | Nom de la base de données dans laquelle les données seront ingérées. | corde |
| ingestionUri | Uri d’ingestion de la ressource Microsoft Fabric. | corde |
| 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 |
| tenantId | ID de locataire de la ressource Microsoft Fabric. | corde |
MonitoringAccountDestination
| Nom | Description | Valeur |
|---|---|---|
| accountResourceId | ID de ressource du compte de surveillance. | corde |
| 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 |
StorageBlobDestination
| Nom | Description | Valeur |
|---|---|---|
| containerName | Nom du conteneur de l’objet blob de stockage. | corde |
| 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 |
| storageAccountResourceId | ID de ressource du compte de stockage. | corde |
StorageTableDestination
| 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 |
| storageAccountResourceId | ID de ressource du compte de stockage. | corde |
| tableName | Nom de la table de stockage. | corde |
DataCollectionRuleReferences
| Nom | Description | Valeur |
|---|---|---|
| enrichData | Toutes les sources de données d’enrichissement référencées dans les flux de données | ReferencesSpecEnrichmentData |
ReferencesSpecEnrichmentData
| Nom | Description | Valeur |
|---|---|---|
| storageBlobs | Tous les objets blob de stockage utilisés comme sources de données d’enrichissement | StorageBlob[] |
StorageBlob
| Nom | Description | Valeur |
|---|---|---|
| blobUrl | URL de l’objet blob de stockage | corde |
| lookupType | Type de recherche à effectuer sur l’objet blob | « Cidr » « String » |
| nom | Nom de la source de données d’enrichissement utilisée comme alias lors du référencement de cette source de données dans les flux de données | corde |
| resourceId | ID de ressource du compte de stockage qui héberge l’objet blob | corde |
DataCollectionRuleStreamDeclarations
| Nom | Description | Valeur |
|---|---|---|
| {propriété personnalisée} | StreamDeclaration |
StreamDeclaration
| Nom | Description | Valeur |
|---|---|---|
| colonnes | Liste des colonnes utilisées par les données de ce flux. | ColumnDefinition[] |
ColumnDefinition
| Nom | Description | Valeur |
|---|---|---|
| nom | Nom de la colonne. | corde |
| type | Type des données de colonne. | « booléen » « datetime » « dynamique » « int » « long » « réel » « string » |