Data Collection Rules - Create

Référence

Service:: Monitor

Version d'API:: 2023-03-11

Crée ou met à jour une règle de collecte de données.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dataCollectionRuleName}?api-version=2023-03-11

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
dataCollectionRuleName	path	True	string	Nom de la règle de collecte de données. Le nom ne respecte pas la casse.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nom du groupe de ressources. Le nom ne respecte pas la casse.
subscriptionId	path	True	string minLength: 1	ID de l’abonnement cible.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

Corps de la demande

Nom	Obligatoire	Type	Description
location	True	string	Emplacement géographique où réside la ressource.
identity		Identity	Identité de service managée de la ressource.
kind		KnownDataCollectionRuleResourceKind	Type de ressource.
properties.agentSettings		AgentSettings	Paramètres de l’agent utilisés pour modifier le comportement de l’agent sur un hôte donné
properties.dataCollectionEndpointId		string	ID de ressource du point de terminaison de collecte de données avec lequel cette règle peut être utilisée.
properties.dataFlows		DataFlow[]	Spécification des flux de données.
properties.dataSources		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é.
properties.description		string	Description de la règle de collecte de données.
properties.destinations		Destinations	Spécification des destinations.
properties.references		References	Définit toutes les références qui peuvent être utilisées dans d’autres sections de la DCR
properties.streamDeclarations		<string, StreamDeclaration>	Déclaration de flux personnalisés utilisés dans cette règle.
tags		object	Balises de ressource.

Réponses

Nom	Type	Description
200 OK	DataCollectionRuleResource	La règle de collecte de données a été mise à jour avec succès
201 Created	DataCollectionRuleResource	La règle de collecte de données a été créée avec succès
Other Status Codes	ErrorResponseCommonV2	Erreur

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

Create or update an agent settings configuration

Create or update data collection rule

Create or update data collection rule with embedded ingestion endpoints

Create or update data collection rule with enrichment

Create or update an agent settings configuration

Exemple de requête

HTTP

PUT https://management.azure.com/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.Insights/dataCollectionRules/myCollectionRule?api-version=2023-03-11

{
  "location": "eastus",
  "kind": "AgentSettings",
  "properties": {
    "description": "An agent settings configuration",
    "agentSettings": {
      "logs": [
        {
          "name": "MaxDiskQuotaInMB",
          "value": "5000"
        },
        {
          "name": "UseTimeReceivedForForwardedEvents",
          "value": "1"
        }
      ]
    }
  }
}

Exemple de réponse

Code d’état:: 200

{
  "id": "/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.Insights/dataCollectionRules/myCollectionRule",
  "name": "myCollectionRule",
  "type": "Microsoft.Insights/dataCollectionRules",
  "location": "eastus",
  "kind": "AgentSettings",
  "properties": {
    "description": "An agent settings configuration",
    "immutableId": "dcr-76ce901eee3a400b9945b1e263a70000",
    "agentSettings": {
      "logs": [
        {
          "name": "MaxDiskQuotaInMB",
          "value": "5000"
        },
        {
          "name": "UseTimeReceivedForForwardedEvents",
          "value": "1"
        }
      ]
    },
    "provisioningState": "Succeeded"
  },
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2024-03-26T05:41:40.7885407Z",
    "lastModifiedBy": "user1",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-03-26T05:41:40.7885407Z"
  },
  "etag": "070057da-0000-0000-0000-5ba70d6c0000"
}

Code d’état:: 201

{
  "id": "/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.Insights/dataCollectionRules/myCollectionRule",
  "name": "myCollectionRule",
  "type": "Microsoft.Insights/dataCollectionRules",
  "location": "eastus",
  "kind": "AgentSettings",
  "properties": {
    "description": "An agent settings configuration",
    "immutableId": "dcr-76ce901eee3a400b9945b1e263a70000",
    "agentSettings": {
      "logs": [
        {
          "name": "MaxDiskQuotaInMB",
          "value": "5000"
        },
        {
          "name": "UseTimeReceivedForForwardedEvents",
          "value": "1"
        }
      ]
    },
    "provisioningState": "Succeeded"
  },
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2024-03-26T05:41:40.7885407Z",
    "lastModifiedBy": "user1",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-03-26T05:41:40.7885407Z"
  },
  "etag": "070057da-0000-0000-0000-5ba70d6c0000"
}

Create or update data collection rule

Exemple de requête

HTTP

PUT https://management.azure.com/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.Insights/dataCollectionRules/myCollectionRule?api-version=2023-03-11

{
  "location": "eastus",
  "properties": {
    "dataSources": {
      "performanceCounters": [
        {
          "name": "cloudTeamCoreCounters",
          "streams": [
            "Microsoft-Perf"
          ],
          "samplingFrequencyInSeconds": 15,
          "counterSpecifiers": [
            "\\Processor(_Total)\\% Processor Time",
            "\\Memory\\Committed Bytes",
            "\\LogicalDisk(_Total)\\Free Megabytes",
            "\\PhysicalDisk(_Total)\\Avg. Disk Queue Length"
          ]
        },
        {
          "name": "appTeamExtraCounters",
          "streams": [
            "Microsoft-Perf"
          ],
          "samplingFrequencyInSeconds": 30,
          "counterSpecifiers": [
            "\\Process(_Total)\\Thread Count"
          ]
        }
      ],
      "windowsEventLogs": [
        {
          "name": "cloudSecurityTeamEvents",
          "streams": [
            "Microsoft-WindowsEvent"
          ],
          "xPathQueries": [
            "Security!"
          ]
        },
        {
          "name": "appTeam1AppEvents",
          "streams": [
            "Microsoft-WindowsEvent"
          ],
          "xPathQueries": [
            "System![System[(Level = 1 or Level = 2 or Level = 3)]]",
            "Application!*[System[(Level = 1 or Level = 2 or Level = 3)]]"
          ]
        }
      ],
      "syslog": [
        {
          "name": "cronSyslog",
          "streams": [
            "Microsoft-Syslog"
          ],
          "facilityNames": [
            "cron"
          ],
          "logLevels": [
            "Debug",
            "Critical",
            "Emergency"
          ]
        },
        {
          "name": "syslogBase",
          "streams": [
            "Microsoft-Syslog"
          ],
          "facilityNames": [
            "syslog"
          ],
          "logLevels": [
            "Alert",
            "Critical",
            "Emergency"
          ]
        }
      ]
    },
    "destinations": {
      "logAnalytics": [
        {
          "workspaceResourceId": "/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.OperationalInsights/workspaces/centralTeamWorkspace",
          "name": "centralWorkspace"
        }
      ]
    },
    "dataFlows": [
      {
        "streams": [
          "Microsoft-Perf",
          "Microsoft-Syslog",
          "Microsoft-WindowsEvent"
        ],
        "destinations": [
          "centralWorkspace"
        ]
      }
    ]
  }
}

