Data Collection Rules - Create

Tjänst:: Monitor

API-version:: 2023-03-11

Skapar eller uppdaterar en datainsamlingsregel.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
dataCollectionRuleName	path	True	string	Namnet på datainsamlingsregeln. Namnet är skiftlägesokänsligt.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
subscriptionId	path	True	string minLength: 1	ID för målprenumerationen.
api-version	query	True	string minLength: 1	DEN API-version som ska användas för den här åtgärden.

Begärandetext

Name	Obligatorisk	Typ	Description
location	True	string	Den geo-plats där resursen finns.
identity		Identity	Resursens hanterade tjänstidentitet.
kind		KnownDataCollectionRuleResourceKind	Typen av resurs.
properties.agentSettings		AgentSettings	Agentinställningar som används för att ändra agentbeteende på en viss värd
properties.dataCollectionEndpointId		string	Resurs-ID för den datainsamlingsslutpunkt som den här regeln kan användas med.
properties.dataFlows		DataFlow[]	Specifikationen av dataflöden.
properties.dataSources		DataSources	Specifikationen av datakällor. Den här egenskapen är valfri och kan utelämnas om regeln är avsedd att användas via direkta anrop till den etablerade slutpunkten.
properties.description		string	Beskrivning av datainsamlingsregeln.
properties.destinations		Destinations	Specifikationen av destinationer.
properties.references		References	Definierar alla referenser som kan användas i andra delar av DCR
properties.streamDeclarations		<string, StreamDeclaration>	Deklaration av anpassade strömmar som används i den här regeln.
tags		object	Resurstaggar.

Svar

Name	Typ	Description
200 OK	DataCollectionRuleResource	Datainsamlingsregeln har uppdaterats
201 Created	DataCollectionRuleResource	Datainsamlingsregeln har skapats
Other Status Codes	ErrorResponseCommonV2	Fel

Säkerhet

azure_auth

Azure Active Directory OAuth2-flöde

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

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

Exempelsvar

Statuskod:: 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"
}

Statuskod:: 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

Exempelbegäran

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

Exempelsvar

Statuskod:: 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"
}

Statuskod:: 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

Exempelbegäran

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

Exempelsvar

Statuskod:: 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"
}

Statuskod:: 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

Exempelbegäran

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

Exempelsvar

Statuskod:: 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"
}

Statuskod:: 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"
}

Definitioner

