Data Collection Rules - Create

Služba:

Monitor

Verze rozhraní API:

2023-03-11

Vytvoří nebo aktualizuje pravidlo shromažďování dat.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
dataCollectionRuleName	path	True	string	Název pravidla shromažďování dat. Název nerozlišuje malá a velká písmena.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
subscriptionId	path	True	string minLength: 1	ID cílového předplatného.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Text požadavku

Name	Vyžadováno	Typ	Description
location	True	string	Geografické umístění, ve kterém se nachází zdroj.
identity		Identity	Identita spravované služby prostředku
kind		KnownDataCollectionRuleResourceKind	Druh prostředku.
properties.agentSettings		AgentSettings	Nastavení agenta sloužící k úpravě chování agenta na daném hostiteli
properties.dataCollectionEndpointId		string	ID prostředku koncového bodu shromažďování dat, se kterým se toto pravidlo dá použít.
properties.dataFlows		DataFlow[]	Specifikace toků dat.
properties.dataSources		DataSources	Specifikace zdrojů dat. Tato vlastnost je volitelná a je možné ji vynechat, pokud je pravidlo určené k použití prostřednictvím přímých volání zřízeného koncového bodu.
properties.description		string	Popis pravidla shromažďování dat
properties.destinations		Destinations	Specifikace cílů.
properties.references		References	Definuje všechny odkazy, které lze použít v jiných částech DCR.
properties.streamDeclarations		<string,  StreamDeclaration>	Deklarace vlastních datových proudů používaných v tomto pravidle
tags		object	Značky prostředků

Odpovědi

Name	Typ	Description
200 OK	DataCollectionRuleResource	Pravidlo shromažďování dat bylo úspěšně aktualizováno.
201 Created	DataCollectionRuleResource	Pravidlo shromažďování dat bylo úspěšně vytvořeno.
Other Status Codes	ErrorResponseCommonV2	Chyba

Zabezpečení

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

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

Ukázkový požadavek

HTTP

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

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

Python

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

Ukázková odpověď

Stavový kód:

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

Stavový kód:

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

Ukázkový požadavek

HTTP

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

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

Python

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

Ukázková odpověď

Stavový kód:

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

Stavový kód:

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

Ukázkový požadavek

HTTP

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

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

Python

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

Ukázková odpověď

Stavový kód:

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

Stavový kód:

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

Ukázkový požadavek

HTTP

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

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

Python

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

Ukázková odpověď

Stavový kód:

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

Stavový kód:

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

Definice