Exemple de réponse

Code d’état:: 200

{
  "id": "/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.Insights/dataCollectionRules/myCollectionRule",
  "name": "myCollectionRule",
  "type": "Microsoft.Insights/dataCollectionRules",
  "location": "eastus",
  "tags": {
    "tag1": "A",
    "tag2": "B"
  },
  "properties": {
    "immutableId": "dcr-b74e0d383fc9415abaa584ec41adece3",
    "dataSources": {
      "performanceCounters": [
        {
          "name": "cloudTeamCoreCounters",
          "streams": [
            "Microsoft-Perf"
          ],
          "samplingFrequencyInSeconds": 15,
          "counterSpecifiers": [
            "\\Processor(_Total)\\% Processor Time",
            "\\Memory\\Committed Bytes",
            "\\LogicalDisk(_Total)\\Free Megabytes",
            "\\PhysicalDisk(_Total)\\Avg. Disk Queue Length"
          ]
        },
        {
          "name": "appTeamExtraCounters",
          "streams": [
            "Microsoft-Perf"
          ],
          "samplingFrequencyInSeconds": 30,
          "counterSpecifiers": [
            "\\Process(_Total)\\Thread Count"
          ]
        }
      ],
      "windowsEventLogs": [
        {
          "name": "cloudSecurityTeamEvents",
          "streams": [
            "Microsoft-WindowsEvent"
          ],
          "xPathQueries": [
            "Security!"
          ]
        },
        {
          "name": "appTeam1AppEvents",
          "streams": [
            "Microsoft-WindowsEvent"
          ],
          "xPathQueries": [
            "System![System[(Level = 1 or Level = 2 or Level = 3)]]",
            "Application!*[System[(Level = 1 or Level = 2 or Level = 3)]]"
          ]
        }
      ],
      "syslog": [
        {
          "name": "cronSyslog",
          "streams": [
            "Microsoft-Syslog"
          ],
          "facilityNames": [
            "cron"
          ],
          "logLevels": [
            "Debug",
            "Critical",
            "Emergency"
          ]
        },
        {
          "name": "syslogBase",
          "streams": [
            "Microsoft-Syslog"
          ],
          "facilityNames": [
            "syslog"
          ],
          "logLevels": [
            "Alert",
            "Critical",
            "Emergency"
          ]
        }
      ]
    },
    "destinations": {
      "logAnalytics": [
        {
          "workspaceResourceId": "/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.OperationalInsights/workspaces/centralTeamWorkspace",
          "workspaceId": "9ba8bc53-bd36-4156-8667-e983e7ae0e4f",
          "name": "centralWorkspace"
        }
      ]
    },
    "dataFlows": [
      {
        "streams": [
          "Microsoft-Perf",
          "Microsoft-Syslog",
          "Microsoft-WindowsEvent"
        ],
        "destinations": [
          "centralWorkspace"
        ]
      }
    ]
  },
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2021-04-01T12:34:56.1234567Z",
    "lastModifiedBy": "user2",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2021-04-02T12:34:56.1234567Z"
  },
  "etag": "070057da-0000-0000-0000-5ba70d6c0000"
}

Code d’état:: 201

{
  "id": "/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.Insights/dataCollectionRules/myCollectionRule",
  "name": "myCollectionRule",
  "type": "Microsoft.Insights/dataCollectionRules",
  "location": "eastus",
  "tags": {
    "tag1": "A",
    "tag2": "B"
  },
  "properties": {
    "immutableId": "dcr-b74e0d383fc9415abaa584ec41adece3",
    "dataSources": {
      "performanceCounters": [
        {
          "name": "cloudTeamCoreCounters",
          "streams": [
            "Microsoft-Perf"
          ],
          "samplingFrequencyInSeconds": 15,
          "counterSpecifiers": [
            "\\Processor(_Total)\\% Processor Time",
            "\\Memory\\Committed Bytes",
            "\\LogicalDisk(_Total)\\Free Megabytes",
            "\\PhysicalDisk(_Total)\\Avg. Disk Queue Length"
          ]
        },
        {
          "name": "appTeamExtraCounters",
          "streams": [
            "Microsoft-Perf"
          ],
          "samplingFrequencyInSeconds": 30,
          "counterSpecifiers": [
            "\\Process(_Total)\\Thread Count"
          ]
        }
      ],
      "windowsEventLogs": [
        {
          "name": "cloudSecurityTeamEvents",
          "streams": [
            "Microsoft-WindowsEvent"
          ],
          "xPathQueries": [
            "Security!"
          ]
        },
        {
          "name": "appTeam1AppEvents",
          "streams": [
            "Microsoft-WindowsEvent"
          ],
          "xPathQueries": [
            "System![System[(Level = 1 or Level = 2 or Level = 3)]]",
            "Application!*[System[(Level = 1 or Level = 2 or Level = 3)]]"
          ]
        }
      ],
      "syslog": [
        {
          "name": "cronSyslog",
          "streams": [
            "Microsoft-Syslog"
          ],
          "facilityNames": [
            "cron"
          ],
          "logLevels": [
            "Debug",
            "Critical",
            "Emergency"
          ]
        },
        {
          "name": "syslogBase",
          "streams": [
            "Microsoft-Syslog"
          ],
          "facilityNames": [
            "syslog"
          ],
          "logLevels": [
            "Alert",
            "Critical",
            "Emergency"
          ]
        }
      ]
    },
    "destinations": {
      "logAnalytics": [
        {
          "workspaceResourceId": "/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.OperationalInsights/workspaces/centralTeamWorkspace",
          "workspaceId": "9ba8bc53-bd36-4156-8667-e983e7ae0e4f",
          "name": "centralWorkspace"
        }
      ]
    },
    "dataFlows": [
      {
        "streams": [
          "Microsoft-Perf",
          "Microsoft-Syslog",
          "Microsoft-WindowsEvent"
        ],
        "destinations": [
          "centralWorkspace"
        ]
      }
    ]
  },
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2021-04-01T12:34:56.1234567Z",
    "lastModifiedBy": "user2",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2021-04-02T12:34:56.1234567Z"
  },
  "etag": "070057da-0000-0000-0000-5ba70d6c0000"
}