Name	Description
AdxDestination	Azure Data Explorer-mål (Adx).
AgentSetting	En inställning som används för att styra agentbeteendet på en värddator
AgentSettings	Agentinställningar som används för att ändra agentbeteende på en viss värd
AzureMonitorMetrics	Azure Monitor Metrics-mål.
ColumnDefinition	Definition av anpassad datakolumn.
createdByType	Den typ av identitet som skapade resursen.
DataCollectionRuleResource	Definition av ARM-spårad resurs på toppnivå.
DataFlow	Definition av vilka strömmar som skickas till vilka mål.
DataImports	Specifikationer för pull-baserade datakällor
DataSources	Specifikationen av datakällor. Den här egenskapen är valfri och kan utelämnas om regeln är avsedd att användas via direkta anrop till den etablerade slutpunkten.
Destinations	Specifikationen av destinationer.
Endpoints	Definierar de inmatningsslutpunkter som data ska skickas till via den här regeln.
EnrichmentData	Alla berikande datakällor som refereras i dataflöden
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponseCommonV2	Felsvar
EventHub	Definition av Event Hub-konfiguration.
EventHubDestination
EventHubDirectDestination
ExtensionDataSource	Definition av vilka data som ska samlas in från ett separat VM-tillägg som integreras med Azure Monitor-agenten. Samlas in från antingen Windows- och Linux-datorer, beroende på vilket tillägg som definieras.
Identity	Resursens hanterade tjänstidentitet.
IisLogsDataSource	Gör att IIS-loggar kan samlas in av den här datainsamlingsregeln.
KnownAgentSettingName	Namnet på inställningen. Måste ingå i listan över inställningar som stöds
KnownColumnDefinitionType	Typen av kolumndata.
KnownDataCollectionRuleProvisioningState	Resursetableringstillståndet.
KnownDataCollectionRuleResourceKind	Typen av resurs.
KnownDataFlowStreams	Lista över strömmar för det här dataflödet.
KnownExtensionDataSourceStreams	Lista över strömmar som den här datakällan ska skickas till. En dataström anger vilket schema som ska användas för dessa data och vanligtvis vilken tabell i Log Analytics som data skickas till.
KnownLogFilesDataSourceFormat	Dataformatet för loggfilerna
KnownLogFileTextSettingsRecordStartTimestampFormat	Ett av de tidsstämpelformat som stöds
KnownPerfCounterDataSourceStreams	Lista över strömmar som den här datakällan ska skickas till. En dataström anger vilket schema som ska användas för dessa data och vanligtvis vilken tabell i Log Analytics som data skickas till.
KnownPrometheusForwarderDataSourceStreams	Lista över strömmar som den här datakällan ska skickas till.
KnownStorageBlobLookupType	Typ av sökning som ska utföras på bloben
KnownSyslogDataSourceFacilityNames	Listan över anläggningsnamn.
KnownSyslogDataSourceLogLevels	Loggnivåerna som ska samlas in.
KnownSyslogDataSourceStreams	Lista över strömmar som den här datakällan ska skickas till. En dataström anger vilket schema som ska användas för dessa data och vanligtvis vilken tabell i Log Analytics som data skickas till.
KnownWindowsEventLogDataSourceStreams	Lista över strömmar som den här datakällan ska skickas till. En dataström anger vilket schema som ska användas för dessa data och vanligtvis vilken tabell i Log Analytics som data skickas till.
KnownWindowsFirewallLogsDataSourceProfileFilter	Profilfilter för brandväggsloggar
LogAnalyticsDestination	Log Analytics-mål.
LogFilesDataSource	Definition av vilka anpassade loggfiler som ska samlas in av den här datainsamlingsregeln
ManagedServiceIdentityType	Typ av hanterad tjänstidentitet (där både SystemAssigned- och UserAssigned-typer tillåts).
Metadata	Metadata om resursen
MicrosoftFabricDestination	Microsoft Fabric-mål (icke-Azure).
MonitoringAccountDestination	Övervakningskontomål.
PerfCounterDataSource	Definition av vilka prestandaräknare som ska samlas in och hur de ska samlas in av den här datainsamlingsregeln. Samlas in från både Windows- och Linux-datorer där räknaren finns.
PlatformTelemetryDataSource	Definition av konfiguration av plattformstelemetridatakälla
PrometheusForwarderDataSource	Definition av Konfiguration av vidarebefordran av Prometheus-mått.
References	Definierar alla referenser som kan användas i andra delar av DCR
Settings	Loggfilernas specifika inställningar.
StorageBlob
StorageBlobDestination
StorageTableDestination
StreamDeclaration	Deklaration av en anpassad ström.
SyslogDataSource	Definition av vilka syslog-data som ska samlas in och hur de ska samlas in. Samlas endast in från Linux-datorer.
SystemData	Metadata som rör skapande och senaste ändring av resursen.
Text	Textinställningar
UserAssignedIdentity	Användartilldelade identitetsegenskaper
WindowsEventLogDataSource	Definition av vilka Händelser i Windows-händelseloggen som ska samlas in och hur de ska samlas in. Samlas endast in från Windows-datorer.
WindowsFirewallLogsDataSource	Gör att brandväggsloggar kan samlas in av den här datainsamlingsregeln.

AdxDestination

Objekt

Azure Data Explorer-mål (Adx).

Name	Typ	Description
databaseName	string	Namnet på databasen som data ska matas in till.
ingestionUri	string	Inmatnings-uri för Adx-resursen.
name	string	Ett eget namn för målet. Det här namnet ska vara unikt för alla mål (oavsett typ) i datainsamlingsregeln.
resourceId	string	ARM-resurs-ID för Adx-resursen.

AgentSetting

Objekt

En inställning som används för att styra agentbeteendet på en värddator

Name	Typ	Description
name	KnownAgentSettingName	Namnet på inställningen. Måste ingå i listan över inställningar som stöds
value	string	Värdet för inställningen

AgentSettings

Objekt

Agentinställningar som används för att ändra agentbeteende på en viss värd

Name	Typ	Description
logs	AgentSetting[]	Alla inställningar som gäller för loggagenten (AMA)

AzureMonitorMetrics

Objekt

Azure Monitor Metrics-mål.

Name	Typ	Description
name	string	Ett eget namn för målet. Det här namnet ska vara unikt för alla mål (oavsett typ) i datainsamlingsregeln.