Name	Description
AdxDestination	Cíl Azure Data Exploreru (Adx).
AgentSetting	Nastavení sloužící k řízení chování agenta na hostitelském počítači
AgentSettings	Nastavení agenta sloužící k úpravě chování agenta na daném hostiteli
AzureMonitorMetrics	Cíl metrik služby Azure Monitor.
ColumnDefinition	Definice vlastního sloupce dat
createdByType	Typ identity, která prostředek vytvořila.
DataCollectionRuleResource	Definice prostředku nejvyšší úrovně sledovaného ARM
DataFlow	Definice, které datové proudy se odesílají do kterých cílů.
DataImports	Specifikace zdrojů dat založených na vyžádání
DataSources	Specifikace zdrojů dat. Tato vlastnost je volitelná a je možné ji vynechat, pokud je pravidlo určené k použití prostřednictvím přímých volání zřízeného koncového bodu.
Destinations	Specifikace cílů.
Endpoints	Definuje koncové body příjmu dat, do které se mají odesílat data prostřednictvím tohoto pravidla.
EnrichmentData	Všechny zdroje dat rozšiřování, na které odkazují toky dat
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponseCommonV2	Chybová odpověď
EventHub	Definice konfigurace centra událostí
EventHubDestination
EventHubDirectDestination
ExtensionDataSource	Definice toho, která data se budou shromažďovat z samostatného rozšíření virtuálního počítače, které se integruje s agentem služby Azure Monitor Shromažďuje se z počítačů s Windows a Linuxem v závislosti na tom, které rozšíření je definované.
Identity	Identita spravované služby prostředku
IisLogsDataSource	Umožňuje shromažďování protokolů služby IIS tímto pravidlem shromažďování dat.
KnownAgentSettingName	Název nastavení. Musí být součástí seznamu podporovaných nastavení.
KnownColumnDefinitionType	Typ dat sloupce.
KnownDataCollectionRuleProvisioningState	Stav zřizování prostředků.
KnownDataCollectionRuleResourceKind	Druh prostředku.
KnownDataFlowStreams	Seznam datových proudů pro tento tok dat
KnownExtensionDataSourceStreams	Seznam datových proudů, na které bude tento zdroj dat odeslán. Datový proud označuje, do jakého schématu se pro tato data použije a do jaké tabulky se data v Log Analytics posílají.
KnownLogFilesDataSourceFormat	Formát dat souborů protokolu
KnownLogFileTextSettingsRecordStartTimestampFormat	Jeden z podporovaných formátů časového razítka
KnownPerfCounterDataSourceStreams	Seznam datových proudů, na které bude tento zdroj dat odeslán. Datový proud označuje, do jakého schématu se pro tato data použije a do jaké tabulky se data v Log Analytics posílají.
KnownPrometheusForwarderDataSourceStreams	Seznam datových proudů, na které bude tento zdroj dat odeslán.
KnownStorageBlobLookupType	Typ vyhledávání, který se má provést s objektem blob
KnownSyslogDataSourceFacilityNames	Seznam názvů zařízení.
KnownSyslogDataSourceLogLevels	Úrovně protokolů, které se mají shromažďovat.
KnownSyslogDataSourceStreams	Seznam datových proudů, na které bude tento zdroj dat odeslán. Datový proud označuje, do jakého schématu se pro tato data použije a do jaké tabulky se data v Log Analytics posílají.
KnownWindowsEventLogDataSourceStreams	Seznam datových proudů, na které bude tento zdroj dat odeslán. Datový proud označuje, do jakého schématu se pro tato data použije a do jaké tabulky se data v Log Analytics posílají.
KnownWindowsFirewallLogsDataSourceProfileFilter	Filtr profilu protokolů brány firewall
LogAnalyticsDestination	Cíl Log Analytics
LogFilesDataSource	Definice, které vlastní soubory protokolu budou shromážděny tímto pravidlem shromažďování dat
ManagedServiceIdentityType	Typ identity spravované služby (kde jsou povolené typy SystemAssigned i UserAssigned).
Metadata	Metadata o prostředku
MicrosoftFabricDestination	Cíl Microsoft Fabric (mimo Azure).
MonitoringAccountDestination	Monitorování cíle účtu
PerfCounterDataSource	Definice, které čítače výkonu se budou shromažďovat a jak budou shromážděny tímto pravidlem shromažďování dat. Shromažďuje se z počítačů s Windows i Linuxem, kde je čítač.
PlatformTelemetryDataSource	Definice konfigurace zdroje dat telemetrie platformy
PrometheusForwarderDataSource	Definice konfigurace předávání metrik Prometheus
References	Definuje všechny odkazy, které lze použít v jiných částech DCR.
Settings	Nastavení specifické pro soubory protokolu.
StorageBlob
StorageBlobDestination
StorageTableDestination
StreamDeclaration	Deklarace vlastního datového proudu
SyslogDataSource	Definice toho, která data syslogu se budou shromažďovat a jak se budou shromažďovat. Shromažďuje se jenom z počítačů s Linuxem.
SystemData	Metadata týkající se vytvoření a poslední změny prostředku.
Text	Nastavení textu
UserAssignedIdentity	Vlastnosti identity přiřazené uživatelem
WindowsEventLogDataSource	Definice, které události protokolu událostí systému Windows se budou shromažďovat a jak se budou shromažďovat. Shromažďuje se jenom z počítačů s Windows.
WindowsFirewallLogsDataSource	Umožňuje shromažďování protokolů brány firewall tímto pravidlem shromažďování dat.