Create or update data collection rule with embedded ingestion endpoints

Exemple de requête

HTTP

PUT https://management.azure.com/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.Insights/dataCollectionRules/myCollectionRule?api-version=2023-03-11

{
  "location": "eastus",
  "kind": " Direct",
  "properties": {
    "description": "A Direct Ingestion Rule with builtin ingestion fqdns",
    "streamDeclarations": {
      "Custom-LOGS1_CL": {
        "columns": [
          {
            "name": "Time",
            "type": "datetime"
          },
          {
            "name": "Computer",
            "type": "string"
          },
          {
            "name": "AdditionalContext",
            "type": "string"
          },
          {
            "name": "CounterName",
            "type": "string"
          },
          {
            "name": "CounterValue",
            "type": "real"
          }
        ]
      }
    },
    "destinations": {
      "logAnalytics": [
        {
          "workspaceResourceId": "/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.OperationalInsights/workspaces/centralTeamWorkspace",
          "name": "centralWorkspace"
        }
      ]
    },
    "dataFlows": [
      {
        "streams": [
          "Custom-LOGS1_CL"
        ],
        "destinations": [
          "myworkspace"
        ],
        "transformKql": "source | extend jsonContext = parse_json(AdditionalContext) | project TimeGenerated = Time, Computer, AdditionalContext = jsonContext, CounterName=tostring(jsonContext.CounterName), CounterValue=toreal(jsonContext.CounterValue)",
        "outputStream": "Custom-LOGS1_CL"
      }
    ]
  }
}

Exemple de réponse

Code d’état:: 200

{
  "id": "/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.Insights/dataCollectionRules/myCollectionRule",
  "name": "myCollectionRule",
  "type": "Microsoft.Insights/dataCollectionRules",
  "location": "eastus",
  "kind": "Direct",
  "properties": {
    "description": "A Direct Ingestion Rule with builtin ingestion fqdns",
    "immutableId": "dcr-d2a09c11a66243009af059a655750000",
    "endpoints": {
      "logsIngestion": "https://mycollectionrule-8ykm-eastus2euap.logs.z1.canary.ingest.monitor.azure.com",
      "metricsIngestion": "https://mycollectionrule-jcvc-eastus2euap.metrics.z1.canary.ingest.monitor.azure.com"
    },
    "streamDeclarations": {
      "Custom-LOGS1_CL": {
        "columns": [
          {
            "name": "Time",
            "type": "datetime"
          },
          {
            "name": "Computer",
            "type": "string"
          },
          {
            "name": "AdditionalContext",
            "type": "string"
          },
          {
            "name": "CounterName",
            "type": "string"
          },
          {
            "name": "CounterValue",
            "type": "real"
          }
        ]
      }
    },
    "destinations": {
      "logAnalytics": [
        {
          "workspaceResourceId": "/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.OperationalInsights/workspaces/centralTeamWorkspace",
          "name": "centralWorkspace"
        }
      ]
    },
    "dataFlows": [
      {
        "streams": [
          "Custom-LOGS1_CL"
        ],
        "destinations": [
          "myworkspace"
        ],
        "transformKql": "source | extend jsonContext = parse_json(AdditionalContext) | project TimeGenerated = Time, Computer, AdditionalContext = jsonContext, CounterName=tostring(jsonContext.CounterName), CounterValue=toreal(jsonContext.CounterValue)",
        "outputStream": "Custom-LOGS1_CL"
      }
    ],
    "provisioningState": "Succeeded"
  },
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2024-01-30T17:50:40.5383301Z",
    "lastModifiedBy": "user1",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-01-30T17:50:40.5383301Z"
  },
  "etag": "070057da-0000-0000-0000-5ba70d6c0000"
}

Code d’état:: 201

{
  "id": "/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.Insights/dataCollectionRules/myCollectionRule",
  "name": "myCollectionRule",
  "type": "Microsoft.Insights/dataCollectionRules",
  "location": "eastus",
  "kind": "Direct",
  "properties": {
    "description": "A Direct Ingestion Rule with builtin ingestion fqdns",
    "immutableId": "dcr-d2a09c11a66243009af059a655750000",
    "endpoints": {
      "logsIngestion": "https://mycollectionrule-8ykm-eastus2euap.logs.z1.canary.ingest.monitor.azure.com",
      "metricsIngestion": "https://mycollectionrule-jcvc-eastus2euap.metrics.z1.canary.ingest.monitor.azure.com"
    },
    "streamDeclarations": {
      "Custom-LOGS1_CL": {
        "columns": [
          {
            "name": "Time",
            "type": "datetime"
          },
          {
            "name": "Computer",
            "type": "string"
          },
          {
            "name": "AdditionalContext",
            "type": "string"
          },
          {
            "name": "CounterName",
            "type": "string"
          },
          {
            "name": "CounterValue",
            "type": "real"
          }
        ]
      }
    },
    "destinations": {
      "logAnalytics": [
        {
          "workspaceResourceId": "/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.OperationalInsights/workspaces/centralTeamWorkspace",
          "name": "centralWorkspace"
        }
      ]
    },
    "dataFlows": [
      {
        "streams": [
          "Custom-LOGS1_CL"
        ],
        "destinations": [
          "myworkspace"
        ],
        "transformKql": "source | extend jsonContext = parse_json(AdditionalContext) | project TimeGenerated = Time, Computer, AdditionalContext = jsonContext, CounterName=tostring(jsonContext.CounterName), CounterValue=toreal(jsonContext.CounterValue)",
        "outputStream": "Custom-LOGS1_CL"
      }
    ],
    "provisioningState": "Succeeded"
  },
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2024-01-30T17:50:40.5383301Z",
    "lastModifiedBy": "user1",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-01-30T17:50:40.5383301Z"
  },
  "etag": "070057da-0000-0000-0000-5ba70d6c0000"
}

Create or update data collection rule with enrichment

Exemple de requête

HTTP

PUT https://management.azure.com/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.Insights/dataCollectionRules/myCollectionRule?api-version=2023-03-11