ColumnDefinition

Objekt

Definition av anpassad datakolumn.

Name	Typ	Description
name	string	Namnet på kolumnen.
type	KnownColumnDefinitionType	Typen av kolumndata.

createdByType

Uppräkning

Den typ av identitet som skapade resursen.

Värde	Description
User
Application
ManagedIdentity
Key

DataCollectionRuleResource

Objekt

Definition av ARM-spårad resurs på toppnivå.

Name	Typ	Description
etag	string	Resursentitetstagg (ETag).
id	string	Fullständigt kvalificerat ID för resursen.
identity	Identity	Resursens hanterade tjänstidentitet.
kind	KnownDataCollectionRuleResourceKind	Typen av resurs.
location	string	Den geo-plats där resursen finns.
name	string	Namnet på resursen.
properties.agentSettings	AgentSettings	Agentinställningar som används för att ändra agentbeteende på en viss värd
properties.dataCollectionEndpointId	string	Resurs-ID för den datainsamlingsslutpunkt som den här regeln kan användas med.
properties.dataFlows	DataFlow[]	Specifikationen av dataflöden.
properties.dataSources	DataSources	Specifikationen av datakällor. Den här egenskapen är valfri och kan utelämnas om regeln är avsedd att användas via direkta anrop till den etablerade slutpunkten.
properties.description	string	Beskrivning av datainsamlingsregeln.
properties.destinations	Destinations	Specifikationen av destinationer.
properties.endpoints	Endpoints	Definierar de inmatningsslutpunkter som data ska skickas till via den här regeln.
properties.immutableId	string	Det oföränderliga ID:t för den här datainsamlingsregeln. Den här egenskapen är SKRIVSKYDDad.
properties.metadata	Metadata	Metadata om resursen
properties.provisioningState	KnownDataCollectionRuleProvisioningState	Resursetableringstillståndet.
properties.references	References	Definierar alla referenser som kan användas i andra delar av DCR
properties.streamDeclarations	<string, StreamDeclaration>	Deklaration av anpassade strömmar som används i den här regeln.
systemData	SystemData	Metadata som rör skapande och senaste ändring av resursen.
tags	object	Resurstaggar.
type	string	Resurstypen.

DataFlow

Objekt

Definition av vilka strömmar som skickas till vilka mål.

Name	Typ	Description
builtInTransform	string	Den inbyggda transformeringen för att transformera dataströmmar
captureOverflow	boolean	Flagga för att aktivera spillkolumn i LA-mål
destinations	string[]	Lista över mål för det här dataflödet.
outputStream	string	Utdataströmmen för transformen. Krävs endast om transformeringen ändrar data till en annan ström.
streams	KnownDataFlowStreams[]	Lista över strömmar för det här dataflödet.
transformKql	string	KQL-frågan för att transformera dataströmmar.

DataImports

Objekt

Specifikationer för pull-baserade datakällor

Name	Typ	Description
eventHub	EventHub	Definition av Event Hub-konfiguration.

DataSources

Objekt

Specifikationen av datakällor. Den här egenskapen är valfri och kan utelämnas om regeln är avsedd att användas via direkta anrop till den etablerade slutpunkten.

Name	Typ	Description
dataImports	DataImports	Specifikationer för pull-baserade datakällor
extensions	ExtensionDataSource[]	Listan över konfigurationer av datakällan för Azure VM-tillägget.
iisLogs	IisLogsDataSource[]	Listan över källkonfigurationer för IIS-loggar.
logFiles	LogFilesDataSource[]	Listan över källkonfigurationer för Loggfiler.
performanceCounters	PerfCounterDataSource[]	Listan över konfigurationer av datakällor för prestandaräknare.
platformTelemetry	PlatformTelemetryDataSource[]	Listan över plattformstelemetrikonfigurationer
prometheusForwarder	PrometheusForwarderDataSource[]	Listan över Konfigurationer för Prometheus-vidarebefordrare av datakällor.
syslog	SyslogDataSource[]	Listan över Syslog-datakällans konfigurationer.
windowsEventLogs	WindowsEventLogDataSource[]	Listan över konfigurationer för Windows-händelseloggens datakälla.
windowsFirewallLogs	WindowsFirewallLogsDataSource[]	Listan över källkonfigurationer för Windows-brandväggens loggar.