AdxDestination

Objekt

Cíl Azure Data Exploreru (Adx).

Name	Typ	Description
databaseName	string	Název databáze, do které se budou data ingestovat.
ingestionUri	string	Identifikátor URI příjmu dat prostředku Adx.
name	string	Popisný název cíle. Tento název by měl být jedinečný pro všechny cíle (bez ohledu na typ) v rámci pravidla shromažďování dat.
resourceId	string	ID prostředku ARM prostředku Adx.

AgentSetting

Objekt

Nastavení sloužící k řízení chování agenta na hostitelském počítači

Name	Typ	Description
name	KnownAgentSettingName	Název nastavení. Musí být součástí seznamu podporovaných nastavení.
value	string	Hodnota nastavení

AgentSettings

Objekt

Nastavení agenta sloužící k úpravě chování agenta na daném hostiteli

Name	Typ	Description
logs	AgentSetting[]	Všechna nastavení, která platí pro agenta protokolů (AMA)

AzureMonitorMetrics

Objekt

Cíl metrik služby Azure Monitor.

Name	Typ	Description
name	string	Popisný název cíle. Tento název by měl být jedinečný pro všechny cíle (bez ohledu na typ) v rámci pravidla shromažďování dat.

ColumnDefinition

Objekt

Definice vlastního sloupce dat

Name	Typ	Description
name	string	Název sloupce.
type	KnownColumnDefinitionType	Typ dat sloupce.

createdByType

Výčet

Typ identity, která prostředek vytvořila.

Hodnota	Description
User
Application
ManagedIdentity
Key

DataCollectionRuleResource

Objekt

Definice prostředku nejvyšší úrovně sledovaného ARM

Name	Typ	Description
etag	string	Značka entity prostředku (ETag).
id	string	Plně kvalifikované ID prostředku.
identity	Identity	Identita spravované služby prostředku
kind	KnownDataCollectionRuleResourceKind	Druh prostředku.
location	string	Geografické umístění, ve kterém se nachází zdroj.
name	string	Název prostředku.
properties.agentSettings	AgentSettings	Nastavení agenta sloužící k úpravě chování agenta na daném hostiteli
properties.dataCollectionEndpointId	string	ID prostředku koncového bodu shromažďování dat, se kterým se toto pravidlo dá použít.
properties.dataFlows	DataFlow[]	Specifikace toků dat.
properties.dataSources	DataSources	Specifikace zdrojů dat. Tato vlastnost je volitelná a je možné ji vynechat, pokud je pravidlo určené k použití prostřednictvím přímých volání zřízeného koncového bodu.
properties.description	string	Popis pravidla shromažďování dat
properties.destinations	Destinations	Specifikace cílů.
properties.endpoints	Endpoints	Definuje koncové body příjmu dat, do které se mají odesílat data prostřednictvím tohoto pravidla.
properties.immutableId	string	Neměnné ID tohoto pravidla shromažďování dat. Tato vlastnost je jen pro čtení.
properties.metadata	Metadata	Metadata o prostředku
properties.provisioningState	KnownDataCollectionRuleProvisioningState	Stav zřizování prostředků.
properties.references	References	Definuje všechny odkazy, které lze použít v jiných částech DCR.
properties.streamDeclarations	<string,  StreamDeclaration>	Deklarace vlastních datových proudů používaných v tomto pravidle
systemData	SystemData	Metadata týkající se vytvoření a poslední změny prostředku.
tags	object	Značky prostředků
type	string	Typ prostředku.

DataFlow

Objekt

Definice, které datové proudy se odesílají do kterých cílů.

