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 參數

名稱	位於	必要	類型	Description
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 版本。

要求本文

名稱	必要	類型	Description
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	資源標籤。

回應

名稱	類型	Description
200 OK	DataCollectionRuleResource	數據收集規則已成功更新
201 Created	DataCollectionRuleResource	已成功建立數據收集規則
Other Status Codes	ErrorResponseCommonV2	錯誤

安全性

azure_auth

Azure Active Directory OAuth2 流

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
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

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

from azure.identity import DefaultAzureCredential

from azure.mgmt.monitor import MonitorManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-monitor
# USAGE
    python data_collection_rules_create_agent_settings.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = MonitorManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="703362b3-f278-4e4b-9179-c76eaf41ffc2",
    )

    response = client.data_collection_rules.create(
        resource_group_name="myResourceGroup",
        data_collection_rule_name="myCollectionRule",
    )
    print(response)


# x-ms-original-file: specification/monitor/resource-manager/Microsoft.Insights/stable/2023-03-11/examples/DataCollectionRulesCreateAgentSettings.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

範例回覆

狀態碼:: 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
Python

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

from azure.identity import DefaultAzureCredential

from azure.mgmt.monitor import MonitorManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-monitor
# USAGE
    python data_collection_rules_create.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = MonitorManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="703362b3-f278-4e4b-9179-c76eaf41ffc2",
    )

    response = client.data_collection_rules.create(
        resource_group_name="myResourceGroup",
        data_collection_rule_name="myCollectionRule",
    )
    print(response)


# x-ms-original-file: specification/monitor/resource-manager/Microsoft.Insights/stable/2023-03-11/examples/DataCollectionRulesCreate.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

範例回覆

狀態碼:: 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
Python

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

from azure.identity import DefaultAzureCredential

from azure.mgmt.monitor import MonitorManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-monitor
# USAGE
    python data_collection_rules_create_embedded_dce.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = MonitorManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="703362b3-f278-4e4b-9179-c76eaf41ffc2",
    )

    response = client.data_collection_rules.create(
        resource_group_name="myResourceGroup",
        data_collection_rule_name="myCollectionRule",
    )
    print(response)


# x-ms-original-file: specification/monitor/resource-manager/Microsoft.Insights/stable/2023-03-11/examples/DataCollectionRulesCreateEmbeddedDCE.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

範例回覆

狀態碼:: 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
Python

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

from azure.identity import DefaultAzureCredential

from azure.mgmt.monitor import MonitorManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-monitor
# USAGE
    python data_collection_rules_create_enrichment.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = MonitorManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="703362b3-f278-4e4b-9179-c76eaf41ffc2",
    )

    response = client.data_collection_rules.create(
        resource_group_name="myResourceGroup",
        data_collection_rule_name="myCollectionRule",
    )
    print(response)


# x-ms-original-file: specification/monitor/resource-manager/Microsoft.Insights/stable/2023-03-11/examples/DataCollectionRulesCreateEnrichment.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

範例回覆

狀態碼:: 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"
}

定義