{
  "location": "eastus",
  "properties": {
    "description": "A rule showcasing ingestion time enrichment",
    "dataCollectionEndpointId": "/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.Insights/dataCollectionEndpoints/myDataCollectionEndpoint",
    "references": {
      "enrichmentData": {
        "storageBlobs": [
          {
            "resourceId": "/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourcegroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myenrichmentstorage",
            "blobUrl": "https://myenrichmentstorage.blob.core.windows.net/enrichment",
            "lookupType": "String",
            "name": "mytextdatastore"
          }
        ]
      }
    },
    "streamDeclarations": {
      "Custom-TabularDataABC": {
        "columns": [
          {
            "name": "TimeGenerated",
            "type": "datetime"
          },
          {
            "name": "Message",
            "type": "string"
          },
          {
            "name": "AdditionalContext",
            "type": "string"
          }
        ]
      }
    },
    "dataSources": {
      "logFiles": [
        {
          "streams": [
            "Custom-TabularDataABC"
          ],
          "filePatterns": [
            "C:\\JavaLogs\\*\\*.log"
          ],
          "format": "text",
          "settings": {
            "text": {
              "recordStartTimestampFormat": "ISO 8601"
            }
          },
          "name": "myTabularLogDataSource"
        }
      ]
    },
    "destinations": {
      "logAnalytics": [
        {
          "workspaceResourceId": "/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.OperationalInsights/workspaces/centralTeamWorkspace",
          "name": "centralWorkspace"
        }
      ]
    },
    "dataFlows": [
      {
        "streams": [
          "Custom-TabularDataABC"
        ],
        "destinations": [
          "centralWorkspace"
        ],
        "transformKql": "source | extend LookupData = lookup_string_am('mytextdatastore', Message) | project TimeGenerated, Message, AdditionalContext = LookupData.Message",
        "outputStream": "Custom-LOGS1_CL"
      }
    ]
  }
}

Exemple de réponse

Code d’état:: 200

{
  "id": "/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.Insights/dataCollectionRules/myCollectionRule",
  "name": "myCollectionRule",
  "type": "Microsoft.Insights/dataCollectionRules",
  "location": "eastus",
  "properties": {
    "description": "A rule showcasing ingestion time enrichment",
    "immutableId": "dcr-ad96300ff0734d08a6a7195eb2be0000",
    "dataCollectionEndpointId": "/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.Insights/dataCollectionEndpoints/myDataCollectionEndpoint",
    "references": {
      "enrichmentData": {
        "storageBlobs": [
          {
            "resourceId": "/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourcegroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myenrichmentstorage",
            "blobUrl": "https://myenrichmentstorage.blob.core.windows.net/enrichment",
            "lookupType": "String",
            "name": "mytextdatastore"
          }
        ]
      }
    },
    "streamDeclarations": {
      "Custom-TabularDataABC": {
        "columns": [
          {
            "name": "TimeGenerated",
            "type": "datetime"
          },
          {
            "name": "Message",
            "type": "string"
          },
          {
            "name": "AdditionalContext",
            "type": "string"
          }
        ]
      }
    },
    "dataSources": {
      "logFiles": [
        {
          "streams": [
            "Custom-TabularDataABC"
          ],
          "filePatterns": [
            "C:\\JavaLogs\\*\\*.log"
          ],
          "format": "text",
          "settings": {
            "text": {
              "recordStartTimestampFormat": "ISO 8601"
            }
          },
          "name": "myTabularLogDataSource"
        }
      ]
    },
    "destinations": {
      "logAnalytics": [
        {
          "workspaceResourceId": "/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.OperationalInsights/workspaces/centralTeamWorkspace",
          "workspaceId": "9ba8bc53-bd36-4156-8667-e983e7ae0e4f",
          "name": "centralWorkspace"
        }
      ]
    },
    "dataFlows": [
      {
        "streams": [
          "Custom-TabularDataABC"
        ],
        "destinations": [
          "centralWorkspace"
        ],
        "transformKql": "source | extend LookupData = lookup_string_am('mytextdatastore', Message) | project TimeGenerated, Message, AdditionalContext = LookupData.Message",
        "outputStream": "Custom-LOGS1_CL"
      }
    ],
    "provisioningState": "Succeeded"
  },
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2024-01-30T17:50:40.5383301Z",
    "lastModifiedBy": "user1",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-01-30T17:50:40.5383301Z"
  },
  "etag": "070057da-0000-0000-0000-5ba70d6c0000"
}

Code d’état:: 201

{
  "id": "/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.Insights/dataCollectionRules/myCollectionRule",
  "name": "myCollectionRule",
  "type": "Microsoft.Insights/dataCollectionRules",
  "location": "eastus",
  "properties": {
    "description": "A rule showcasing ingestion time enrichment",
    "immutableId": "dcr-ad96300ff0734d08a6a7195eb2be0000",
    "dataCollectionEndpointId": "/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.Insights/dataCollectionEndpoints/myDataCollectionEndpoint",
    "references": {
      "enrichmentData": {
        "storageBlobs": [
          {
            "resourceId": "/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourcegroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myenrichmentstorage",
            "blobUrl": "https://myenrichmentstorage.blob.core.windows.net/enrichment",
            "lookupType": "String",
            "name": "mytextdatastore"
          }
        ]
      }
    },
    "streamDeclarations": {
      "Custom-TabularDataABC": {
        "columns": [
          {
            "name": "TimeGenerated",
            "type": "datetime"
          },
          {
            "name": "Message",
            "type": "string"
          },
          {
            "name": "AdditionalContext",
            "type": "string"
          }
        ]
      }
    },
    "dataSources": {
      "logFiles": [
        {
          "streams": [
            "Custom-TabularDataABC"
          ],
          "filePatterns": [
            "C:\\JavaLogs\\*\\*.log"
          ],
          "format": "text",
          "settings": {
            "text": {
              "recordStartTimestampFormat": "ISO 8601"
            }
          },
          "name": "myTabularLogDataSource"
        }
      ]
    },
    "destinations": {
      "logAnalytics": [
        {
          "workspaceResourceId": "/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.OperationalInsights/workspaces/centralTeamWorkspace",
          "workspaceId": "9ba8bc53-bd36-4156-8667-e983e7ae0e4f",
          "name": "centralWorkspace"
        }
      ]
    },
    "dataFlows": [
      {
        "streams": [
          "Custom-TabularDataABC"
        ],
        "destinations": [
          "centralWorkspace"
        ],
        "transformKql": "source | extend LookupData = lookup_string_am('mytextdatastore', Message) | project TimeGenerated, Message, AdditionalContext = LookupData.Message",
        "outputStream": "Custom-LOGS1_CL"
      }
    ],
    "provisioningState": "Succeeded"
  },
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2024-01-30T17:50:40.5383301Z",
    "lastModifiedBy": "user1",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-01-30T17:50:40.5383301Z"
  },
  "etag": "070057da-0000-0000-0000-5ba70d6c0000"
}