Name	Typ	Description
builtInTransform	string	Integrovaná transformace pro transformaci streamovaných dat
captureOverflow	boolean	Příznak pro povolení sloupce přetečení v cílech LA
destinations	string[]	Seznam cílů pro tento tok dat
outputStream	string	Výstupní datový proud transformace. Vyžaduje se pouze v případě, že transformace změní data na jiný datový proud.
streams	KnownDataFlowStreams[]	Seznam datových proudů pro tento tok dat
transformKql	string	Dotaz KQL pro transformaci dat datového proudu.

DataImports

Objekt

Specifikace zdrojů dat založených na vyžádání

Name	Typ	Description
eventHub	EventHub	Definice konfigurace centra událostí

DataSources

Objekt

Specifikace zdrojů dat. Tato vlastnost je volitelná a je možné ji vynechat, pokud je pravidlo určené k použití prostřednictvím přímých volání zřízeného koncového bodu.

Name	Typ	Description
dataImports	DataImports	Specifikace zdrojů dat založených na vyžádání
extensions	ExtensionDataSource[]	Seznam konfigurací zdrojů dat rozšíření virtuálního počítače Azure
iisLogs	IisLogsDataSource[]	Seznam zdrojových konfigurací protokolů služby IIS.
logFiles	LogFilesDataSource[]	Seznam zdrojových konfigurací souborů protokolu.
performanceCounters	PerfCounterDataSource[]	Seznam konfigurací zdrojů dat čítače výkonu.
platformTelemetry	PlatformTelemetryDataSource[]	Seznam konfigurací telemetrie platformy
prometheusForwarder	PrometheusForwarderDataSource[]	Seznam konfigurací zdrojů dat pro předávání Prometheus
syslog	SyslogDataSource[]	Seznam konfigurací zdrojů dat Syslog.
windowsEventLogs	WindowsEventLogDataSource[]	Seznam konfigurací zdrojů dat protokolu událostí systému Windows.
windowsFirewallLogs	WindowsFirewallLogsDataSource[]	Seznam zdrojových konfigurací brány Windows Firewall.

Destinations

Objekt

Specifikace cílů.

Name	Typ	Description
azureDataExplorer	AdxDestination[]	Seznam cílů Azure Data Exploreru
azureMonitorMetrics	AzureMonitorMetrics	Cíl metrik služby Azure Monitor.
eventHubs	EventHubDestination[]	Seznam cílů služby Event Hubs
eventHubsDirect	EventHubDirectDestination[]	Seznam přímých cílů služby Event Hubs
logAnalytics	LogAnalyticsDestination[]	Seznam cílů Log Analytics
microsoftFabric	MicrosoftFabricDestination[]	Seznam cílů Microsoft Fabric
monitoringAccounts	MonitoringAccountDestination[]	Seznam cílů monitorování účtů
storageAccounts	StorageBlobDestination[]	Seznam cílů účtů úložiště
storageBlobsDirect	StorageBlobDestination[]	Seznam cílů s přímým přístupem k objektům blob úložiště Použít pouze pro odesílání dat přímo do úložiště z agenta.
storageTablesDirect	StorageTableDestination[]	Seznam cílů s přímým přístupem k tabulce úložiště

Endpoints

Objekt

Definuje koncové body příjmu dat, do které se mají odesílat data prostřednictvím tohoto pravidla.

Name	Typ	Description
logsIngestion	string	Koncový bod příjmu dat pro protokoly
metricsIngestion	string	Koncový bod příjmu dat pro metriky

EnrichmentData

Objekt

Všechny zdroje dat rozšiřování, na které odkazují toky dat

Name	Typ	Description
storageBlobs	StorageBlob[]	Všechny objekty blob úložiště používané jako zdroje dat rozšiřování

ErrorAdditionalInfo

Objekt

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorDetail

Objekt

Podrobnosti o chybě.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorResponseCommonV2

Objekt

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

EventHub

Objekt

Definice konfigurace centra událostí

Name	Typ	Description
consumerGroup	string	Název skupiny příjemců centra událostí
name	string	Popisný název zdroje dat Tento název by měl být jedinečný pro všechny zdroje dat (bez ohledu na typ) v pravidle shromažďování dat.
stream	string	Datový proud, který se má shromažďovat z EventHubu