名稱	Description
AdxDestination	Azure 資料總管（Adx）目的地。
AgentSetting	用來控制主電腦上的代理程式行為的設定
AgentSettings	用來修改指定主機上代理程序行為的代理程式設定
AzureMonitorMetrics	Azure 監視器計量目的地。
ColumnDefinition	自訂數據行的定義。
createdByType	建立資源的身分識別類型。
DataCollectionRuleResource	ARM 追蹤的最上層資源定義。
DataFlow	要傳送至目的地之數據流的定義。
DataImports	提取型數據源的規格
DataSources	數據源的規格。此屬性是選擇性的，如果規則是要透過對布建端點的直接呼叫來使用，則可以省略此屬性。
Destinations	目的地的規格。
Endpoints	定義透過此規則將數據傳送至的擷取端點。
EnrichmentData	數據流中參考的所有擴充數據源
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponseCommonV2	錯誤回應
EventHub	事件中樞組態的定義。
EventHubDestination
EventHubDirectDestination
ExtensionDataSource	要從與 Azure 監視器代理程式整合的個別 VM 擴充功能中收集哪些數據的定義。根據定義的擴充功能，從任一部 Windows 和 Linux 機器收集。
Identity	資源的受控服務識別。
IisLogsDataSource	啟用此資料收集規則所收集的 IIS 記錄。
KnownAgentSettingName	設定的名稱。必須是支援設定清單的一部分
KnownColumnDefinitionType	數據行數據的型別。
KnownDataCollectionRuleProvisioningState	資源布建狀態。
KnownDataCollectionRuleResourceKind	資源的種類。
KnownDataFlowStreams	此數據流的數據流清單。
KnownExtensionDataSourceStreams	此數據源將傳送至的數據流清單。數據流會指出將針對此數據使用哪些架構，而且通常會在Log Analytics中將數據傳送至哪個數據表。
KnownLogFilesDataSourceFormat	記錄檔的數據格式
KnownLogFileTextSettingsRecordStartTimestampFormat	其中一種支援的時間戳格式
KnownPerfCounterDataSourceStreams	此數據源將傳送至的數據流清單。數據流會指出將針對此數據使用哪些架構，而且通常會在Log Analytics中將數據傳送至哪個數據表。
KnownPrometheusForwarderDataSourceStreams	此數據源將傳送至的數據流清單。
KnownStorageBlobLookupType	在 Blob 上執行的查閱類型
KnownSyslogDataSourceFacilityNames	設施名稱的清單。
KnownSyslogDataSourceLogLevels	要收集的記錄層級。
KnownSyslogDataSourceStreams	此數據源將傳送至的數據流清單。數據流會指出將針對此數據使用哪些架構，而且通常會在Log Analytics中將數據傳送至哪個數據表。
KnownWindowsEventLogDataSourceStreams	此數據源將傳送至的數據流清單。數據流會指出將針對此數據使用哪些架構，而且通常會在Log Analytics中將數據傳送至哪個數據表。
KnownWindowsFirewallLogsDataSourceProfileFilter	防火牆記錄配置文件篩選
LogAnalyticsDestination	Log Analytics 目的地。
LogFilesDataSource	此數據收集規則將收集哪些自定義記錄檔的定義
ManagedServiceIdentityType	受控服務識別的類型（允許 SystemAssigned 和 UserAssigned 類型）。
Metadata	資源的相關元數據
MicrosoftFabricDestination	Microsoft網狀架構目的地（非 Azure）。
MonitoringAccountDestination	監視帳戶目的地。
PerfCounterDataSource	定義將收集哪些性能計數器，以及此數據收集規則將如何收集它們。從計數器所在的 Windows 和 Linux 機器收集。
PlatformTelemetryDataSource	平臺遙測數據源組態的定義
PrometheusForwarderDataSource	Prometheus 計量轉送組態的定義。
References	定義 DCR 其他區段中可能使用的所有參考
Settings	記錄檔特定設定。
StorageBlob
StorageBlobDestination
StorageTableDestination
StreamDeclaration	自訂數據流的宣告。
SyslogDataSource	要收集哪些 syslog 資料的定義，以及其收集方式。僅從Linux機器收集。
SystemData	與建立和上次修改資源相關的元數據。
Text	文字設定
UserAssignedIdentity	使用者指派的身分識別屬性
WindowsEventLogDataSource	要收集哪些 Windows 事件記錄檔事件的定義，以及其收集方式。僅從 Windows 電腦收集。
WindowsFirewallLogsDataSource	啟用此數據收集規則所收集的防火牆記錄。

AdxDestination

Object

Azure 資料總管（Adx）目的地。

名稱	類型	Description
databaseName	string	要擷取數據的資料庫名稱。
ingestionUri	string	Adx 資源的擷取 URI。
name	string	目的地的易記名稱。此名稱在數據收集規則內的所有目的地中都應該是唯一的。不論類型為何。
resourceId	string	Adx 資源的 ARM 資源識別碼。

AgentSetting

Object

用來控制主電腦上的代理程式行為的設定

名稱	類型	Description
name	KnownAgentSettingName	設定的名稱。必須是支援設定清單的一部分
value	string	設定的值

AgentSettings

Object

用來修改指定主機上代理程序行為的代理程式設定

名稱	類型	Description
logs	AgentSetting[]	所有適用於記錄代理程式的設定（AMA）