Définitions

Nom	Description
AdxDestination	Destination Azure Data Explorer (Adx).
AgentSetting	Paramètre utilisé pour contrôler le comportement d’un agent sur une machine hôte
AgentSettings	Paramètres de l’agent utilisés pour modifier le comportement de l’agent sur un hôte donné
AzureMonitorMetrics	Destination des métriques Azure Monitor.
ColumnDefinition	Définition de colonne de données personnalisée.
createdByType	Type d’identité qui a créé la ressource.
DataCollectionRuleResource	Définition de la ressource de niveau supérieur suivi par ARM.
DataFlow	Définition des flux envoyés aux destinations.
DataImports	Spécifications des sources de données basées sur extraction
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é.
Destinations	Spécification des destinations.
Endpoints	Définit les points de terminaison d’ingestion pour envoyer des données via cette règle.
EnrichmentData	Toutes les sources de données d’enrichissement référencées dans les flux de données
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponseCommonV2	Réponse d’erreur
EventHub	Définition de la configuration Event Hub.
EventHubDestination
EventHubDirectDestination
ExtensionDataSource	Définition de laquelle les données seront collectées à partir d’une extension de machine virtuelle distincte qui s’intègre à l’agent Azure Monitor. Collectés à partir de machines Windows et Linux, selon l’extension définie.
Identity	Identité de service managée de la ressource.
IisLogsDataSource	Permet aux journaux IIS d’être collectés par cette règle de collecte de données.
KnownAgentSettingName	Nom du paramètre. Doit faire partie de la liste des paramètres pris en charge
KnownColumnDefinitionType	Type des données de colonne.
KnownDataCollectionRuleProvisioningState	État d’approvisionnement des ressources.
KnownDataCollectionRuleResourceKind	Type de ressource.
KnownDataFlowStreams	Liste des flux pour ce flux de données.
KnownExtensionDataSourceStreams	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.
KnownLogFilesDataSourceFormat	Format de données des fichiers journaux
KnownLogFileTextSettingsRecordStartTimestampFormat	Un des formats d’horodatage pris en charge
KnownPerfCounterDataSourceStreams	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.
KnownPrometheusForwarderDataSourceStreams	Liste des flux auxquels cette source de données sera envoyée.
KnownStorageBlobLookupType	Type de recherche à effectuer sur l’objet blob
KnownSyslogDataSourceFacilityNames	Liste des noms des installations.
KnownSyslogDataSourceLogLevels	Niveaux de journal à collecter.
KnownSyslogDataSourceStreams	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.
KnownWindowsEventLogDataSourceStreams	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.
KnownWindowsFirewallLogsDataSourceProfileFilter	Filtre de profil des journaux de pare-feu
LogAnalyticsDestination	Destination Log Analytics.
LogFilesDataSource	Définition de laquelle les fichiers journaux personnalisés seront collectés par cette règle de collecte de données
ManagedServiceIdentityType	Type d’identité de service managé (où les types SystemAssigned et UserAssigned sont autorisés).
Metadata	Métadonnées relatives à la ressource
MicrosoftFabricDestination	Destination Microsoft Fabric (non-Azure).
MonitoringAccountDestination	Surveillance de la destination du compte.
PerfCounterDataSource	Définition des compteurs de performances qui seront collectés et comment ils seront collectés par cette règle de collecte de données. Collectés à partir de machines Windows et Linux où le compteur est présent.
PlatformTelemetryDataSource	Définition de la configuration de la source de données de télémétrie de plateforme
PrometheusForwarderDataSource	Définition de la configuration de transfert des métriques Prometheus.
References	Définit toutes les références qui peuvent être utilisées dans d’autres sections de la DCR
Settings	Paramètres spécifiques aux fichiers journaux.
StorageBlob
StorageBlobDestination
StorageTableDestination
StreamDeclaration	Déclaration d’un flux personnalisé.
SyslogDataSource	Définition de laquelle les données syslog seront collectées et comment elles seront collectées. Collecté uniquement à partir de machines Linux.
SystemData	Métadonnées relatives à la création et à la dernière modification de la ressource.
Text	Paramètres de texte
UserAssignedIdentity	Propriétés d’identité attribuées par l’utilisateur
WindowsEventLogDataSource	Définition des événements windows qui seront collectés et de la façon dont ils seront collectés. Collecté uniquement à partir de machines Windows.
WindowsFirewallLogsDataSource	Permet aux journaux de pare-feu d’être collectés par cette règle de collecte de données.

AdxDestination

Object

Destination Azure Data Explorer (Adx).

Nom	Type	Description
databaseName	string	Nom de la base de données dans laquelle les données seront ingérées.
ingestionUri	string	Uri d’ingestion de la ressource Adx.
name	string	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.
resourceId	string	ID de ressource ARM de la ressource Adx.

AgentSetting

Object

Paramètre utilisé pour contrôler le comportement d’un agent sur une machine hôte

Nom	Type	Description
name	KnownAgentSettingName	Nom du paramètre. Doit faire partie de la liste des paramètres pris en charge
value	string	Valeur du paramètre

AgentSettings

Object

Paramètres de l’agent utilisés pour modifier le comportement de l’agent sur un hôte donné

Nom	Type	Description
logs	AgentSetting[]	Tous les paramètres applicables à l’agent de journaux (AMA)

AzureMonitorMetrics

Object

Destination des métriques Azure Monitor.

Nom	Type	Description
name	string	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.

ColumnDefinition

Object

Définition de colonne de données personnalisée.

Nom	Type	Description
name	string	Nom de la colonne.
type	KnownColumnDefinitionType	Type des données de colonne.

createdByType

Énumération

Type d’identité qui a créé la ressource.

Valeur	Description
Application
Key
ManagedIdentity
User