Destinations

Objekt

Specifikationen av destinationer.

Name	Typ	Description
azureDataExplorer	AdxDestination[]	Lista över Azure Data Explorer-mål.
azureMonitorMetrics	AzureMonitorMetrics	Azure Monitor Metrics-mål.
eventHubs	EventHubDestination[]	Lista över Event Hubs-mål.
eventHubsDirect	EventHubDirectDestination[]	Lista över Event Hubs Direct-mål.
logAnalytics	LogAnalyticsDestination[]	Lista över Log Analytics-mål.
microsoftFabric	MicrosoftFabricDestination[]	Lista över Microsoft Fabric-mål.
monitoringAccounts	MonitoringAccountDestination[]	Lista över mål för övervakningskonton.
storageAccounts	StorageBlobDestination[]	Lista över mål för lagringskonton.
storageBlobsDirect	StorageBlobDestination[]	Lista över Mål för Lagringsblobdirigering. Ska endast användas för att skicka data direkt för lagring från agenten.
storageTablesDirect	StorageTableDestination[]	Lista över mål för Lagringstabelldirigering.

Endpoints

Objekt

Definierar de inmatningsslutpunkter som data ska skickas till via den här regeln.

Name	Typ	Description
logsIngestion	string	Inmatningsslutpunkten för loggar
metricsIngestion	string	Inmatningsslutpunkten för mått

EnrichmentData

Objekt

Alla berikande datakällor som refereras i dataflöden

Name	Typ	Description
storageBlobs	StorageBlob[]	Alla lagringsblobar som används som berikande datakällor

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Ytterligare informationstyp.

ErrorDetail

Objekt

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponseCommonV2

Objekt

Felsvar

Name	Typ	Description
error	ErrorDetail	Felobjektet.

EventHub

Objekt

Definition av Event Hub-konfiguration.

Name	Typ	Description
consumerGroup	string	Namn på händelsehubbkonsumentgrupp
name	string	Ett eget namn för datakällan. Det här namnet ska vara unikt för alla datakällor (oavsett typ) i datainsamlingsregeln.
stream	string	Dataströmmen som ska samlas in från EventHub

EventHubDestination

Objekt

Name	Typ	Description
eventHubResourceId	string	Resurs-ID för händelsehubben.
name	string	Ett eget namn för målet. Det här namnet ska vara unikt för alla mål (oavsett typ) i datainsamlingsregeln.

EventHubDirectDestination

Objekt

Name	Typ	Description
eventHubResourceId	string	Resurs-ID för händelsehubben.
name	string	Ett eget namn för målet. Det här namnet ska vara unikt för alla mål (oavsett typ) i datainsamlingsregeln.

ExtensionDataSource

Objekt

Definition av vilka data som ska samlas in från ett separat VM-tillägg som integreras med Azure Monitor-agenten. Samlas in från antingen Windows- och Linux-datorer, beroende på vilket tillägg som definieras.

Name	Typ	Description
extensionName	string	Namnet på VM-tillägget.
extensionSettings	object	Tilläggsinställningarna. Formatet är specifikt för ett visst tillägg.
inputDataSources	string[]	Listan över datakällor som tillägget behöver data från.
name	string	Ett eget namn för datakällan. Det här namnet ska vara unikt för alla datakällor (oavsett typ) i datainsamlingsregeln.
streams	KnownExtensionDataSourceStreams[]	Lista över strömmar som den här datakällan ska skickas till. En dataström anger vilket schema som ska användas för dessa data och vanligtvis vilken tabell i Log Analytics som data skickas till.

Identity

Objekt

Resursens hanterade tjänstidentitet.

Name	Typ	Description
principalId	string (uuid)	Tjänstens huvudnamns-ID för den systemtilldelade identiteten. Den här egenskapen tillhandahålls endast för en systemtilldelad identitet.
tenantId	string (uuid)	Klientorganisations-ID för den systemtilldelade identiteten. Den här egenskapen tillhandahålls endast för en systemtilldelad identitet.
type	ManagedServiceIdentityType	Typ av hanterad tjänstidentitet (där både SystemAssigned- och UserAssigned-typer tillåts).
userAssignedIdentities	<string, UserAssignedIdentity>	User-Assigned identiteter Uppsättningen användartilldelade identiteter som är associerade med resursen. Ordlistenycklarna userAssignedIdentities är ARM-resurs-ID:er i formuläret: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Ordlistevärdena kan vara tomma objekt ({}) i begäranden.