AzureMonitorMetrics

Object

Azure 監視器計量目的地。

名稱	類型	Description
name	string	目的地的易記名稱。此名稱在數據收集規則內的所有目的地中都應該是唯一的。不論類型為何。

ColumnDefinition

Object

自訂數據行的定義。

名稱	類型	Description
name	string	欄位名稱。
type	KnownColumnDefinitionType	數據行數據的型別。

createdByType

列舉型別

建立資源的身分識別類型。

值	Description
User
Application
ManagedIdentity
Key

DataCollectionRuleResource

Object

ARM 追蹤的最上層資源定義。

名稱	類型	Description
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

要傳送至目的地之數據流的定義。

名稱	類型	Description
builtInTransform	string	用來轉換數據流數據的 builtIn 轉換
captureOverflow	boolean	在 LA 目的地中啟用溢位數據行的旗標
destinations	string[]	此數據流的目的地清單。
outputStream	string	轉換的輸出數據流。只有在轉換將數據變更為不同的數據流時才需要。
streams	KnownDataFlowStreams[]	此數據流的數據流清單。
transformKql	string	轉換數據流數據的 KQL 查詢。

DataImports

Object

提取型數據源的規格

名稱	類型	Description
eventHub	EventHub	事件中樞組態的定義。

DataSources

Object

數據源的規格。此屬性是選擇性的，如果規則是要透過對布建端點的直接呼叫來使用，則可以省略此屬性。

名稱	類型	Description
dataImports	DataImports	提取型數據源的規格
extensions	ExtensionDataSource[]	Azure VM 擴充功能數據源組態的清單。
iisLogs	IisLogsDataSource[]	IIS 記錄來源組態的清單。
logFiles	LogFilesDataSource[]	記錄檔來源組態的清單。
performanceCounters	PerfCounterDataSource[]	性能計數器數據源組態的清單。
platformTelemetry	PlatformTelemetryDataSource[]	平台遙測組態清單
prometheusForwarder	PrometheusForwarderDataSource[]	Prometheus 轉寄站數據源組態的清單。
syslog	SyslogDataSource[]	Syslog 資料源組態的清單。
windowsEventLogs	WindowsEventLogDataSource[]	Windows 事件記錄檔數據源組態的清單。
windowsFirewallLogs	WindowsFirewallLogsDataSource[]	Windows 防火牆記錄來源組態的清單。

Destinations

Object

目的地的規格。

名稱	類型	Description
azureDataExplorer	AdxDestination[]	Azure 資料總管目的地的清單。
azureMonitorMetrics	AzureMonitorMetrics	Azure 監視器計量目的地。
eventHubs	EventHubDestination[]	事件中樞目的地清單。
eventHubsDirect	EventHubDirectDestination[]	事件中樞直接目的地清單。
logAnalytics	LogAnalyticsDestination[]	Log Analytics 目的地清單。
microsoftFabric	MicrosoftFabricDestination[]	網狀架構目的地Microsoft清單。
monitoringAccounts	MonitoringAccountDestination[]	監視帳戶目的地的清單。
storageAccounts	StorageBlobDestination[]	記憶體帳戶目的地的清單。
storageBlobsDirect	StorageBlobDestination[]	記憶體 Blob 直接目的地的清單。僅用於將數據直接從代理程式傳送至存放區。
storageTablesDirect	StorageTableDestination[]	記憶體數據表直接目的地的清單。

Endpoints

Object

定義透過此規則將數據傳送至的擷取端點。

名稱	類型	Description
logsIngestion	string	記錄的擷取端點
metricsIngestion	string	計量的擷取端點

EnrichmentData

Object

數據流中參考的所有擴充數據源

名稱	類型	Description
storageBlobs	StorageBlob[]	用來作為擴充數據源的所有記憶體 Blob

ErrorAdditionalInfo

Object

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	其他資訊。
type	string	其他信息類型。

ErrorDetail

Object

錯誤詳細數據。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
code	string	錯誤碼。
details	ErrorDetail[]	錯誤詳細數據。
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorResponseCommonV2

Object

錯誤回應

名稱	類型	Description
error	ErrorDetail	error 物件。

EventHub