DataCollectionRuleResource

Object

Définition de la ressource de niveau supérieur suivi par ARM.

Nom	Type	Description
etag	string	Balise d’entité de ressource (ETag).
id	string	ID complet de la ressource.
identity	Identity	Identité de service managée de la ressource.
kind	KnownDataCollectionRuleResourceKind	Type de ressource.
location	string	Emplacement géographique où réside la ressource.
name	string	Nom de la ressource.
properties.agentSettings	AgentSettings	Paramètres de l’agent utilisés pour modifier le comportement de l’agent sur un hôte donné
properties.dataCollectionEndpointId	string	ID de ressource du point de terminaison de collecte de données avec lequel cette règle peut être utilisée.
properties.dataFlows	DataFlow[]	Spécification des flux de données.
properties.dataSources	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é.
properties.description	string	Description de la règle de collecte de données.
properties.destinations	Destinations	Spécification des destinations.
properties.endpoints	Endpoints	Définit les points de terminaison d’ingestion pour envoyer des données via cette règle.
properties.immutableId	string	ID immuable de cette règle de collecte de données. Cette propriété est EN LECTURE SEULE.
properties.metadata	Metadata	Métadonnées relatives à la ressource
properties.provisioningState	KnownDataCollectionRuleProvisioningState	État d’approvisionnement des ressources.
properties.references	References	Définit toutes les références qui peuvent être utilisées dans d’autres sections de la DCR
properties.streamDeclarations	<string, StreamDeclaration>	Déclaration de flux personnalisés utilisés dans cette règle.
systemData	SystemData	Métadonnées relatives à la création et à la dernière modification de la ressource.
tags	object	Balises de ressource.
type	string	Type de la ressource.

DataFlow

Object

Définition des flux envoyés aux destinations.

Nom	Type	Description
builtInTransform	string	Transformation builtIn pour transformer des données de flux
captureOverflow	boolean	Indicateur pour activer la colonne de dépassement de capacité dans les destinations LA
destinations	string[]	Liste des destinations pour ce flux de données.
outputStream	string	Flux de sortie de la transformation. Obligatoire uniquement si la transformation modifie les données en un autre flux.
streams	KnownDataFlowStreams[]	Liste des flux pour ce flux de données.
transformKql	string	Requête KQL pour transformer des données de flux.

DataImports

Object

Spécifications des sources de données basées sur extraction

Nom	Type	Description
eventHub	EventHub	Définition de la configuration Event Hub.

DataSources

Object

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é.

Nom	Type	Description
dataImports	DataImports	Spécifications des sources de données basées sur extraction
extensions	ExtensionDataSource[]	Liste des configurations de source de données d’extension de machine virtuelle Azure.
iisLogs	IisLogsDataSource[]	Liste des configurations sources des journaux IIS.
logFiles	LogFilesDataSource[]	Liste des configurations sources des fichiers journaux.
performanceCounters	PerfCounterDataSource[]	Liste des configurations de source de données du compteur de performances.
platformTelemetry	PlatformTelemetryDataSource[]	Liste des configurations de télémétrie de plateforme
prometheusForwarder	PrometheusForwarderDataSource[]	Liste des configurations de source de données du redirecteur Prometheus.
syslog	SyslogDataSource[]	Liste des configurations de source de données Syslog.
windowsEventLogs	WindowsEventLogDataSource[]	Liste des configurations de source de données du journal des événements Windows.
windowsFirewallLogs	WindowsFirewallLogsDataSource[]	Liste des configurations sources du pare-feu Windows.

Destinations

Object

Spécification des destinations.

Nom	Type	Description
azureDataExplorer	AdxDestination[]	Liste des destinations Azure Data Explorer.
azureMonitorMetrics	AzureMonitorMetrics	Destination des métriques Azure Monitor.
eventHubs	EventHubDestination[]	Liste des destinations Event Hubs.
eventHubsDirect	EventHubDirectDestination[]	Liste des destinations Event Hubs Direct.
logAnalytics	LogAnalyticsDestination[]	Liste des destinations de journal Analytique.
microsoftFabric	MicrosoftFabricDestination[]	Liste des destinations Microsoft Fabric.
monitoringAccounts	MonitoringAccountDestination[]	Liste des destinations de compte de surveillance.
storageAccounts	StorageBlobDestination[]	Liste des destinations des comptes de stockage.
storageBlobsDirect	StorageBlobDestination[]	Liste des destinations Blob Direct du stockage. Pour être utilisé uniquement pour l’envoi de données directement à stocker à partir de l’agent.
storageTablesDirect	StorageTableDestination[]	Liste des destinations directes de table de stockage.

Endpoints

Object

Définit les points de terminaison d’ingestion pour envoyer des données via cette règle.

Nom	Type	Description
logsIngestion	string	Point de terminaison d’ingestion pour les journaux
metricsIngestion	string	Point de terminaison d’ingestion pour les métriques

EnrichmentData

Object

Toutes les sources de données d’enrichissement référencées dans les flux de données

Nom	Type	Description
storageBlobs	StorageBlob[]	Tous les objets blob de stockage utilisés comme sources de données d’enrichissement

ErrorAdditionalInfo

Object

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires.
type	string	Type d’informations supplémentaire.

ErrorDetail

Object

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d’erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponseCommonV2

Object

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

EventHub

Object

Définition de la configuration Event Hub.

Nom	Type	Description
consumerGroup	string	Nom du groupe de consommateurs Event Hub
name	string	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.
stream	string	Flux à collecter à partir d’EventHub

EventHubDestination

Object

Nom	Type	Description
eventHubResourceId	string	ID de ressource du hub d’événements.
name	string	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.

EventHubDirectDestination

Object

Nom	Type	Description
eventHubResourceId	string	ID de ressource du hub d’événements.
name	string	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.

ExtensionDataSource

Object

Définition de laquelle les données seront collectées à partir d’une extension de machine virtuelle distincte qui s’intègre à l’agent Azure Monitor. Collectés à partir de machines Windows et Linux, selon l’extension définie.

Nom	Type	Description
extensionName	string	Nom de l’extension de machine virtuelle.
extensionSettings	object	Paramètres d’extension. Le format est spécifique pour une extension particulière.
inputDataSources	string[]	La liste des sources de données dont cette extension a besoin des données.
name	string	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.
streams	KnownExtensionDataSourceStreams[]	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.

