Data Collection Rules - Create

Ссылка

Служба:: Monitor

Версия API:: 2023-03-11

Создает или обновляет правило сбора данных.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
dataCollectionRuleName	path	True	string	Имя правила сбора данных. Имя не учитывает регистр.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Имя группы ресурсов. Имя не учитывает регистр.
subscriptionId	path	True	string minLength: 1	Идентификатор целевой подписки.
api-version	query	True	string minLength: 1	Версия API, используемая для этой операции.

Текст запроса

Имя	Обязательно	Тип	Описание
location	True	string	Географическое расположение, в котором находится ресурс.
identity		Identity	Управляемое удостоверение службы ресурса.
kind		KnownDataCollectionRuleResourceKind	Тип ресурса.
properties.agentSettings		AgentSettings	Параметры агента, используемые для изменения поведения агента на определенном узле
properties.dataCollectionEndpointId		string	Идентификатор ресурса конечной точки сбора данных, с которым можно использовать это правило.
properties.dataFlows		DataFlow[]	Спецификация потоков данных.
properties.dataSources		DataSources	Спецификация источников данных. Это свойство является необязательным и может быть опущено, если правило предназначено для использования с помощью прямых вызовов подготовленной конечной точки.
properties.description		string	Описание правила сбора данных.
properties.destinations		Destinations	Спецификация назначений.
properties.references		References	Определяет все ссылки, которые могут использоваться в других разделах DCR
properties.streamDeclarations		<string, StreamDeclaration>	Объявление пользовательских потоков, используемых в этом правиле.
tags		object	Теги ресурсов.

Ответы

Имя	Тип	Описание
200 OK	DataCollectionRuleResource	Правило сбора данных было успешно обновлено
201 Created	DataCollectionRuleResource	Правило сбора данных успешно создано
Other Status Codes	ErrorResponseCommonV2	Ошибка

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

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

Образец запроса

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

Пример ответа

Код состояния:: 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"
}

Код состояния:: 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

Образец запроса

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

Пример ответа

Код состояния:: 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"
}

Код состояния:: 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

Образец запроса

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

Пример ответа

Код состояния:: 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"
}

Код состояния:: 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

Образец запроса

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

Пример ответа

Код состояния:: 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"
}

Код состояния:: 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"
}

Определения