EventHubDestination

Objekt

Name	Typ	Description
eventHubResourceId	string	ID prostředku centra událostí.
name	string	Popisný název cíle. Tento název by měl být jedinečný pro všechny cíle (bez ohledu na typ) v rámci pravidla shromažďování dat.

EventHubDirectDestination

Objekt

Name	Typ	Description
eventHubResourceId	string	ID prostředku centra událostí.
name	string	Popisný název cíle. Tento název by měl být jedinečný pro všechny cíle (bez ohledu na typ) v rámci pravidla shromažďování dat.

ExtensionDataSource

Objekt

Definice toho, která data se budou shromažďovat z samostatného rozšíření virtuálního počítače, které se integruje s agentem služby Azure Monitor Shromažďuje se z počítačů s Windows a Linuxem v závislosti na tom, které rozšíření je definované.

Name	Typ	Description
extensionName	string	Název rozšíření virtuálního počítače
extensionSettings	object	Nastavení rozšíření. Formát je specifický pro konkrétní rozšíření.
inputDataSources	string[]	Seznam zdrojů dat, ze které toto rozšíření potřebuje data.
name	string	Popisný název zdroje dat Tento název by měl být jedinečný pro všechny zdroje dat (bez ohledu na typ) v pravidle shromažďování dat.
streams	KnownExtensionDataSourceStreams[]	Seznam datových proudů, na které bude tento zdroj dat odeslán. Datový proud označuje, do jakého schématu se pro tato data použije a do jaké tabulky se data v Log Analytics posílají.

Identity

Objekt

Identita spravované služby prostředku

Name	Typ	Description
principalId	string (uuid)	ID instančního objektu identity přiřazené systémem. Tato vlastnost bude poskytována pouze pro identitu přiřazenou systémem.
tenantId	string (uuid)	ID tenanta přiřazené identity systému. Tato vlastnost bude poskytována pouze pro identitu přiřazenou systémem.
type	ManagedServiceIdentityType	Typ identity spravované služby (kde jsou povolené typy SystemAssigned i UserAssigned).
userAssignedIdentities	<string,  UserAssignedIdentity>	identity User-Assigned Sada identit přiřazených uživatelem přidružená k prostředku. Klíče slovníku userAssignedIdentities budou ID prostředků ARM ve formuláři: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Hodnoty slovníku můžou být prázdné objekty ({}) v požadavcích.

IisLogsDataSource

Objekt

Umožňuje shromažďování protokolů služby IIS tímto pravidlem shromažďování dat.

Name	Typ	Description
logDirectories	string[]	Absolutní umístění souboru cest
name	string	Popisný název zdroje dat Tento název by měl být jedinečný pro všechny zdroje dat (bez ohledu na typ) v pravidle shromažďování dat.
streams	string[]	Streamy služby IIS
transformKql	string	Dotaz KQL pro transformaci zdroje dat.

KnownAgentSettingName

Výčet

Název nastavení. Musí být součástí seznamu podporovaných nastavení.

Hodnota	Description
MaxDiskQuotaInMB
UseTimeReceivedForForwardedEvents

KnownColumnDefinitionType

Výčet

Typ dat sloupce.

Hodnota	Description
string
int
long
real
boolean
datetime
dynamic

KnownDataCollectionRuleProvisioningState

Výčet

Stav zřizování prostředků.

Hodnota	Description
Creating
Updating
Deleting
Succeeded
Canceled
Failed

KnownDataCollectionRuleResourceKind

Výčet

Druh prostředku.

Hodnota	Description
Linux
Windows

KnownDataFlowStreams

Výčet

Seznam datových proudů pro tento tok dat

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

KnownExtensionDataSourceStreams

Výčet

Seznam datových proudů, na které bude tento zdroj dat odeslán. Datový proud označuje, do jakého schématu se pro tato data použije a do jaké tabulky se data v Log Analytics posílají.

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