Object

事件中樞組態的定義。

名稱	類型	Description
consumerGroup	string	事件中樞取用者組名
name	string	數據源的易記名稱。此名稱在數據收集規則內的所有數據源中都應該是唯一的。不論類型為何。
stream	string	要從 EventHub 收集的數據流

EventHubDestination

Object

名稱	類型	Description
eventHubResourceId	string	事件中樞的資源標識碼。
name	string	目的地的易記名稱。此名稱在數據收集規則內的所有目的地中都應該是唯一的。不論類型為何。

EventHubDirectDestination

Object

名稱	類型	Description
eventHubResourceId	string	事件中樞的資源標識碼。
name	string	目的地的易記名稱。此名稱在數據收集規則內的所有目的地中都應該是唯一的。不論類型為何。

ExtensionDataSource

Object

要從與 Azure 監視器代理程式整合的個別 VM 擴充功能中收集哪些數據的定義。根據定義的擴充功能，從任一部 Windows 和 Linux 機器收集。

名稱	類型	Description
extensionName	string	VM 擴充功能的名稱。
extensionSettings	object	擴充功能設定。此格式是特定擴充功能的特定格式。
inputDataSources	string[]	此延伸模組所需的數據源清單。
name	string	數據源的易記名稱。此名稱在數據收集規則內的所有數據源中都應該是唯一的。不論類型為何。
streams	KnownExtensionDataSourceStreams[]	此數據源將傳送至的數據流清單。數據流會指出將針對此數據使用哪些架構，而且通常會在Log Analytics中將數據傳送至哪個數據表。

Identity

Object

資源的受控服務識別。

名稱	類型	Description
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 記錄。

名稱	類型	Description
logDirectories	string[]	絕對路徑檔案位置
name	string	數據源的易記名稱。此名稱在數據收集規則內的所有數據源中都應該是唯一的。不論類型為何。
streams	string[]	IIS 數據流
transformKql	string	要轉換數據源的 KQL 查詢。

KnownAgentSettingName

列舉型別

設定的名稱。必須是支援設定清單的一部分

值	Description
MaxDiskQuotaInMB
UseTimeReceivedForForwardedEvents

KnownColumnDefinitionType

列舉型別

數據行數據的型別。

值	Description
string
int
long
real
boolean
datetime
dynamic

KnownDataCollectionRuleProvisioningState

列舉型別

資源布建狀態。

值	Description
Creating
Updating
Deleting
Succeeded
Canceled
Failed

KnownDataCollectionRuleResourceKind

列舉型別

資源的種類。

值	Description
Linux
Windows

KnownDataFlowStreams

列舉型別

此數據流的數據流清單。

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

KnownExtensionDataSourceStreams

列舉型別

此數據源將傳送至的數據流清單。數據流會指出將針對此數據使用哪些架構，而且通常會在Log Analytics中將數據傳送至哪個數據表。

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

KnownLogFilesDataSourceFormat

列舉型別

記錄檔的數據格式

值	Description
json
text

KnownLogFileTextSettingsRecordStartTimestampFormat

列舉型別

其中一種支援的時間戳格式

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

KnownPerfCounterDataSourceStreams

列舉型別

此數據源將傳送至的數據流清單。數據流會指出將針對此數據使用哪些架構，而且通常會在Log Analytics中將數據傳送至哪個數據表。

值	Description
Microsoft-Perf
Microsoft-InsightsMetrics

KnownPrometheusForwarderDataSourceStreams

列舉型別

此數據源將傳送至的數據流清單。

值	Description
Microsoft-PrometheusMetrics

KnownStorageBlobLookupType

列舉型別

在 Blob 上執行的查閱類型

值	Description
String
Cidr

KnownSyslogDataSourceFacilityNames

列舉型別

設施名稱的清單。

值	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

列舉型別

要收集的記錄層級。

值	Description
Debug
Info
Notice
Warning
Error
Critical
Alert
Emergency
*

KnownSyslogDataSourceStreams

列舉型別

此數據源將傳送至的數據流清單。數據流會指出將針對此數據使用哪些架構，而且通常會在Log Analytics中將數據傳送至哪個數據表。

值	Description
Microsoft-Syslog