Имя	Описание
AdxDestination	Назначение Azure Data Explorer (Adx).
AgentSetting	Параметр, используемый для управления поведением агента на хост-компьютере
AgentSettings	Параметры агента, используемые для изменения поведения агента на определенном узле
AzureMonitorMetrics	Назначение метрик Azure Monitor.
ColumnDefinition	Определение настраиваемого столбца данных.
createdByType	Тип удостоверения, создавшего ресурс.
DataCollectionRuleResource	Определение отслеживаемого ресурса верхнего уровня ARM.
DataFlow	Определение потоков, в которые отправляются назначения.
DataImports	Спецификации источников данных на основе извлечения
DataSources	Спецификация источников данных. Это свойство является необязательным и может быть опущено, если правило предназначено для использования с помощью прямых вызовов подготовленной конечной точки.
Destinations	Спецификация назначений.
Endpoints	Определяет конечные точки приема для отправки данных через это правило.
EnrichmentData	Все источники данных обогащения, на которые ссылается потоки данных
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponseCommonV2	Ответ на ошибку
EventHub	Определение конфигурации Концентратора событий.
EventHubDestination
EventHubDirectDestination
ExtensionDataSource	Определение данных, которые будут собираться из отдельного расширения виртуальной машины, который интегрируется с агентом Azure Monitor. Собирается с компьютеров Windows и Linux в зависимости от определенного расширения.
Identity	Управляемое удостоверение службы ресурса.
IisLogsDataSource	Позволяет собирать журналы IIS с помощью этого правила сбора данных.
KnownAgentSettingName	Имя параметра. Должен быть частью списка поддерживаемых параметров
KnownColumnDefinitionType	Тип данных столбца.
KnownDataCollectionRuleProvisioningState	Состояние подготовки ресурсов.
KnownDataCollectionRuleResourceKind	Тип ресурса.
KnownDataFlowStreams	Список потоков для этого потока данных.
KnownExtensionDataSourceStreams	Список потоков, в которые будет отправлен этот источник данных. Поток указывает, какая схема будет использоваться для этих данных и обычно какая таблица в Log Analytics будет отправлена.
KnownLogFilesDataSourceFormat	Формат данных файлов журнала
KnownLogFileTextSettingsRecordStartTimestampFormat	Один из поддерживаемых форматов меток времени
KnownPerfCounterDataSourceStreams	Список потоков, в которые будет отправлен этот источник данных. Поток указывает, какая схема будет использоваться для этих данных и обычно какая таблица в Log Analytics будет отправлена.
KnownPrometheusForwarderDataSourceStreams	Список потоков, в которые будет отправлен этот источник данных.
KnownStorageBlobLookupType	Тип подстановки, выполняемой в большом двоичном объекте
KnownSyslogDataSourceFacilityNames	Список имен объектов.
KnownSyslogDataSourceLogLevels	Уровни журнала для сбора.
KnownSyslogDataSourceStreams	Список потоков, в которые будет отправлен этот источник данных. Поток указывает, какая схема будет использоваться для этих данных и обычно какая таблица в Log Analytics будет отправлена.
KnownWindowsEventLogDataSourceStreams	Список потоков, в которые будет отправлен этот источник данных. Поток указывает, какая схема будет использоваться для этих данных и обычно какая таблица в Log Analytics будет отправлена.
KnownWindowsFirewallLogsDataSourceProfileFilter	Фильтр профиля журналов брандмауэра
LogAnalyticsDestination	Назначение Log Analytics.
LogFilesDataSource	Определение того, какие пользовательские файлы журналов будут собираться этим правилом сбора данных
ManagedServiceIdentityType	Тип управляемого удостоверения службы (где разрешены типы SystemAssigned и UserAssigned).
Metadata	Метаданные о ресурсе
MicrosoftFabricDestination	Назначение Microsoft Fabric (не Azure).
MonitoringAccountDestination	Мониторинг назначения учетной записи.
PerfCounterDataSource	Определение счетчиков производительности, которые будут собираться и как они будут собираться этим правилом сбора данных. Собирается с компьютеров Windows и Linux, где присутствует счетчик.
PlatformTelemetryDataSource	Определение конфигурации источника данных телеметрии платформы
PrometheusForwarderDataSource	Определение конфигурации пересылки метрик Prometheus.
References	Определяет все ссылки, которые могут использоваться в других разделах DCR
Settings	Определенные параметры файлов журнала.
StorageBlob
StorageBlobDestination
StorageTableDestination
StreamDeclaration	Объявление пользовательского потока.
SyslogDataSource	Определение того, какие данные системного журнала будут собираться и как они будут собираться. Только из компьютеров Linux.
SystemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.
Text	Параметры текста
UserAssignedIdentity	Свойства назначаемого пользователем удостоверения
WindowsEventLogDataSource	Определение того, какие события журнала событий Windows будут собираться и как они будут собираться. Только собранные с компьютеров Windows.
WindowsFirewallLogsDataSource	Позволяет собирать журналы брандмауэра с помощью этого правила сбора данных.

AdxDestination

Object

Назначение Azure Data Explorer (Adx).

Имя	Тип	Описание
databaseName	string	Имя базы данных, в которую будут приема данных.
ingestionUri	string	URI приема ресурса Adx.
name	string	Понятное имя назначения. Это имя должно быть уникальным для всех назначений (независимо от типа) в правиле сбора данных.
resourceId	string	Идентификатор ресурса ARM ресурса Adx.

AgentSetting

Object

Параметр, используемый для управления поведением агента на хост-компьютере

Имя	Тип	Описание
name	KnownAgentSettingName	Имя параметра. Должен быть частью списка поддерживаемых параметров
value	string	Значение параметра

AgentSettings

Object

Параметры агента, используемые для изменения поведения агента на определенном узле

Имя	Тип	Описание
logs	AgentSetting[]	Все параметры, применимые к агенту журналов (AMA)

AzureMonitorMetrics

Object

Назначение метрик Azure Monitor.

Имя	Тип	Описание
name	string	Понятное имя назначения. Это имя должно быть уникальным для всех назначений (независимо от типа) в правиле сбора данных.