Identity

Object

Identité de service managée de la ressource.

Nom	Type	Description
principalId	string (uuid)	ID du principal de service de l’identité affectée par le système. Cette propriété est fournie uniquement pour une identité affectée par le système.
tenantId	string (uuid)	ID de locataire de l’identité affectée par le système. Cette propriété est fournie uniquement pour une identité affectée par le système.
type	ManagedServiceIdentityType	Type d’identité de service managé (où les types SystemAssigned et UserAssigned sont autorisés).
userAssignedIdentities	<string, UserAssignedIdentity>	identités User-Assigned 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.

IisLogsDataSource

Object

Permet aux journaux IIS d’être collectés par cette règle de collecte de données.

Nom	Type	Description
logDirectories	string[]	Emplacement du fichier chemins d’accès absolus
name	string	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.
streams	string[]	Flux IIS
transformKql	string	Requête KQL pour transformer la source de données.

KnownAgentSettingName

Énumération

Nom du paramètre. Doit faire partie de la liste des paramètres pris en charge

Valeur	Description
MaxDiskQuotaInMB
UseTimeReceivedForForwardedEvents

KnownColumnDefinitionType

Énumération

Type des données de colonne.

Valeur	Description
boolean
datetime
dynamic
int
long
real
string

KnownDataCollectionRuleProvisioningState

Énumération

État d’approvisionnement des ressources.

Valeur	Description
Canceled
Creating
Deleting
Failed
Succeeded
Updating

KnownDataCollectionRuleResourceKind

Énumération

Type de ressource.

Valeur	Description
Linux
Windows

KnownDataFlowStreams

Énumération

Liste des flux pour ce flux de données.

Valeur	Description
Microsoft-Event
Microsoft-InsightsMetrics
Microsoft-Perf
Microsoft-Syslog
Microsoft-WindowsEvent

KnownExtensionDataSourceStreams

Énumération

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.

Valeur	Description
Microsoft-Event
Microsoft-InsightsMetrics
Microsoft-Perf
Microsoft-Syslog
Microsoft-WindowsEvent

KnownLogFilesDataSourceFormat

Énumération

Format de données des fichiers journaux

Valeur	Description
json
text

KnownLogFileTextSettingsRecordStartTimestampFormat

Énumération

Un des formats d’horodatage pris en charge

Valeur	Description
ISO 8601
M/D/YYYY HH:MM:SS AM/PM
MMM d hh:mm:ss
Mon DD, YYYY HH:MM:SS
YYYY-MM-DD HH:MM:SS
dd/MMM/yyyy:HH:mm:ss zzz
ddMMyy HH:mm:ss
yyMMdd HH:mm:ss
yyyy-MM-ddTHH:mm:ssK

KnownPerfCounterDataSourceStreams

Énumération

Valeur	Description
Microsoft-InsightsMetrics
Microsoft-Perf

KnownPrometheusForwarderDataSourceStreams

Énumération

Liste des flux auxquels cette source de données sera envoyée.

Valeur	Description
Microsoft-PrometheusMetrics

KnownStorageBlobLookupType

Énumération

Type de recherche à effectuer sur l’objet blob

Valeur	Description
Cidr
String

KnownSyslogDataSourceFacilityNames

Énumération

Liste des noms des installations.

Valeur	Description
*
alert
audit
auth
authpriv
clock
cron
daemon
ftp
kern
local0
local1
local2
local3
local4
local5
local6
local7
lpr
mail
mark
news
nopri
ntp
syslog
user
uucp

KnownSyslogDataSourceLogLevels

Énumération

Niveaux de journal à collecter.

Valeur	Description
*
Alert
Critical
Debug
Emergency
Error
Info
Notice
Warning

KnownSyslogDataSourceStreams

Énumération

Valeur	Description
Microsoft-Syslog

KnownWindowsEventLogDataSourceStreams

Énumération

Valeur	Description
Microsoft-Event
Microsoft-WindowsEvent

KnownWindowsFirewallLogsDataSourceProfileFilter

Énumération

Filtre de profil des journaux de pare-feu

Valeur	Description
Domain
Private
Public

LogAnalyticsDestination

Object

Destination Log Analytics.

Nom	Type	Description
name	string	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.
workspaceId	string	ID client de l’espace de travail Log Analytics.
workspaceResourceId	string	ID de ressource de l’espace de travail Log Analytique.

LogFilesDataSource

Object

Définition de laquelle les fichiers journaux personnalisés seront collectés par cette règle de collecte de données

Nom	Type	Description
filePatterns	string[]	Modèles de fichiers où se trouvent les fichiers journaux
format	KnownLogFilesDataSourceFormat	Format de données des fichiers journaux
name	string	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.
settings	Settings	Paramètres spécifiques aux fichiers journaux.
streams	string[]	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
transformKql	string	Requête KQL pour transformer la source de données.

ManagedServiceIdentityType

Énumération

Type d’identité de service managé (où les types SystemAssigned et UserAssigned sont autorisés).

Valeur	Description
None
SystemAssigned
SystemAssigned,UserAssigned
UserAssigned

Metadata

Object

Métadonnées relatives à la ressource

Nom	Type	Description
provisionedBy	string	Offre Azure gérant cette ressource pour le compte du client.
provisionedByImmutableId	string	ID immuable de l’offre Azure gérant cette ressource pour le compte du client.
provisionedByResourceId	string	ID de ressource de l’offre Azure gérant cette ressource au nom du client.

MicrosoftFabricDestination

Object

Destination Microsoft Fabric (non-Azure).

Nom	Type	Description
artifactId	string	ID d’artefact de la ressource Microsoft Fabric.
databaseName	string	Nom de la base de données dans laquelle les données seront ingérées.
ingestionUri	string	Uri d’ingestion de la ressource Microsoft Fabric.
name	string	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.
tenantId	string	ID de locataire de la ressource Microsoft Fabric.

MonitoringAccountDestination

Object

Surveillance de la destination du compte.

Nom	Type	Description
accountId	string	ID immuable du compte.
accountResourceId	string	ID de ressource du compte de surveillance.
name	string	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.

PerfCounterDataSource

Object

Définition des compteurs de performances qui seront collectés et comment ils seront collectés par cette règle de collecte de données. Collectés à partir de machines Windows et Linux où le compteur est présent.