KnownLogFilesDataSourceFormat

Výčet

Formát dat souborů protokolu

Hodnota	Description
json
text

KnownLogFileTextSettingsRecordStartTimestampFormat

Výčet

Jeden z podporovaných formátů časového razítka

Hodnota	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

Výčet

Seznam datových proudů, na které bude tento zdroj dat odeslán. Datový proud označuje, do jakého schématu se pro tato data použije a do jaké tabulky se data v Log Analytics posílají.

Hodnota	Description
Microsoft-Perf
Microsoft-InsightsMetrics

KnownPrometheusForwarderDataSourceStreams

Výčet

Seznam datových proudů, na které bude tento zdroj dat odeslán.

Hodnota	Description
Microsoft-PrometheusMetrics

KnownStorageBlobLookupType

Výčet

Typ vyhledávání, který se má provést s objektem blob

Hodnota	Description
String
Cidr

KnownSyslogDataSourceFacilityNames

Výčet

Seznam názvů zařízení.

Hodnota	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

Výčet

Úrovně protokolů, které se mají shromažďovat.

Hodnota	Description
Debug
Info
Notice
Warning
Error
Critical
Alert
Emergency
*

KnownSyslogDataSourceStreams

Výčet

Seznam datových proudů, na které bude tento zdroj dat odeslán. Datový proud označuje, do jakého schématu se pro tato data použije a do jaké tabulky se data v Log Analytics posílají.

Hodnota	Description
Microsoft-Syslog

KnownWindowsEventLogDataSourceStreams

Výčet

Seznam datových proudů, na které bude tento zdroj dat odeslán. Datový proud označuje, do jakého schématu se pro tato data použije a do jaké tabulky se data v Log Analytics posílají.

Hodnota	Description
Microsoft-WindowsEvent
Microsoft-Event

KnownWindowsFirewallLogsDataSourceProfileFilter

Výčet

Filtr profilu protokolů brány firewall

Hodnota	Description
Domain
Private
Public

LogAnalyticsDestination

Objekt

Cíl Log Analytics

Name	Typ	Description
name	string	Popisný název cíle. Tento název by měl být jedinečný pro všechny cíle (bez ohledu na typ) v rámci pravidla shromažďování dat.
workspaceId	string	ID zákazníka pracovního prostoru služby Log Analytics.
workspaceResourceId	string	ID prostředku pracovního prostoru služby Log Analytics.

LogFilesDataSource

Objekt

Definice, které vlastní soubory protokolu budou shromážděny tímto pravidlem shromažďování dat

Name	Typ	Description
filePatterns	string[]	Vzory souborů, ve kterých se nacházejí soubory protokolu
format	KnownLogFilesDataSourceFormat	Formát dat souborů protokolu
name	string	Popisný název zdroje dat Tento název by měl být jedinečný pro všechny zdroje dat (bez ohledu na typ) v pravidle shromažďování dat.
settings	Settings	Nastavení specifické pro soubory protokolu.
streams	string[]	Seznam datových proudů, na které bude tento zdroj dat odeslán. Datový proud označuje, jaké schéma se použije pro tento zdroj dat.
transformKql	string	Dotaz KQL pro transformaci zdroje dat.

ManagedServiceIdentityType

Výčet

Typ identity spravované služby (kde jsou povolené typy SystemAssigned i UserAssigned).

Hodnota	Description
None
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned

Metadata

Objekt

Metadata o prostředku

Name	Typ	Description
provisionedBy	string	Azure nabízí správu tohoto prostředku jménem zákazníka.
provisionedByImmutableId	string	Neměnné ID nabídky Azure, která spravuje tento prostředek jménem zákazníka.
provisionedByResourceId	string	ID prostředku azure nabízejícího správu tohoto prostředku jménem zákazníka

MicrosoftFabricDestination

Objekt

Cíl Microsoft Fabric (mimo Azure).