IisLogsDataSource

Objekt

Gör att IIS-loggar kan samlas in av den här datainsamlingsregeln.

Name	Typ	Description
logDirectories	string[]	Filplats för absoluta sökvägar
name	string	Ett eget namn för datakällan. Det här namnet ska vara unikt för alla datakällor (oavsett typ) i datainsamlingsregeln.
streams	string[]	IIS-strömmar
transformKql	string	KQL-frågan för att transformera datakällan.

KnownAgentSettingName

Uppräkning

Namnet på inställningen. Måste ingå i listan över inställningar som stöds

Värde	Description
MaxDiskQuotaInMB
UseTimeReceivedForForwardedEvents

KnownColumnDefinitionType

Uppräkning

Typen av kolumndata.

Värde	Description
string
int
long
real
boolean
datetime
dynamic

KnownDataCollectionRuleProvisioningState

Uppräkning

Resursetableringstillståndet.

Värde	Description
Creating
Updating
Deleting
Succeeded
Canceled
Failed

KnownDataCollectionRuleResourceKind

Uppräkning

Typen av resurs.

Värde	Description
Linux
Windows

KnownDataFlowStreams

Uppräkning

Lista över strömmar för det här dataflödet.

Värde	Description
Microsoft-Event
Microsoft-InsightsMetrics
Microsoft-Perf
Microsoft-Syslog
Microsoft-WindowsEvent

KnownExtensionDataSourceStreams

Uppräkning

Lista över strömmar som den här datakällan ska skickas till. En dataström anger vilket schema som ska användas för dessa data och vanligtvis vilken tabell i Log Analytics som data skickas till.

Värde	Description
Microsoft-Event
Microsoft-InsightsMetrics
Microsoft-Perf
Microsoft-Syslog
Microsoft-WindowsEvent

KnownLogFilesDataSourceFormat

Uppräkning

Dataformatet för loggfilerna

Värde	Description
json
text

KnownLogFileTextSettingsRecordStartTimestampFormat

Uppräkning

Ett av de tidsstämpelformat som stöds

Värde	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

Uppräkning

Värde	Description
Microsoft-Perf
Microsoft-InsightsMetrics

KnownPrometheusForwarderDataSourceStreams

Uppräkning

Lista över strömmar som den här datakällan ska skickas till.

Värde	Description
Microsoft-PrometheusMetrics

KnownStorageBlobLookupType

Uppräkning

Typ av sökning som ska utföras på bloben

Värde	Description
String
Cidr

KnownSyslogDataSourceFacilityNames

Uppräkning

Listan över anläggningsnamn.

Värde	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

Uppräkning

Loggnivåerna som ska samlas in.

Värde	Description
Debug
Info
Notice
Warning
Error
Critical
Alert
Emergency
*

KnownSyslogDataSourceStreams

Uppräkning

Värde	Description
Microsoft-Syslog

KnownWindowsEventLogDataSourceStreams

Uppräkning

Värde	Description
Microsoft-WindowsEvent
Microsoft-Event

KnownWindowsFirewallLogsDataSourceProfileFilter

Uppräkning

Profilfilter för brandväggsloggar

Värde	Description
Domain
Private
Public

LogAnalyticsDestination

Objekt

Log Analytics-mål.

Name	Typ	Description
name	string	Ett eget namn för målet. Det här namnet ska vara unikt för alla mål (oavsett typ) i datainsamlingsregeln.
workspaceId	string	Kund-ID för Log Analytics-arbetsytan.
workspaceResourceId	string	Resurs-ID för Log Analytics-arbetsytan.

LogFilesDataSource

Objekt

Definition av vilka anpassade loggfiler som ska samlas in av den här datainsamlingsregeln

Name	Typ	Description
filePatterns	string[]	Filmönster där loggfilerna finns
format	KnownLogFilesDataSourceFormat	Dataformatet för loggfilerna
name	string	Ett eget namn för datakällan. Det här namnet ska vara unikt för alla datakällor (oavsett typ) i datainsamlingsregeln.
settings	Settings	Loggfilernas specifika inställningar.
streams	string[]	Lista över strömmar som den här datakällan ska skickas till. En ström anger vilket schema som ska användas för den här datakällan
transformKql	string	KQL-frågan för att transformera datakällan.