KnownWindowsEventLogDataSourceStreams

列舉型別

此數據源將傳送至的數據流清單。數據流會指出將針對此數據使用哪些架構，而且通常會在Log Analytics中將數據傳送至哪個數據表。

值	Description
Microsoft-WindowsEvent
Microsoft-Event

KnownWindowsFirewallLogsDataSourceProfileFilter

列舉型別

防火牆記錄配置文件篩選

值	Description
Domain
Private
Public

LogAnalyticsDestination

Object

Log Analytics 目的地。

名稱	類型	Description
name	string	目的地的易記名稱。此名稱在數據收集規則內的所有目的地中都應該是唯一的。不論類型為何。
workspaceId	string	Log Analytics 工作區的客戶標識碼。
workspaceResourceId	string	Log Analytics 工作區的資源標識碼。

LogFilesDataSource

Object

此數據收集規則將收集哪些自定義記錄檔的定義

名稱	類型	Description
filePatterns	string[]	記錄檔所在的檔案模式
format	KnownLogFilesDataSourceFormat	記錄檔的數據格式
name	string	數據源的易記名稱。此名稱在數據收集規則內的所有數據源中都應該是唯一的。不論類型為何。
settings	Settings	記錄檔特定設定。
streams	string[]	此數據源將傳送至的數據流清單。數據流指出將用於此數據源的架構
transformKql	string	要轉換數據源的 KQL 查詢。

ManagedServiceIdentityType

列舉型別

受控服務識別的類型（允許 SystemAssigned 和 UserAssigned 類型）。

值	Description
None
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned

Metadata

Object

資源的相關元數據

名稱	類型	Description
provisionedBy	string	Azure 供應專案會代表客戶管理此資源。
provisionedByImmutableId	string	Azure 供應專案的固定標識符，代表客戶管理此資源。
provisionedByResourceId	string	Azure 供應專案的資源標識符，代表客戶管理此資源。

MicrosoftFabricDestination

Object

Microsoft網狀架構目的地（非 Azure）。

名稱	類型	Description
artifactId	string	Microsoft Fabric 資源的成品標識符。
databaseName	string	要擷取數據的資料庫名稱。
ingestionUri	string	Microsoft Fabric 資源的擷取 URI。
name	string	目的地的易記名稱。此名稱在數據收集規則內的所有目的地中都應該是唯一的。不論類型為何。
tenantId	string	Microsoft Fabric 資源的租用戶標識碼。

MonitoringAccountDestination

Object

監視帳戶目的地。

名稱	類型	Description
accountId	string	帳戶的不可變標識碼。
accountResourceId	string	監視帳戶的資源標識碼。
name	string	目的地的易記名稱。此名稱在數據收集規則內的所有目的地中都應該是唯一的。不論類型為何。

PerfCounterDataSource

Object

定義將收集哪些性能計數器，以及此數據收集規則將如何收集它們。從計數器所在的 Windows 和 Linux 機器收集。

名稱	類型	Description
counterSpecifiers	string[]	您想要收集之性能計數器的規範名稱清單。使用通配符 \ 收集所有實例的計數器。若要在 Windows 上取得性能計數器清單，請執行命令『typeperf』。
name	string	數據源的易記名稱。此名稱在數據收集規則內的所有數據源中都應該是唯一的。不論類型為何。
samplingFrequencyInSeconds	integer (int32)	連續計數器度量之間的秒數（樣本）。
streams	KnownPerfCounterDataSourceStreams[]	此數據源將傳送至的數據流清單。數據流會指出將針對此數據使用哪些架構，而且通常會在Log Analytics中將數據傳送至哪個數據表。
transformKql	string	要轉換數據源的 KQL 查詢。

PlatformTelemetryDataSource

Object

平臺遙測數據源組態的定義

名稱	類型	Description
name	string	數據源的易記名稱。此名稱在數據收集規則內的所有數據源中都應該是唯一的。不論類型為何。
streams	string[]	要收集的平臺遙測數據流清單

PrometheusForwarderDataSource

Object

Prometheus 計量轉送組態的定義。