Name	Typ	Description
artifactId	string	ID artefaktu prostředku Microsoft Fabric.
databaseName	string	Název databáze, do které se budou data ingestovat.
ingestionUri	string	Identifikátor URI příjmu dat prostředku Microsoft Fabric.
name	string	Popisný název cíle. Tento název by měl být jedinečný pro všechny cíle (bez ohledu na typ) v rámci pravidla shromažďování dat.
tenantId	string	ID tenanta prostředku Microsoft Fabric.

MonitoringAccountDestination

Objekt

Monitorování cíle účtu

Name	Typ	Description
accountId	string	Neměnné ID účtu.
accountResourceId	string	ID prostředku účtu monitorování.
name	string	Popisný název cíle. Tento název by měl být jedinečný pro všechny cíle (bez ohledu na typ) v rámci pravidla shromažďování dat.

PerfCounterDataSource

Objekt

Definice, které čítače výkonu se budou shromažďovat a jak budou shromážděny tímto pravidlem shromažďování dat. Shromažďuje se z počítačů s Windows i Linuxem, kde je čítač.

Name	Typ	Description
counterSpecifiers	string[]	Seznam názvů specifikátorů čítačů výkonu, které chcete shromáždit. K shromáždění čítače pro všechny instance použijte zástupný znak (*). Pokud chcete získat seznam čítačů výkonu ve Windows, spusťte příkaz typeperf.
name	string	Popisný název zdroje dat Tento název by měl být jedinečný pro všechny zdroje dat (bez ohledu na typ) v pravidle shromažďování dat.
samplingFrequencyInSeconds	integer (int32)	Počet sekund mezi po sobě jdoucími měřeními čítače (vzorky).
streams	KnownPerfCounterDataSourceStreams[]	Seznam datových proudů, na které bude tento zdroj dat odeslán. Datový proud označuje, do jakého schématu se pro tato data použije a do jaké tabulky se data v Log Analytics posílají.
transformKql	string	Dotaz KQL pro transformaci zdroje dat.

PlatformTelemetryDataSource

Objekt

Definice konfigurace zdroje dat telemetrie platformy

Name	Typ	Description
name	string	Popisný název zdroje dat Tento název by měl být jedinečný pro všechny zdroje dat (bez ohledu na typ) v pravidle shromažďování dat.
streams	string[]	Seznam streamů telemetrie platformy, které se mají shromažďovat

PrometheusForwarderDataSource

Objekt

Definice konfigurace předávání metrik Prometheus

Name	Typ	Description
labelIncludeFilter	object	Seznam filtrů zahrnutí popisků ve formě párů name-value V současné době je podporován pouze jeden popisek: "microsoft_metrics_include_label". Hodnoty popisků se nerozlišují malá a velká písmena.
name	string	Popisný název zdroje dat Tento název by měl být jedinečný pro všechny zdroje dat (bez ohledu na typ) v pravidle shromažďování dat.
streams	KnownPrometheusForwarderDataSourceStreams[]	Seznam datových proudů, na které bude tento zdroj dat odeslán.

References

Objekt

Definuje všechny odkazy, které lze použít v jiných částech DCR.

Name	Typ	Description
enrichmentData	EnrichmentData	Všechny zdroje dat rozšiřování, na které odkazují toky dat

Settings

Objekt

Nastavení specifické pro soubory protokolu.

Name	Typ	Description
text	Text	Nastavení textu

StorageBlob

Objekt

Name	Typ	Description
blobUrl	string	Adresa URL objektu blob úložiště
lookupType	KnownStorageBlobLookupType	Typ vyhledávání, který se má provést s objektem blob
name	string	Název zdroje dat rozšiřování, který se používá jako alias při odkazování na tento zdroj dat v tocích dat
resourceId	string	ID prostředku účtu úložiště, který je hostitelem objektu blob

StorageBlobDestination

Objekt