ManagedServiceIdentityType

Uppräkning

Typ av hanterad tjänstidentitet (där både SystemAssigned- och UserAssigned-typer tillåts).

Värde	Description
None
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned

Metadata

Objekt

Metadata om resursen

Name	Typ	Description
provisionedBy	string	Azure erbjuder hantering av den här resursen åt kunden.
provisionedByImmutableId	string	Oföränderligt ID för Azure som erbjuder hantering av den här resursen åt kunden.
provisionedByResourceId	string	Resurs-ID för Azure-erbjudandet som hanterar den här resursen för kundens räkning.

MicrosoftFabricDestination

Objekt

Microsoft Fabric-mål (icke-Azure).

Name	Typ	Description
artifactId	string	Artefakt-ID för Microsoft Fabric-resursen.
databaseName	string	Namnet på databasen som data ska matas in till.
ingestionUri	string	Inmatnings-URI för Microsoft Fabric-resursen.
name	string	Ett eget namn för målet. Det här namnet ska vara unikt för alla mål (oavsett typ) i datainsamlingsregeln.
tenantId	string	Klient-ID för Microsoft Fabric-resursen.

MonitoringAccountDestination

Objekt

Övervakningskontomål.

Name	Typ	Description
accountId	string	Kontots oföränderliga ID.
accountResourceId	string	Resurs-ID för övervakningskontot.
name	string	Ett eget namn för målet. Det här namnet ska vara unikt för alla mål (oavsett typ) i datainsamlingsregeln.

PerfCounterDataSource

Objekt

Definition av vilka prestandaräknare som ska samlas in och hur de ska samlas in av den här datainsamlingsregeln. Samlas in från både Windows- och Linux-datorer där räknaren finns.

Name	Typ	Description
counterSpecifiers	string[]	En lista med specificerarnamn för de prestandaräknare som du vill samla in. Använd ett jokertecken (*) för att samla in en räknare för alla instanser. Om du vill hämta en lista över prestandaräknare i Windows kör du kommandot "typeperf".
name	string	Ett eget namn för datakällan. Det här namnet ska vara unikt för alla datakällor (oavsett typ) i datainsamlingsregeln.
samplingFrequencyInSeconds	integer (int32)	Antalet sekunder mellan på varandra följande räknarmätningar (exempel).
streams	KnownPerfCounterDataSourceStreams[]	Lista över strömmar som den här datakällan ska skickas till. En dataström anger vilket schema som ska användas för dessa data och vanligtvis vilken tabell i Log Analytics som data skickas till.
transformKql	string	KQL-frågan för att transformera datakällan.

PlatformTelemetryDataSource

Objekt

Definition av konfiguration av plattformstelemetridatakälla

Name	Typ	Description
name	string	Ett eget namn för datakällan. Det här namnet ska vara unikt för alla datakällor (oavsett typ) i datainsamlingsregeln.
streams	string[]	Lista över plattformstelemetriströmmar att samla in

PrometheusForwarderDataSource

Objekt

Definition av Konfiguration av vidarebefordran av Prometheus-mått.

Name	Typ	Description
labelIncludeFilter	object	Listan över etikettinkluderingsfilter i form av etiketten "name-value"-par. För närvarande stöds endast en etikett: "microsoft_metrics_include_label". Etikettvärden matchas skiftlägesokänsligt.
name	string	Ett eget namn för datakällan. Det här namnet ska vara unikt för alla datakällor (oavsett typ) i datainsamlingsregeln.
streams	KnownPrometheusForwarderDataSourceStreams[]	Lista över strömmar som den här datakällan ska skickas till.

References

Objekt

Definierar alla referenser som kan användas i andra delar av DCR

Name	Typ	Description
enrichmentData	EnrichmentData	Alla berikande datakällor som refereras i dataflöden

Settings

Objekt

Loggfilernas specifika inställningar.

Name	Typ	Description
text	Text	Textinställningar

StorageBlob

Objekt

Name	Typ	Description
blobUrl	string	Url för lagringsbloben
lookupType	KnownStorageBlobLookupType	Typ av sökning som ska utföras på bloben
name	string	Namnet på den berikningsdatakälla som används som alias när du refererar till den här datakällan i dataflöden
resourceId	string	Resurs-ID för lagringskontot som är värd för bloben

StorageBlobDestination

Objekt