ColumnDefinition

Object

Определение настраиваемого столбца данных.

Имя	Тип	Описание
name	string	Имя столбца.
type	KnownColumnDefinitionType	Тип данных столбца.

createdByType

Перечисление

Тип удостоверения, создавшего ресурс.

Значение	Описание
Application
Key
ManagedIdentity
User

DataCollectionRuleResource

Object

Определение отслеживаемого ресурса верхнего уровня ARM.

Имя	Тип	Описание
etag	string	Тег сущности ресурса (ETag).
id	string	Полный идентификатор ресурса.
identity	Identity	Управляемое удостоверение службы ресурса.
kind	KnownDataCollectionRuleResourceKind	Тип ресурса.
location	string	Географическое расположение, в котором находится ресурс.
name	string	Имя ресурса.
properties.agentSettings	AgentSettings	Параметры агента, используемые для изменения поведения агента на определенном узле
properties.dataCollectionEndpointId	string	Идентификатор ресурса конечной точки сбора данных, с которым можно использовать это правило.
properties.dataFlows	DataFlow[]	Спецификация потоков данных.
properties.dataSources	DataSources	Спецификация источников данных. Это свойство является необязательным и может быть опущено, если правило предназначено для использования с помощью прямых вызовов подготовленной конечной точки.
properties.description	string	Описание правила сбора данных.
properties.destinations	Destinations	Спецификация назначений.
properties.endpoints	Endpoints	Определяет конечные точки приема для отправки данных через это правило.
properties.immutableId	string	Неизменяемый идентификатор этого правила сбора данных. Это свойство — READ-ONLY.
properties.metadata	Metadata	Метаданные о ресурсе
properties.provisioningState	KnownDataCollectionRuleProvisioningState	Состояние подготовки ресурсов.
properties.references	References	Определяет все ссылки, которые могут использоваться в других разделах DCR
properties.streamDeclarations	<string, StreamDeclaration>	Объявление пользовательских потоков, используемых в этом правиле.
systemData	SystemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.
tags	object	Теги ресурсов.
type	string	Тип ресурса.

DataFlow

Object

Определение потоков, в которые отправляются назначения.

Имя	Тип	Описание
builtInTransform	string	Преобразование builtIn для преобразования потоковой передачи данных
captureOverflow	boolean	Флаг для включения столбца переполнения в местах назначения LA
destinations	string[]	Список назначений для этого потока данных.
outputStream	string	Выходной поток преобразования. Требуется только в том случае, если преобразование изменяет данные в другой поток.
streams	KnownDataFlowStreams[]	Список потоков для этого потока данных.
transformKql	string	Запрос KQL для преобразования потоковой передачи данных.

DataImports

Object

Спецификации источников данных на основе извлечения

Имя	Тип	Описание
eventHub	EventHub	Определение конфигурации Концентратора событий.

DataSources

Object

Спецификация источников данных. Это свойство является необязательным и может быть опущено, если правило предназначено для использования с помощью прямых вызовов подготовленной конечной точки.

Имя	Тип	Описание
dataImports	DataImports	Спецификации источников данных на основе извлечения
extensions	ExtensionDataSource[]	Список конфигураций источников данных расширения виртуальной машины Azure.
iisLogs	IisLogsDataSource[]	Список исходных конфигураций журналов IIS.
logFiles	LogFilesDataSource[]	Список исходных конфигураций файлов журнала.
performanceCounters	PerfCounterDataSource[]	Список конфигураций источников данных счетчика производительности.
platformTelemetry	PlatformTelemetryDataSource[]	Список конфигураций телеметрии платформы
prometheusForwarder	PrometheusForwarderDataSource[]	Список конфигураций источника данных пересылки Prometheus.
syslog	SyslogDataSource[]	Список конфигураций источника данных системного журнала.
windowsEventLogs	WindowsEventLogDataSource[]	Список конфигураций источника данных журнала событий Windows.
windowsFirewallLogs	WindowsFirewallLogsDataSource[]	Список исходных конфигураций брандмауэра Windows.

Destinations

Object

Спецификация назначений.