Nom	Type	Description
counterSpecifiers	string[]	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 ».
name	string	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.
samplingFrequencyInSeconds	integer (int32)	Nombre de secondes entre les mesures de compteur consécutives (échantillons).
streams	KnownPerfCounterDataSourceStreams[]	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.
transformKql	string	Requête KQL pour transformer la source de données.

PlatformTelemetryDataSource

Object

Définition de la configuration de la source de données de télémétrie de plateforme

Nom	Type	Description
name	string	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.
streams	string[]	Liste des flux de télémétrie de plateforme à collecter

PrometheusForwarderDataSource

Object

Définition de la configuration de transfert des métriques Prometheus.

Nom	Type	Description
labelIncludeFilter	object	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.
name	string	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.
streams	KnownPrometheusForwarderDataSourceStreams[]	Liste des flux auxquels cette source de données sera envoyée.

References

Object

Définit toutes les références qui peuvent être utilisées dans d’autres sections de la DCR

Nom	Type	Description
enrichmentData	EnrichmentData	Toutes les sources de données d’enrichissement référencées dans les flux de données

Settings

Object

Paramètres spécifiques aux fichiers journaux.

Nom	Type	Description
text	Text	Paramètres de texte

StorageBlob

Object

Nom	Type	Description
blobUrl	string	URL de l’objet blob de stockage
lookupType	KnownStorageBlobLookupType	Type de recherche à effectuer sur l’objet blob
name	string	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
resourceId	string	ID de ressource du compte de stockage qui héberge l’objet blob

StorageBlobDestination

Object

Nom	Type	Description
containerName	string	Nom du conteneur de l’objet blob de stockage.
name	string	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.
storageAccountResourceId	string	ID de ressource du compte de stockage.

StorageTableDestination

Object

Nom	Type	Description
name	string	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.
storageAccountResourceId	string	ID de ressource du compte de stockage.
tableName	string	Nom de la table de stockage.

StreamDeclaration

Object

Déclaration d’un flux personnalisé.

Nom	Type	Description
columns	ColumnDefinition[]	Liste des colonnes utilisées par les données de ce flux.

SyslogDataSource

Object

Définition de laquelle les données syslog seront collectées et comment elles seront collectées. Collecté uniquement à partir de machines Linux.

Nom	Type	Description
facilityNames	KnownSyslogDataSourceFacilityNames[]	Liste des noms des installations.
logLevels	KnownSyslogDataSourceLogLevels[]	Niveaux de journal à collecter.
name	string	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.
streams	KnownSyslogDataSourceStreams[]	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.
transformKql	string	Requête KQL pour transformer la source de données.

SystemData

Object

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom	Type	Description
createdAt	string (date-time)	Horodatage de la création de ressources (UTC).
createdBy	string	Identité qui a créé la ressource.
createdByType	createdByType	Type d’identité qui a créé la ressource.
lastModifiedAt	string (date-time)	Horodatage de la dernière modification de ressource (UTC)
lastModifiedBy	string	Identité qui a modifié la ressource pour la dernière fois.
lastModifiedByType	createdByType	Type d’identité qui a modifié la ressource pour la dernière fois.

Text

Object

Paramètres de texte

Nom	Type	Description
recordStartTimestampFormat	KnownLogFileTextSettingsRecordStartTimestampFormat	Un des formats d’horodatage pris en charge

UserAssignedIdentity

Object

Propriétés d’identité attribuées par l’utilisateur

Nom	Type	Description
clientId	string (uuid)	ID client de l’identité affectée.
principalId	string (uuid)	ID principal de l’identité affectée.

WindowsEventLogDataSource

Object

Définition des événements windows qui seront collectés et de la façon dont ils seront collectés. Collecté uniquement à partir de machines Windows.

Nom	Type	Description
name	string	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.
streams	KnownWindowsEventLogDataSourceStreams[]	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.
transformKql	string	Requête KQL pour transformer la source de données.
xPathQueries	string[]	Liste des requêtes du journal des événements Windows au format XPATH.

WindowsFirewallLogsDataSource

Object

Permet aux journaux de pare-feu d’être collectés par cette règle de collecte de données.

Nom	Type	Description
name	string	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.
profileFilter	KnownWindowsFirewallLogsDataSourceProfileFilter[]	Filtre de profil des journaux de pare-feu
streams	string[]	Flux des journaux de pare-feu

Partager via

Data Collection Rules - Create

Paramètres URI

Corps de la demande

Réponses

Sécurité

azure_auth

Étendues

Exemples

Create or update an agent settings configuration

Exemple de requête

Exemple de réponse

Create or update data collection rule

Exemple de requête

Exemple de réponse

Create or update data collection rule with embedded ingestion endpoints

Exemple de requête

Exemple de réponse

Create or update data collection rule with enrichment

Exemple de requête

Exemple de réponse

Définitions

AdxDestination

AgentSetting

AgentSettings

AzureMonitorMetrics

ColumnDefinition

createdByType

DataCollectionRuleResource

DataFlow

DataImports

DataSources

Destinations

Endpoints

EnrichmentData

ErrorAdditionalInfo

ErrorDetail

ErrorResponseCommonV2

EventHub

EventHubDestination

EventHubDirectDestination

ExtensionDataSource

Identity

IisLogsDataSource

KnownAgentSettingName

KnownColumnDefinitionType

KnownDataCollectionRuleProvisioningState

KnownDataCollectionRuleResourceKind

KnownDataFlowStreams

KnownExtensionDataSourceStreams

KnownLogFilesDataSourceFormat

KnownLogFileTextSettingsRecordStartTimestampFormat

KnownPerfCounterDataSourceStreams

KnownPrometheusForwarderDataSourceStreams

KnownStorageBlobLookupType

KnownSyslogDataSourceFacilityNames

KnownSyslogDataSourceLogLevels

KnownSyslogDataSourceStreams

KnownWindowsEventLogDataSourceStreams

KnownWindowsFirewallLogsDataSourceProfileFilter

LogAnalyticsDestination

LogFilesDataSource

ManagedServiceIdentityType

Metadata

MicrosoftFabricDestination

MonitoringAccountDestination

PerfCounterDataSource

PlatformTelemetryDataSource

PrometheusForwarderDataSource

References

Settings

StorageBlob

StorageBlobDestination

StorageTableDestination

StreamDeclaration

SyslogDataSource

SystemData

Text

UserAssignedIdentity

WindowsEventLogDataSource