Name	Typ	Description
containerName	string	Název kontejneru objektu blob služby Storage.
name	string	Popisný název cíle. Tento název by měl být jedinečný pro všechny cíle (bez ohledu na typ) v rámci pravidla shromažďování dat.
storageAccountResourceId	string	ID prostředku účtu úložiště.

StorageTableDestination

Objekt

Name	Typ	Description
name	string	Popisný název cíle. Tento název by měl být jedinečný pro všechny cíle (bez ohledu na typ) v rámci pravidla shromažďování dat.
storageAccountResourceId	string	ID prostředku účtu úložiště.
tableName	string	Název tabulky úložiště.

StreamDeclaration

Objekt

Deklarace vlastního datového proudu

Name	Typ	Description
columns	ColumnDefinition[]	Seznam sloupců používaných daty v tomto datovém proudu

SyslogDataSource

Objekt

Definice toho, která data syslogu se budou shromažďovat a jak se budou shromažďovat. Shromažďuje se jenom z počítačů s Linuxem.

Name	Typ	Description
facilityNames	KnownSyslogDataSourceFacilityNames[]	Seznam názvů zařízení.
logLevels	KnownSyslogDataSourceLogLevels[]	Úrovně protokolů, které se mají shromažďovat.
name	string	Popisný název zdroje dat Tento název by měl být jedinečný pro všechny zdroje dat (bez ohledu na typ) v pravidle shromažďování dat.
streams	KnownSyslogDataSourceStreams[]	Seznam datových proudů, na které bude tento zdroj dat odeslán. Datový proud označuje, do jakého schématu se pro tato data použije a do jaké tabulky se data v Log Analytics posílají.
transformKql	string	Dotaz KQL pro transformaci zdroje dat.

SystemData

Objekt

Metadata týkající se vytvoření a poslední změny prostředku.

Name	Typ	Description
createdAt	string (date-time)	Časové razítko vytvoření prostředku (UTC).
createdBy	string	Identita, která prostředek vytvořila.
createdByType	createdByType	Typ identity, která prostředek vytvořila.
lastModifiedAt	string (date-time)	Časové razítko poslední změny zdroje (UTC)
lastModifiedBy	string	Identita, která naposledy změnila prostředek.
lastModifiedByType	createdByType	Typ identity, která naposledy změnila prostředek.

Text

Objekt

Nastavení textu

Name	Typ	Description
recordStartTimestampFormat	KnownLogFileTextSettingsRecordStartTimestampFormat	Jeden z podporovaných formátů časového razítka

UserAssignedIdentity

Objekt

Vlastnosti identity přiřazené uživatelem

Name	Typ	Description
clientId	string (uuid)	ID klienta přiřazené identity.
principalId	string (uuid)	ID objektu zabezpečení přiřazené identity.

WindowsEventLogDataSource

Objekt

Definice, které události protokolu událostí systému Windows se budou shromažďovat a jak se budou shromažďovat. Shromažďuje se jenom z počítačů s Windows.

Name	Typ	Description
name	string	Popisný název zdroje dat Tento název by měl být jedinečný pro všechny zdroje dat (bez ohledu na typ) v pravidle shromažďování dat.
streams	KnownWindowsEventLogDataSourceStreams[]	Seznam datových proudů, na které bude tento zdroj dat odeslán. Datový proud označuje, do jakého schématu se pro tato data použije a do jaké tabulky se data v Log Analytics posílají.
transformKql	string	Dotaz KQL pro transformaci zdroje dat.
xPathQueries	string[]	Seznam dotazů protokolu událostí systému Windows ve formátu XPATH.

WindowsFirewallLogsDataSource

Objekt

Umožňuje shromažďování protokolů brány firewall tímto pravidlem shromažďování dat.

Name	Typ	Description
name	string	Popisný název zdroje dat Tento název by měl být jedinečný pro všechny zdroje dat (bez ohledu na typ) v pravidle shromažďování dat.
profileFilter	KnownWindowsFirewallLogsDataSourceProfileFilter[]	Filtr profilu protokolů brány firewall
streams	string[]	Streamy protokolů brány firewall