Имя	Тип	Описание
azureDataExplorer	AdxDestination[]	Список назначений Azure Data Explorer.
azureMonitorMetrics	AzureMonitorMetrics	Назначение метрик Azure Monitor.
eventHubs	EventHubDestination[]	Список назначений Центров событий.
eventHubsDirect	EventHubDirectDestination[]	Список назначений Центров событий Direct.
logAnalytics	LogAnalyticsDestination[]	Список назначений Log Analytics.
microsoftFabric	MicrosoftFabricDestination[]	Список назначений Microsoft Fabric.
monitoringAccounts	MonitoringAccountDestination[]	Список назначений учетной записи мониторинга.
storageAccounts	StorageBlobDestination[]	Список назначений учетных записей хранения.
storageBlobsDirect	StorageBlobDestination[]	Список целевых объектов BLOB-объектов хранилища. Использование только для отправки данных непосредственно в хранилище из агента.
storageTablesDirect	StorageTableDestination[]	Список назначений прямой таблицы хранилища.

Endpoints

Object

Определяет конечные точки приема для отправки данных через это правило.

Имя	Тип	Описание
logsIngestion	string	Конечная точка приема журналов
metricsIngestion	string	Конечная точка приема метрик

EnrichmentData

Object

Все источники данных обогащения, на которые ссылается потоки данных

Имя	Тип	Описание
storageBlobs	StorageBlob[]	Все большие двоичные объекты хранилища, используемые в качестве источников данных обогащения

ErrorAdditionalInfo

Object

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Дополнительный тип сведений.

ErrorDetail

Object

Сведения об ошибке.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponseCommonV2

Object

Ответ на ошибку

Имя	Тип	Описание
error	ErrorDetail	Объект ошибки.

EventHub

Object

Определение конфигурации Концентратора событий.

Имя	Тип	Описание
consumerGroup	string	Имя группы потребителей концентратора событий
name	string	Понятное имя источника данных. Это имя должно быть уникальным для всех источников данных (независимо от типа) в правиле сбора данных.
stream	string	Поток для сбора из EventHub

EventHubDestination

Object

Имя	Тип	Описание
eventHubResourceId	string	Идентификатор ресурса концентратора событий.
name	string	Понятное имя назначения. Это имя должно быть уникальным для всех назначений (независимо от типа) в правиле сбора данных.

EventHubDirectDestination

Object

Имя	Тип	Описание
eventHubResourceId	string	Идентификатор ресурса концентратора событий.
name	string	Понятное имя назначения. Это имя должно быть уникальным для всех назначений (независимо от типа) в правиле сбора данных.

ExtensionDataSource

Object

Определение данных, которые будут собираться из отдельного расширения виртуальной машины, который интегрируется с агентом Azure Monitor. Собирается с компьютеров Windows и Linux в зависимости от определенного расширения.

Имя	Тип	Описание
extensionName	string	Имя расширения виртуальной машины.
extensionSettings	object	Параметры расширения. Формат предназначен для конкретного расширения.
inputDataSources	string[]	В списке источников данных этого расширения требуются данные.
name	string	Понятное имя источника данных. Это имя должно быть уникальным для всех источников данных (независимо от типа) в правиле сбора данных.
streams	KnownExtensionDataSourceStreams[]	Список потоков, в которые будет отправлен этот источник данных. Поток указывает, какая схема будет использоваться для этих данных и обычно какая таблица в Log Analytics будет отправлена.

Identity

Object

Управляемое удостоверение службы ресурса.

Имя	Тип	Описание
principalId	string (uuid)	Идентификатор субъекта-службы назначенного системой удостоверения. Это свойство будет предоставлено только для назначаемого системой удостоверения.
tenantId	string (uuid)	Идентификатор клиента назначенного системой удостоверения. Это свойство будет предоставлено только для назначаемого системой удостоверения.
type	ManagedServiceIdentityType	Тип управляемого удостоверения службы (где разрешены типы SystemAssigned и UserAssigned).
userAssignedIdentities	<string, UserAssignedIdentity>	удостоверения User-Assigned Набор назначенных пользователем удостоверений, связанных с ресурсом. Ключи словаря userAssignedIdentities будут идентификаторами ресурсов ARM в форме: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Значения словаря могут быть пустыми объектами ({}) в запросах.