Name	Typ	Description
containerName	string	Containernamnet för lagringsbloben.
name	string	Ett eget namn för målet. Det här namnet ska vara unikt för alla mål (oavsett typ) i datainsamlingsregeln.
storageAccountResourceId	string	Lagringskontots resurs-ID.

StorageTableDestination

Objekt

Name	Typ	Description
name	string	Ett eget namn för målet. Det här namnet ska vara unikt för alla mål (oavsett typ) i datainsamlingsregeln.
storageAccountResourceId	string	Lagringskontots resurs-ID.
tableName	string	Namnet på lagringstabellen.

StreamDeclaration

Objekt

Deklaration av en anpassad ström.

Name	Typ	Description
columns	ColumnDefinition[]	Lista över kolumner som används av data i den här strömmen.

SyslogDataSource

Objekt

Definition av vilka syslog-data som ska samlas in och hur de ska samlas in. Samlas endast in från Linux-datorer.

Name	Typ	Description
facilityNames	KnownSyslogDataSourceFacilityNames[]	Listan över anläggningsnamn.
logLevels	KnownSyslogDataSourceLogLevels[]	Loggnivåerna som ska samlas in.
name	string	Ett eget namn för datakällan. Det här namnet ska vara unikt för alla datakällor (oavsett typ) i datainsamlingsregeln.
streams	KnownSyslogDataSourceStreams[]	Lista över strömmar som den här datakällan ska skickas till. En dataström anger vilket schema som ska användas för dessa data och vanligtvis vilken tabell i Log Analytics som data skickas till.
transformKql	string	KQL-frågan för att transformera datakällan.

SystemData

Objekt

Metadata som rör skapande och senaste ändring av resursen.

Name	Typ	Description
createdAt	string (date-time)	Tidsstämpeln för resursskapande (UTC).
createdBy	string	Identiteten som skapade resursen.
createdByType	createdByType	Den typ av identitet som skapade resursen.
lastModifiedAt	string (date-time)	Tidsstämpeln för resursens senaste ändring (UTC)
lastModifiedBy	string	Identiteten som senast ändrade resursen.
lastModifiedByType	createdByType	Den typ av identitet som senast ändrade resursen.

Text

Objekt

Textinställningar

Name	Typ	Description
recordStartTimestampFormat	KnownLogFileTextSettingsRecordStartTimestampFormat	Ett av de tidsstämpelformat som stöds

UserAssignedIdentity

Objekt

Användartilldelade identitetsegenskaper

Name	Typ	Description
clientId	string (uuid)	Klient-ID för den tilldelade identiteten.
principalId	string (uuid)	Huvud-ID för den tilldelade identiteten.

WindowsEventLogDataSource

Objekt

Definition av vilka Händelser i Windows-händelseloggen som ska samlas in och hur de ska samlas in. Samlas endast in från Windows-datorer.

Name	Typ	Description
name	string	Ett eget namn för datakällan. Det här namnet ska vara unikt för alla datakällor (oavsett typ) i datainsamlingsregeln.
streams	KnownWindowsEventLogDataSourceStreams[]	Lista över strömmar som den här datakällan ska skickas till. En dataström anger vilket schema som ska användas för dessa data och vanligtvis vilken tabell i Log Analytics som data skickas till.
transformKql	string	KQL-frågan för att transformera datakällan.
xPathQueries	string[]	En lista över Windows-händelseloggfrågor i XPATH-format.

WindowsFirewallLogsDataSource

Objekt

Gör att brandväggsloggar kan samlas in av den här datainsamlingsregeln.

Name	Typ	Description
name	string	Ett eget namn för datakällan. Det här namnet ska vara unikt för alla datakällor (oavsett typ) i datainsamlingsregeln.
profileFilter	KnownWindowsFirewallLogsDataSourceProfileFilter[]	Profilfilter för brandväggsloggar
streams	string[]	Brandväggsloggar strömmar

Dela via

Data Collection Rules - Create

URI-parametrar

Begärandetext

Svar

Säkerhet

azure_auth

Omfattningar

Exempel

Create or update an agent settings configuration

Exempelbegäran

Exempelsvar

Create or update data collection rule

Exempelbegäran

Exempelsvar

Create or update data collection rule with embedded ingestion endpoints

Exempelbegäran

Exempelsvar

Create or update data collection rule with enrichment

Exempelbegäran

Exempelsvar

Definitioner

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