名稱	類型	Description
labelIncludeFilter	object	標籤包含篩選清單，格式為標籤 “name-value” 組。目前只支援一個標籤：『microsoft_metrics_include_label』。標籤值不區分大小寫。
name	string	數據源的易記名稱。此名稱在數據收集規則內的所有數據源中都應該是唯一的。不論類型為何。
streams	KnownPrometheusForwarderDataSourceStreams[]	此數據源將傳送至的數據流清單。

References

Object

定義 DCR 其他區段中可能使用的所有參考

名稱	類型	Description
enrichmentData	EnrichmentData	數據流中參考的所有擴充數據源

Settings

Object

記錄檔特定設定。

名稱	類型	Description
text	Text	文字設定

StorageBlob

Object

名稱	類型	Description
blobUrl	string	記憶體 Blob 的 URL
lookupType	KnownStorageBlobLookupType	在 Blob 上執行的查閱類型
name	string	在數據流中參考此數據源時，用來作為別名的擴充數據源名稱
resourceId	string	裝載 Blob 的記憶體帳戶資源識別碼

StorageBlobDestination

Object

名稱	類型	Description
containerName	string	記憶體 Blob 的容器名稱。
name	string	目的地的易記名稱。此名稱在數據收集規則內的所有目的地中都應該是唯一的。不論類型為何。
storageAccountResourceId	string	記憶體帳戶的資源標識碼。

StorageTableDestination

Object

名稱	類型	Description
name	string	目的地的易記名稱。此名稱在數據收集規則內的所有目的地中都應該是唯一的。不論類型為何。
storageAccountResourceId	string	記憶體帳戶的資源標識碼。
tableName	string	記憶體數據表的名稱。

StreamDeclaration

Object

自訂數據流的宣告。

名稱	類型	Description
columns	ColumnDefinition[]	此資料流中資料所使用的數據列清單。

SyslogDataSource

Object

要收集哪些 syslog 資料的定義，以及其收集方式。僅從Linux機器收集。

名稱	類型	Description
facilityNames	KnownSyslogDataSourceFacilityNames[]	設施名稱的清單。
logLevels	KnownSyslogDataSourceLogLevels[]	要收集的記錄層級。
name	string	數據源的易記名稱。此名稱在數據收集規則內的所有數據源中都應該是唯一的。不論類型為何。
streams	KnownSyslogDataSourceStreams[]	此數據源將傳送至的數據流清單。數據流會指出將針對此數據使用哪些架構，而且通常會在Log Analytics中將數據傳送至哪個數據表。
transformKql	string	要轉換數據源的 KQL 查詢。

SystemData

Object

與建立和上次修改資源相關的元數據。

名稱	類型	Description
createdAt	string (date-time)	資源建立的時間戳（UTC）。
createdBy	string	建立資源的身分識別。
createdByType	createdByType	建立資源的身分識別類型。
lastModifiedAt	string (date-time)	上次修改的資源時間戳（UTC）
lastModifiedBy	string	上次修改資源的身分識別。
lastModifiedByType	createdByType	上次修改資源的身分識別類型。

Text

Object

文字設定

名稱	類型	Description
recordStartTimestampFormat	KnownLogFileTextSettingsRecordStartTimestampFormat	其中一種支援的時間戳格式

UserAssignedIdentity

Object

使用者指派的身分識別屬性

名稱	類型	Description
clientId	string (uuid)	指派之身分識別的用戶端標識碼。
principalId	string (uuid)	指派之身分識別的主體標識碼。

WindowsEventLogDataSource

Object

要收集哪些 Windows 事件記錄檔事件的定義，以及其收集方式。僅從 Windows 電腦收集。

名稱	類型	Description
name	string	數據源的易記名稱。此名稱在數據收集規則內的所有數據源中都應該是唯一的。不論類型為何。
streams	KnownWindowsEventLogDataSourceStreams[]	此數據源將傳送至的數據流清單。數據流會指出將針對此數據使用哪些架構，而且通常會在Log Analytics中將數據傳送至哪個數據表。
transformKql	string	要轉換數據源的 KQL 查詢。
xPathQueries	string[]	XPATH 格式的 Windows 事件記錄檔查詢清單。

WindowsFirewallLogsDataSource

Object

啟用此數據收集規則所收集的防火牆記錄。

名稱	類型	Description
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