IisLogsDataSource

Object

Позволяет собирать журналы IIS с помощью этого правила сбора данных.

Имя	Тип	Описание
logDirectories	string[]	Расположение файла абсолютных путей
name	string	Понятное имя источника данных. Это имя должно быть уникальным для всех источников данных (независимо от типа) в правиле сбора данных.
streams	string[]	Потоки IIS
transformKql	string	Запрос KQL для преобразования источника данных.

KnownAgentSettingName

Перечисление

Имя параметра. Должен быть частью списка поддерживаемых параметров

Значение	Описание
MaxDiskQuotaInMB
UseTimeReceivedForForwardedEvents

KnownColumnDefinitionType

Перечисление

Тип данных столбца.

Значение	Описание
boolean
datetime
dynamic
int
long
real
string

KnownDataCollectionRuleProvisioningState

Перечисление

Состояние подготовки ресурсов.

Значение	Описание
Canceled
Creating
Deleting
Failed
Succeeded
Updating

KnownDataCollectionRuleResourceKind

Перечисление

Тип ресурса.

Значение	Описание
Linux
Windows

KnownDataFlowStreams

Перечисление

Список потоков для этого потока данных.

Значение	Описание
Microsoft-Event
Microsoft-InsightsMetrics
Microsoft-Perf
Microsoft-Syslog
Microsoft-WindowsEvent

KnownExtensionDataSourceStreams

Перечисление

Список потоков, в которые будет отправлен этот источник данных. Поток указывает, какая схема будет использоваться для этих данных и обычно какая таблица в Log Analytics будет отправлена.

Значение	Описание
Microsoft-Event
Microsoft-InsightsMetrics
Microsoft-Perf
Microsoft-Syslog
Microsoft-WindowsEvent

KnownLogFilesDataSourceFormat

Перечисление

Формат данных файлов журнала

Значение	Описание
json
text

KnownLogFileTextSettingsRecordStartTimestampFormat

Перечисление

Один из поддерживаемых форматов меток времени

Значение	Описание
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

Перечисление

Значение	Описание
Microsoft-InsightsMetrics
Microsoft-Perf

KnownPrometheusForwarderDataSourceStreams

Перечисление

Список потоков, в которые будет отправлен этот источник данных.

Значение	Описание
Microsoft-PrometheusMetrics

KnownStorageBlobLookupType

Перечисление

Тип подстановки, выполняемой в большом двоичном объекте

Значение	Описание
Cidr
String

KnownSyslogDataSourceFacilityNames

Перечисление

Список имен объектов.

Значение	Описание
*
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

Перечисление

Уровни журнала для сбора.

Значение	Описание
*
Alert
Critical
Debug
Emergency
Error
Info
Notice
Warning

KnownSyslogDataSourceStreams

Перечисление

Значение	Описание
Microsoft-Syslog

KnownWindowsEventLogDataSourceStreams

Перечисление

Значение	Описание
Microsoft-Event
Microsoft-WindowsEvent

KnownWindowsFirewallLogsDataSourceProfileFilter

Перечисление

Фильтр профиля журналов брандмауэра

Значение	Описание
Domain
Private
Public

LogAnalyticsDestination

Object

Назначение Log Analytics.

Имя	Тип	Описание
name	string	Понятное имя назначения. Это имя должно быть уникальным для всех назначений (независимо от типа) в правиле сбора данных.
workspaceId	string	Идентификатор клиента рабочей области Log Analytics.
workspaceResourceId	string	Идентификатор ресурса рабочей области Log Analytics.

LogFilesDataSource

Object

Определение того, какие пользовательские файлы журналов будут собираться этим правилом сбора данных

Имя	Тип	Описание
filePatterns	string[]	Шаблоны файлов, в которых находятся файлы журнала
format	KnownLogFilesDataSourceFormat	Формат данных файлов журнала
name	string	Понятное имя источника данных. Это имя должно быть уникальным для всех источников данных (независимо от типа) в правиле сбора данных.
settings	Settings	Определенные параметры файлов журнала.
streams	string[]	Список потоков, в которые будет отправлен этот источник данных. Поток указывает, какая схема будет использоваться для этого источника данных
transformKql	string	Запрос KQL для преобразования источника данных.

ManagedServiceIdentityType

Перечисление

Тип управляемого удостоверения службы (где разрешены типы SystemAssigned и UserAssigned).

Значение	Описание
None
SystemAssigned
SystemAssigned,UserAssigned
UserAssigned

Metadata

Object

Метаданные о ресурсе

Имя	Тип	Описание
provisionedBy	string	Azure предлагает управлять этим ресурсом от имени клиента.
provisionedByImmutableId	string	Неизменяемый идентификатор предложения Azure, который управляет этим ресурсом от имени клиента.
provisionedByResourceId	string	Идентификатор ресурса Azure, предлагающий управление этим ресурсом от имени клиента.

MicrosoftFabricDestination

Object

Назначение Microsoft Fabric (не Azure).

Имя	Тип	Описание
artifactId	string	Идентификатор артефакта ресурса Microsoft Fabric.
databaseName	string	Имя базы данных, в которую будут приема данных.
ingestionUri	string	URI приема ресурса Microsoft Fabric.
name	string	Понятное имя назначения. Это имя должно быть уникальным для всех назначений (независимо от типа) в правиле сбора данных.
tenantId	string	Идентификатор клиента ресурса Microsoft Fabric.

MonitoringAccountDestination

Object

Мониторинг назначения учетной записи.

Имя	Тип	Описание
accountId	string	Неизменяемый идентификатор учетной записи.
accountResourceId	string	Идентификатор ресурса учетной записи мониторинга.
name	string	Понятное имя назначения. Это имя должно быть уникальным для всех назначений (независимо от типа) в правиле сбора данных.

PerfCounterDataSource

Object

Определение счетчиков производительности, которые будут собираться и как они будут собираться этим правилом сбора данных. Собирается с компьютеров Windows и Linux, где присутствует счетчик.

Имя	Тип	Описание
counterSpecifiers	string[]	Список имен описатель счетчиков производительности, которые требуется собрать. Используйте подстановочный знак (*) для сбора счетчика для всех экземпляров. Чтобы получить список счетчиков производительности в Windows, выполните команду typeperf.
name	string	Понятное имя источника данных. Это имя должно быть уникальным для всех источников данных (независимо от типа) в правиле сбора данных.
samplingFrequencyInSeconds	integer (int32)	Количество секунд между последовательными измерениями счетчиков (примерами).
streams	KnownPerfCounterDataSourceStreams[]	Список потоков, в которые будет отправлен этот источник данных. Поток указывает, какая схема будет использоваться для этих данных и обычно какая таблица в Log Analytics будет отправлена.
transformKql	string	Запрос KQL для преобразования источника данных.

PlatformTelemetryDataSource

Object

Определение конфигурации источника данных телеметрии платформы

Имя	Тип	Описание
name	string	Понятное имя источника данных. Это имя должно быть уникальным для всех источников данных (независимо от типа) в правиле сбора данных.
streams	string[]	Список потоков телеметрии платформы для сбора

PrometheusForwarderDataSource

Object

Определение конфигурации пересылки метрик Prometheus.

Имя	Тип	Описание
labelIncludeFilter	object	Список фильтров включения меток в виде пар "name-value". В настоящее время поддерживается только одна метка: "microsoft_metrics_include_label". Значения меток совпадают без учета регистра.
name	string	Понятное имя источника данных. Это имя должно быть уникальным для всех источников данных (независимо от типа) в правиле сбора данных.
streams	KnownPrometheusForwarderDataSourceStreams[]	Список потоков, в которые будет отправлен этот источник данных.

References

Object

Определяет все ссылки, которые могут использоваться в других разделах DCR

Имя	Тип	Описание
enrichmentData	EnrichmentData	Все источники данных обогащения, на которые ссылается потоки данных

Settings

Object

Определенные параметры файлов журнала.

Имя	Тип	Описание
text	Text	Параметры текста

StorageBlob

Object

Имя	Тип	Описание
blobUrl	string	URL-адрес большого двоичного объекта хранилища
lookupType	KnownStorageBlobLookupType	Тип подстановки, выполняемой в большом двоичном объекте
name	string	Имя источника данных обогащения, используемого в качестве псевдонима при ссылке на этот источник данных в потоках данных
resourceId	string	Идентификатор ресурса учетной записи хранения, на котором размещен большой двоичный объект

StorageBlobDestination

Object

Имя	Тип	Описание
containerName	string	Имя контейнера BLOB-объекта хранилища.
name	string	Понятное имя назначения. Это имя должно быть уникальным для всех назначений (независимо от типа) в правиле сбора данных.
storageAccountResourceId	string	Идентификатор ресурса учетной записи хранения.

StorageTableDestination

Object

Имя	Тип	Описание
name	string	Понятное имя назначения. Это имя должно быть уникальным для всех назначений (независимо от типа) в правиле сбора данных.
storageAccountResourceId	string	Идентификатор ресурса учетной записи хранения.
tableName	string	Имя таблицы хранилища.

StreamDeclaration

Object

Объявление пользовательского потока.

Имя	Тип	Описание
columns	ColumnDefinition[]	Список столбцов, используемых данными в этом потоке.

SyslogDataSource

Object

Определение того, какие данные системного журнала будут собираться и как они будут собираться. Только из компьютеров Linux.

Имя	Тип	Описание
facilityNames	KnownSyslogDataSourceFacilityNames[]	Список имен объектов.
logLevels	KnownSyslogDataSourceLogLevels[]	Уровни журнала для сбора.
name	string	Понятное имя источника данных. Это имя должно быть уникальным для всех источников данных (независимо от типа) в правиле сбора данных.
streams	KnownSyslogDataSourceStreams[]	Список потоков, в которые будет отправлен этот источник данных. Поток указывает, какая схема будет использоваться для этих данных и обычно какая таблица в Log Analytics будет отправлена.
transformKql	string	Запрос KQL для преобразования источника данных.

SystemData

Object

Метаданные, относящиеся к созданию и последнему изменении ресурса.

Имя	Тип	Описание
createdAt	string (date-time)	Метка времени создания ресурса (UTC).
createdBy	string	Удостоверение, создающее ресурс.
createdByType	createdByType	Тип удостоверения, создавшего ресурс.
lastModifiedAt	string (date-time)	Метка времени последнего изменения ресурса (UTC)
lastModifiedBy	string	Идентификатор, который последний раз изменил ресурс.
lastModifiedByType	createdByType	Тип удостоверения, который последний раз изменил ресурс.

Text

Object

Параметры текста

Имя	Тип	Описание
recordStartTimestampFormat	KnownLogFileTextSettingsRecordStartTimestampFormat	Один из поддерживаемых форматов меток времени

UserAssignedIdentity

Object

Свойства назначаемого пользователем удостоверения

Имя	Тип	Описание
clientId	string (uuid)	Идентификатор клиента назначенного удостоверения.
principalId	string (uuid)	Основной идентификатор назначенного удостоверения.

WindowsEventLogDataSource

Object

Определение того, какие события журнала событий Windows будут собираться и как они будут собираться. Только собранные с компьютеров Windows.

Имя	Тип	Описание
name	string	Понятное имя источника данных. Это имя должно быть уникальным для всех источников данных (независимо от типа) в правиле сбора данных.
streams	KnownWindowsEventLogDataSourceStreams[]	Список потоков, в которые будет отправлен этот источник данных. Поток указывает, какая схема будет использоваться для этих данных и обычно какая таблица в Log Analytics будет отправлена.
transformKql	string	Запрос KQL для преобразования источника данных.
xPathQueries	string[]	Список запросов журнала событий Windows в формате XPATH.

WindowsFirewallLogsDataSource

Object

Позволяет собирать журналы брандмауэра с помощью этого правила сбора данных.

Имя	Тип	Описание
name	string	Понятное имя источника данных. Это имя должно быть уникальным для всех источников данных (независимо от типа) в правиле сбора данных.
profileFilter	KnownWindowsFirewallLogsDataSourceProfileFilter[]	Фильтр профиля журналов брандмауэра
streams	string[]	Потоки журналов брандмауэра

Поделиться через

Data Collection Rules - Create

Параметры URI

Текст запроса

Ответы

Безопасность

azure_auth

Области

Примеры

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

Образец запроса

Пример ответа

Определения

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