Data Collection Rules - Create

Usługa:

Monitor

Wersja interfejsu API:

2023-03-11

Tworzy lub aktualizuje regułę zbierania danych.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
dataCollectionRuleName	path	True	string	Nazwa reguły zbierania danych. Nazwa jest niewrażliwa na wielkość liter.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
subscriptionId	path	True	string minLength: 1	Identyfikator subskrypcji docelowej.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.

Treść żądania

Nazwa	Wymagane	Typ	Opis
location	True	string	Lokalizacja geograficzna, w której znajduje się zasób.
identity		Identity	Tożsamość usługi zarządzanej zasobu.
kind		KnownDataCollectionRuleResourceKind	Rodzaj zasobu.
properties.agentSettings		AgentSettings	Ustawienia agenta używane do modyfikowania zachowania agenta na danym hoście
properties.dataCollectionEndpointId		string	Identyfikator zasobu punktu końcowego zbierania danych, z którego można użyć tej reguły.
properties.dataFlows		DataFlow[]	Specyfikacja przepływów danych.
properties.dataSources		DataSources	Specyfikacja źródeł danych. Ta właściwość jest opcjonalna i może zostać pominięta, jeśli reguła ma być używana za pośrednictwem wywołań bezpośrednich do aprowizowanego punktu końcowego.
properties.description		string	Opis reguły zbierania danych.
properties.destinations		Destinations	Specyfikacja miejsc docelowych.
properties.references		References	Definiuje wszystkie odwołania, które mogą być używane w innych sekcjach dcR
properties.streamDeclarations		<string,  StreamDeclaration>	Deklaracja strumieni niestandardowych używanych w tej regule.
tags		object	Tagi zasobów.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	DataCollectionRuleResource	Reguła zbierania danych została pomyślnie zaktualizowana
201 Created	DataCollectionRuleResource	Reguła zbierania danych została pomyślnie utworzona
Other Status Codes	ErrorResponseCommonV2	Błąd

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

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

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:

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

Kod stanu:

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

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:

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

Kod stanu:

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

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:

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

Kod stanu:

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

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:

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

Kod stanu:

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

Definicje

Nazwa	Opis
AdxDestination	Miejsce docelowe usługi Azure Data Explorer (Adx).
AgentSetting	Ustawienie używane do kontrolowania zachowania agenta na maszynie hosta
AgentSettings	Ustawienia agenta używane do modyfikowania zachowania agenta na danym hoście
AzureMonitorMetrics	Miejsce docelowe metryk usługi Azure Monitor.
ColumnDefinition	Definicja niestandardowej kolumny danych.
createdByType	Typ tożsamości, która utworzyła zasób.
DataCollectionRuleResource	Definicja śledzonego zasobu najwyższego poziomu usługi ARM.
DataFlow	Definicja strumieni, do których lokalizacji docelowych są wysyłane strumienie.
DataImports	Specyfikacje źródeł danych opartych na ściąganiu
DataSources	Specyfikacja źródeł danych. Ta właściwość jest opcjonalna i może zostać pominięta, jeśli reguła ma być używana za pośrednictwem wywołań bezpośrednich do aprowizowanego punktu końcowego.
Destinations	Specyfikacja miejsc docelowych.
Endpoints	Definiuje punkty końcowe pozyskiwania do wysyłania danych za pośrednictwem tej reguły.
EnrichmentData	Wszystkie źródła danych wzbogacania, do których odwołuje się przepływy danych
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponseCommonV2	Odpowiedź na błąd
EventHub	Definicja konfiguracji centrum zdarzeń.
EventHubDestination
EventHubDirectDestination
ExtensionDataSource	Definicja danych, które będą zbierane z oddzielnego rozszerzenia maszyny wirtualnej zintegrowanego z agentem usługi Azure Monitor. Zbierane z komputerów z systemami Windows i Linux w zależności od tego, które rozszerzenie jest zdefiniowane.
Identity	Tożsamość usługi zarządzanej zasobu.
IisLogsDataSource	Umożliwia zbieranie dzienników usług IIS przez tę regułę zbierania danych.
KnownAgentSettingName	Nazwa ustawienia. Musi być częścią listy obsługiwanych ustawień
KnownColumnDefinitionType	Typ danych kolumny.
KnownDataCollectionRuleProvisioningState	Stan aprowizacji zasobu.
KnownDataCollectionRuleResourceKind	Rodzaj zasobu.
KnownDataFlowStreams	Lista strumieni dla tego przepływu danych.
KnownExtensionDataSourceStreams	Lista strumieni, do których zostanie wysłane to źródło danych. Strumień wskazuje, do jakiego schematu będą używane te dane, a zwykle do której tabeli w usłudze Log Analytics będą wysyłane dane.
KnownLogFilesDataSourceFormat	Format danych plików dziennika
KnownLogFileTextSettingsRecordStartTimestampFormat	Jeden z obsługiwanych formatów znacznika czasu
KnownPerfCounterDataSourceStreams	Lista strumieni, do których zostanie wysłane to źródło danych. Strumień wskazuje, do jakiego schematu będą używane te dane, a zwykle do której tabeli w usłudze Log Analytics będą wysyłane dane.
KnownPrometheusForwarderDataSourceStreams	Lista strumieni, do których zostanie wysłane to źródło danych.
KnownStorageBlobLookupType	Typ wyszukiwania do wykonania w obiekcie blob
KnownSyslogDataSourceFacilityNames	Lista nazw obiektów.
KnownSyslogDataSourceLogLevels	Poziomy dziennika do zebrania.
KnownSyslogDataSourceStreams	Lista strumieni, do których zostanie wysłane to źródło danych. Strumień wskazuje, do jakiego schematu będą używane te dane, a zwykle do której tabeli w usłudze Log Analytics będą wysyłane dane.
KnownWindowsEventLogDataSourceStreams	Lista strumieni, do których zostanie wysłane to źródło danych. Strumień wskazuje, do jakiego schematu będą używane te dane, a zwykle do której tabeli w usłudze Log Analytics będą wysyłane dane.
KnownWindowsFirewallLogsDataSourceProfileFilter	Filtr profilu dzienników zapory
LogAnalyticsDestination	Miejsce docelowe usługi Log Analytics.
LogFilesDataSource	Definicja, które niestandardowe pliki dziennika będą zbierane przez tę regułę zbierania danych
ManagedServiceIdentityType	Typ tożsamości usługi zarządzanej (gdzie dozwolone są typy SystemAssigned i UserAssigned).
Metadata	Metadane dotyczące zasobu
MicrosoftFabricDestination	Miejsce docelowe usługi Microsoft Fabric (spoza platformy Azure).
MonitoringAccountDestination	Monitorowanie miejsca docelowego konta.
PerfCounterDataSource	Definicja liczników wydajności, które będą zbierane i jak będą zbierane przez tę regułę zbierania danych. Zbierane z maszyn z systemami Windows i Linux, na których znajduje się licznik.
PlatformTelemetryDataSource	Definicja konfiguracji źródła danych telemetrycznych platformy
PrometheusForwarderDataSource	Definicja konfiguracji przekazywania metryk rozwiązania Prometheus.
References	Definiuje wszystkie odwołania, które mogą być używane w innych sekcjach dcR
Settings	Określone ustawienia plików dziennika.
StorageBlob
StorageBlobDestination
StorageTableDestination
StreamDeclaration	Deklaracja strumienia niestandardowego.
SyslogDataSource	Definicja, które dane dziennika systemowego zostaną zebrane i jak zostaną zebrane. Zbierane tylko z maszyn z systemem Linux.
SystemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.
Text	Ustawienia tekstu
UserAssignedIdentity	Właściwości tożsamości przypisanej przez użytkownika
WindowsEventLogDataSource	Definicja, które zdarzenia dziennika zdarzeń systemu Windows zostaną zebrane i jak będą zbierane. Zbierane tylko z maszyn z systemem Windows.
WindowsFirewallLogsDataSource	Umożliwia zbieranie dzienników zapory przez tę regułę zbierania danych.

AdxDestination

Objekt

Miejsce docelowe usługi Azure Data Explorer (Adx).

Nazwa	Typ	Opis
databaseName	string	Nazwa bazy danych, do której będą pozyskiwane dane.
ingestionUri	string	Identyfikator URI pozyskiwania zasobu Adx.
name	string	Przyjazna nazwa miejsca docelowego. Ta nazwa powinna być unikatowa we wszystkich miejscach docelowych (niezależnie od typu) w regule zbierania danych.
resourceId	string	Identyfikator zasobu usługi ARM zasobu Adx.

AgentSetting

Objekt

Ustawienie używane do kontrolowania zachowania agenta na maszynie hosta

Nazwa	Typ	Opis
name	KnownAgentSettingName	Nazwa ustawienia. Musi być częścią listy obsługiwanych ustawień
value	string	Wartość ustawienia

AgentSettings

Objekt

Ustawienia agenta używane do modyfikowania zachowania agenta na danym hoście

Nazwa	Typ	Opis
logs	AgentSetting[]	Wszystkie ustawienia, które mają zastosowanie do agenta dzienników (AMA)

AzureMonitorMetrics

Objekt

Miejsce docelowe metryk usługi Azure Monitor.

Nazwa	Typ	Opis
name	string	Przyjazna nazwa miejsca docelowego. Ta nazwa powinna być unikatowa we wszystkich miejscach docelowych (niezależnie od typu) w regule zbierania danych.

ColumnDefinition

Objekt

Definicja niestandardowej kolumny danych.

Nazwa	Typ	Opis
name	string	Nazwa kolumny.
type	KnownColumnDefinitionType	Typ danych kolumny.

createdByType

Wyliczenie

Typ tożsamości, która utworzyła zasób.

Wartość	Opis
User
Application
ManagedIdentity
Key

DataCollectionRuleResource

Objekt

Definicja śledzonego zasobu najwyższego poziomu usługi ARM.

Nazwa	Typ	Opis
etag	string	Tag jednostki zasobu (ETag).
id	string	W pełni kwalifikowany identyfikator zasobu.
identity	Identity	Tożsamość usługi zarządzanej zasobu.
kind	KnownDataCollectionRuleResourceKind	Rodzaj zasobu.
location	string	Lokalizacja geograficzna, w której znajduje się zasób.
name	string	Nazwa zasobu.
properties.agentSettings	AgentSettings	Ustawienia agenta używane do modyfikowania zachowania agenta na danym hoście
properties.dataCollectionEndpointId	string	Identyfikator zasobu punktu końcowego zbierania danych, z którego można użyć tej reguły.
properties.dataFlows	DataFlow[]	Specyfikacja przepływów danych.
properties.dataSources	DataSources	Specyfikacja źródeł danych. Ta właściwość jest opcjonalna i może zostać pominięta, jeśli reguła ma być używana za pośrednictwem wywołań bezpośrednich do aprowizowanego punktu końcowego.
properties.description	string	Opis reguły zbierania danych.
properties.destinations	Destinations	Specyfikacja miejsc docelowych.
properties.endpoints	Endpoints	Definiuje punkty końcowe pozyskiwania do wysyłania danych za pośrednictwem tej reguły.
properties.immutableId	string	Niezmienny identyfikator tej reguły zbierania danych. Ta właściwość jest TYLKO DO ODCZYTU.
properties.metadata	Metadata	Metadane dotyczące zasobu
properties.provisioningState	KnownDataCollectionRuleProvisioningState	Stan aprowizacji zasobu.
properties.references	References	Definiuje wszystkie odwołania, które mogą być używane w innych sekcjach dcR
properties.streamDeclarations	<string,  StreamDeclaration>	Deklaracja strumieni niestandardowych używanych w tej regule.
systemData	SystemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.
tags	object	Tagi zasobów.
type	string	Typ zasobu.

DataFlow

Objekt

Definicja strumieni, do których lokalizacji docelowych są wysyłane strumienie.

Nazwa	Typ	Opis
builtInTransform	string	Przekształcenie builtIn w celu przekształcania danych strumienia
captureOverflow	boolean	Flaga umożliwiająca włączenie kolumny przepełnienia w miejscach docelowych la
destinations	string[]	Lista miejsc docelowych dla tego przepływu danych.
outputStream	string	Strumień wyjściowy przekształcenia. Wymagane tylko wtedy, gdy przekształcenie zmienia dane na inny strumień.
streams	KnownDataFlowStreams[]	Lista strumieni dla tego przepływu danych.
transformKql	string	Zapytanie KQL w celu przekształcenia danych strumienia.

DataImports

Objekt

Specyfikacje źródeł danych opartych na ściąganiu

Nazwa	Typ	Opis
eventHub	EventHub	Definicja konfiguracji centrum zdarzeń.

DataSources

Objekt

Specyfikacja źródeł danych. Ta właściwość jest opcjonalna i może zostać pominięta, jeśli reguła ma być używana za pośrednictwem wywołań bezpośrednich do aprowizowanego punktu końcowego.

Nazwa	Typ	Opis
dataImports	DataImports	Specyfikacje źródeł danych opartych na ściąganiu
extensions	ExtensionDataSource[]	Lista konfiguracji źródła danych rozszerzenia maszyny wirtualnej platformy Azure.
iisLogs	IisLogsDataSource[]	Lista konfiguracji źródła dzienników usług IIS.
logFiles	LogFilesDataSource[]	Lista konfiguracji źródłowych plików dziennika.
performanceCounters	PerfCounterDataSource[]	Lista konfiguracji źródła danych licznika wydajności.
platformTelemetry	PlatformTelemetryDataSource[]	Lista konfiguracji telemetrii platformy
prometheusForwarder	PrometheusForwarderDataSource[]	Lista konfiguracji źródła danych usługi przesyłania dalej Prometheus.
syslog	SyslogDataSource[]	Lista konfiguracji źródła danych syslog.
windowsEventLogs	WindowsEventLogDataSource[]	Lista konfiguracji źródła danych dziennika zdarzeń systemu Windows.
windowsFirewallLogs	WindowsFirewallLogsDataSource[]	Lista konfiguracji źródłowych dzienników zapory systemu Windows.

Destinations

Objekt

Specyfikacja miejsc docelowych.

Nazwa	Typ	Opis
azureDataExplorer	AdxDestination[]	Lista miejsc docelowych usługi Azure Data Explorer.
azureMonitorMetrics	AzureMonitorMetrics	Miejsce docelowe metryk usługi Azure Monitor.
eventHubs	EventHubDestination[]	Lista miejsc docelowych usługi Event Hubs.
eventHubsDirect	EventHubDirectDestination[]	Lista miejsc docelowych usługi Event Hubs Direct.
logAnalytics	LogAnalyticsDestination[]	Lista miejsc docelowych usługi Log Analytics.
microsoftFabric	MicrosoftFabricDestination[]	Lista miejsc docelowych usługi Microsoft Fabric.
monitoringAccounts	MonitoringAccountDestination[]	Lista miejsc docelowych kont monitorowania.
storageAccounts	StorageBlobDestination[]	Lista miejsc docelowych kont magazynu.
storageBlobsDirect	StorageBlobDestination[]	Lista miejsc docelowych bezpośrednich obiektów blob usługi Storage. Do użycia tylko do wysyłania danych bezpośrednio do przechowywania z agenta.
storageTablesDirect	StorageTableDestination[]	Lista miejsc docelowych bezpośrednich tabel magazynu.

Endpoints

Objekt

Definiuje punkty końcowe pozyskiwania do wysyłania danych za pośrednictwem tej reguły.

Nazwa	Typ	Opis
logsIngestion	string	Punkt końcowy pozyskiwania dzienników
metricsIngestion	string	Punkt końcowy pozyskiwania metryk

EnrichmentData

Objekt

Wszystkie źródła danych wzbogacania, do których odwołuje się przepływy danych

Nazwa	Typ	Opis
storageBlobs	StorageBlob[]	Wszystkie obiekty blob magazynu używane jako źródła danych wzbogacania

ErrorAdditionalInfo

Objekt

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Objekt

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponseCommonV2

Objekt

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

EventHub

Objekt

Definicja konfiguracji centrum zdarzeń.

Nazwa	Typ	Opis
consumerGroup	string	Nazwa grupy odbiorców centrum zdarzeń
name	string	Przyjazna nazwa źródła danych. Ta nazwa powinna być unikatowa we wszystkich źródłach danych (niezależnie od typu) w regule zbierania danych.
stream	string	Strumień do zbierania z usługi EventHub

EventHubDestination

Objekt

Nazwa	Typ	Opis
eventHubResourceId	string	Identyfikator zasobu centrum zdarzeń.
name	string	Przyjazna nazwa miejsca docelowego. Ta nazwa powinna być unikatowa we wszystkich miejscach docelowych (niezależnie od typu) w regule zbierania danych.

EventHubDirectDestination

Objekt

Nazwa	Typ	Opis
eventHubResourceId	string	Identyfikator zasobu centrum zdarzeń.
name	string	Przyjazna nazwa miejsca docelowego. Ta nazwa powinna być unikatowa we wszystkich miejscach docelowych (niezależnie od typu) w regule zbierania danych.

ExtensionDataSource

Objekt

Definicja danych, które będą zbierane z oddzielnego rozszerzenia maszyny wirtualnej zintegrowanego z agentem usługi Azure Monitor. Zbierane z komputerów z systemami Windows i Linux w zależności od tego, które rozszerzenie jest zdefiniowane.

Nazwa	Typ	Opis
extensionName	string	Nazwa rozszerzenia maszyny wirtualnej.
extensionSettings	object	Ustawienia rozszerzenia. Format jest specyficzny dla określonego rozszerzenia.
inputDataSources	string[]	Lista źródeł danych, z których to rozszerzenie wymaga danych.
name	string	Przyjazna nazwa źródła danych. Ta nazwa powinna być unikatowa we wszystkich źródłach danych (niezależnie od typu) w regule zbierania danych.
streams	KnownExtensionDataSourceStreams[]	Lista strumieni, do których zostanie wysłane to źródło danych. Strumień wskazuje, do jakiego schematu będą używane te dane, a zwykle do której tabeli w usłudze Log Analytics będą wysyłane dane.

Identity

Objekt

Tożsamość usługi zarządzanej zasobu.

Nazwa	Typ	Opis
principalId	string (uuid)	Identyfikator jednostki usługi tożsamości przypisanej przez system. Ta właściwość zostanie udostępniona tylko dla tożsamości przypisanej przez system.
tenantId	string (uuid)	Identyfikator dzierżawy tożsamości przypisanej przez system. Ta właściwość zostanie udostępniona tylko dla tożsamości przypisanej przez system.
type	ManagedServiceIdentityType	Typ tożsamości usługi zarządzanej (gdzie dozwolone są typy SystemAssigned i UserAssigned).
userAssignedIdentities	<string,  UserAssignedIdentity>	tożsamości User-Assigned Zestaw tożsamości przypisanych przez użytkownika skojarzonych z zasobem. Klucze słownika userAssignedIdentities będą identyfikatorami zasobów usługi ARM w postaci: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Wartości słownika mogą być pustymi obiektami ({}) w żądaniach.

IisLogsDataSource

Objekt

Umożliwia zbieranie dzienników usług IIS przez tę regułę zbierania danych.

Nazwa	Typ	Opis
logDirectories	string[]	Lokalizacja pliku ścieżek bezwzględnych
name	string	Przyjazna nazwa źródła danych. Ta nazwa powinna być unikatowa we wszystkich źródłach danych (niezależnie od typu) w regule zbierania danych.
streams	string[]	Strumienie usług IIS
transformKql	string	Zapytanie KQL w celu przekształcenia źródła danych.

KnownAgentSettingName

Wyliczenie

Nazwa ustawienia. Musi być częścią listy obsługiwanych ustawień

Wartość	Opis
MaxDiskQuotaInMB
UseTimeReceivedForForwardedEvents

KnownColumnDefinitionType

Wyliczenie

Typ danych kolumny.

Wartość	Opis
string
int
long
real
boolean
datetime
dynamic

KnownDataCollectionRuleProvisioningState

Wyliczenie

Stan aprowizacji zasobu.

Wartość	Opis
Creating
Updating
Deleting
Succeeded
Canceled
Failed

KnownDataCollectionRuleResourceKind

Wyliczenie

Rodzaj zasobu.

Wartość	Opis
Linux
Windows

KnownDataFlowStreams

Wyliczenie

Lista strumieni dla tego przepływu danych.

Wartość	Opis
Microsoft-Event
Microsoft-InsightsMetrics
Microsoft-Perf
Microsoft-Syslog
Microsoft-WindowsEvent

KnownExtensionDataSourceStreams

Wyliczenie

Lista strumieni, do których zostanie wysłane to źródło danych. Strumień wskazuje, do jakiego schematu będą używane te dane, a zwykle do której tabeli w usłudze Log Analytics będą wysyłane dane.

Wartość	Opis
Microsoft-Event
Microsoft-InsightsMetrics
Microsoft-Perf
Microsoft-Syslog
Microsoft-WindowsEvent

KnownLogFilesDataSourceFormat

Wyliczenie

Format danych plików dziennika

Wartość	Opis
json
text

KnownLogFileTextSettingsRecordStartTimestampFormat

Wyliczenie

Jeden z obsługiwanych formatów znacznika czasu

Wartość	Opis
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

Wyliczenie

Lista strumieni, do których zostanie wysłane to źródło danych. Strumień wskazuje, do jakiego schematu będą używane te dane, a zwykle do której tabeli w usłudze Log Analytics będą wysyłane dane.

Wartość	Opis
Microsoft-Perf
Microsoft-InsightsMetrics

KnownPrometheusForwarderDataSourceStreams

Wyliczenie

Lista strumieni, do których zostanie wysłane to źródło danych.

Wartość	Opis
Microsoft-PrometheusMetrics

KnownStorageBlobLookupType

Wyliczenie

Typ wyszukiwania do wykonania w obiekcie blob

Wartość	Opis
String
Cidr

KnownSyslogDataSourceFacilityNames

Wyliczenie

Lista nazw obiektów.

Wartość	Opis
*
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

Wyliczenie

Poziomy dziennika do zebrania.

Wartość	Opis
Debug
Info
Notice
Warning
Error
Critical
Alert
Emergency
*

KnownSyslogDataSourceStreams

Wyliczenie

Lista strumieni, do których zostanie wysłane to źródło danych. Strumień wskazuje, do jakiego schematu będą używane te dane, a zwykle do której tabeli w usłudze Log Analytics będą wysyłane dane.

Wartość	Opis
Microsoft-Syslog

KnownWindowsEventLogDataSourceStreams

Wyliczenie

Lista strumieni, do których zostanie wysłane to źródło danych. Strumień wskazuje, do jakiego schematu będą używane te dane, a zwykle do której tabeli w usłudze Log Analytics będą wysyłane dane.

Wartość	Opis
Microsoft-WindowsEvent
Microsoft-Event

KnownWindowsFirewallLogsDataSourceProfileFilter

Wyliczenie

Filtr profilu dzienników zapory

Wartość	Opis
Domain
Private
Public

LogAnalyticsDestination

Objekt

Miejsce docelowe usługi Log Analytics.

Nazwa	Typ	Opis
name	string	Przyjazna nazwa miejsca docelowego. Ta nazwa powinna być unikatowa we wszystkich miejscach docelowych (niezależnie od typu) w regule zbierania danych.
workspaceId	string	Identyfikator klienta obszaru roboczego usługi Log Analytics.
workspaceResourceId	string	Identyfikator zasobu obszaru roboczego usługi Log Analytics.

LogFilesDataSource

Objekt

Definicja, które niestandardowe pliki dziennika będą zbierane przez tę regułę zbierania danych

Nazwa	Typ	Opis
filePatterns	string[]	Wzorce plików, w których znajdują się pliki dziennika
format	KnownLogFilesDataSourceFormat	Format danych plików dziennika
name	string	Przyjazna nazwa źródła danych. Ta nazwa powinna być unikatowa we wszystkich źródłach danych (niezależnie od typu) w regule zbierania danych.
settings	Settings	Określone ustawienia plików dziennika.
streams	string[]	Lista strumieni, do których zostanie wysłane to źródło danych. Strumień wskazuje, jaki schemat będzie używany dla tego źródła danych
transformKql	string	Zapytanie KQL w celu przekształcenia źródła danych.

ManagedServiceIdentityType

Wyliczenie

Typ tożsamości usługi zarządzanej (gdzie dozwolone są typy SystemAssigned i UserAssigned).

Wartość	Opis
None
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned

Metadata

Objekt

Metadane dotyczące zasobu

Nazwa	Typ	Opis
provisionedBy	string	Platforma Azure oferuje zarządzanie tym zasobem w imieniu klienta.
provisionedByImmutableId	string	Niezmienny identyfikator oferty platformy Azure zarządzającej tym zasobem w imieniu klienta.
provisionedByResourceId	string	Identyfikator zasobu oferty platformy Azure do zarządzania tym zasobem w imieniu klienta.

MicrosoftFabricDestination

Objekt

Miejsce docelowe usługi Microsoft Fabric (spoza platformy Azure).

Nazwa	Typ	Opis
artifactId	string	Identyfikator artefaktu zasobu usługi Microsoft Fabric.
databaseName	string	Nazwa bazy danych, do której będą pozyskiwane dane.
ingestionUri	string	Identyfikator URI pozyskiwania zasobu usługi Microsoft Fabric.
name	string	Przyjazna nazwa miejsca docelowego. Ta nazwa powinna być unikatowa we wszystkich miejscach docelowych (niezależnie od typu) w regule zbierania danych.
tenantId	string	Identyfikator dzierżawy zasobu usługi Microsoft Fabric.

MonitoringAccountDestination

Objekt

Monitorowanie miejsca docelowego konta.

Nazwa	Typ	Opis
accountId	string	Niezmienny identyfikator konta.
accountResourceId	string	Identyfikator zasobu konta monitorowania.
name	string	Przyjazna nazwa miejsca docelowego. Ta nazwa powinna być unikatowa we wszystkich miejscach docelowych (niezależnie od typu) w regule zbierania danych.

PerfCounterDataSource

Objekt

Definicja liczników wydajności, które będą zbierane i jak będą zbierane przez tę regułę zbierania danych. Zbierane z maszyn z systemami Windows i Linux, na których znajduje się licznik.

Nazwa	Typ	Opis
counterSpecifiers	string[]	Lista nazw specyfikatorów liczników wydajności, które chcesz zebrać. Użyj symbolu wieloznakowego (*), aby zebrać licznik dla wszystkich wystąpień. Aby uzyskać listę liczników wydajności w systemie Windows, uruchom polecenie "typeperf".
name	string	Przyjazna nazwa źródła danych. Ta nazwa powinna być unikatowa we wszystkich źródłach danych (niezależnie od typu) w regule zbierania danych.
samplingFrequencyInSeconds	integer (int32)	Liczba sekund między kolejnymi pomiarami liczników (próbki).
streams	KnownPerfCounterDataSourceStreams[]	Lista strumieni, do których zostanie wysłane to źródło danych. Strumień wskazuje, do jakiego schematu będą używane te dane, a zwykle do której tabeli w usłudze Log Analytics będą wysyłane dane.
transformKql	string	Zapytanie KQL w celu przekształcenia źródła danych.

PlatformTelemetryDataSource

Objekt

Definicja konfiguracji źródła danych telemetrycznych platformy

Nazwa	Typ	Opis
name	string	Przyjazna nazwa źródła danych. Ta nazwa powinna być unikatowa we wszystkich źródłach danych (niezależnie od typu) w regule zbierania danych.
streams	string[]	Lista strumieni telemetrii platformy do zbierania

PrometheusForwarderDataSource

Objekt

Definicja konfiguracji przekazywania metryk rozwiązania Prometheus.

Nazwa	Typ	Opis
labelIncludeFilter	object	Lista filtrów dołączania etykiet w postaci par "name-value". Obecnie obsługiwana jest tylko jedna etykieta: "microsoft_metrics_include_label". Wartości etykiet są dopasowywane bez uwzględniania wielkości liter.
name	string	Przyjazna nazwa źródła danych. Ta nazwa powinna być unikatowa we wszystkich źródłach danych (niezależnie od typu) w regule zbierania danych.
streams	KnownPrometheusForwarderDataSourceStreams[]	Lista strumieni, do których zostanie wysłane to źródło danych.

References

Objekt

Definiuje wszystkie odwołania, które mogą być używane w innych sekcjach dcR

Nazwa	Typ	Opis
enrichmentData	EnrichmentData	Wszystkie źródła danych wzbogacania, do których odwołuje się przepływy danych

Settings

Objekt

Określone ustawienia plików dziennika.

Nazwa	Typ	Opis
text	Text	Ustawienia tekstu

StorageBlob

Objekt

Nazwa	Typ	Opis
blobUrl	string	Adres URL obiektu blob magazynu
lookupType	KnownStorageBlobLookupType	Typ wyszukiwania do wykonania w obiekcie blob
name	string	Nazwa źródła danych wzbogacania używanego jako alias podczas odwoływania się do tego źródła danych w przepływach danych
resourceId	string	Identyfikator zasobu konta magazynu hostujący obiekt blob

StorageBlobDestination

Objekt

Nazwa	Typ	Opis
containerName	string	Nazwa kontenera obiektu blob usługi Storage.
name	string	Przyjazna nazwa miejsca docelowego. Ta nazwa powinna być unikatowa we wszystkich miejscach docelowych (niezależnie od typu) w regule zbierania danych.
storageAccountResourceId	string	Identyfikator zasobu konta magazynu.

StorageTableDestination

Objekt

Nazwa	Typ	Opis
name	string	Przyjazna nazwa miejsca docelowego. Ta nazwa powinna być unikatowa we wszystkich miejscach docelowych (niezależnie od typu) w regule zbierania danych.
storageAccountResourceId	string	Identyfikator zasobu konta magazynu.
tableName	string	Nazwa tabeli magazynu.

StreamDeclaration

Objekt

Deklaracja strumienia niestandardowego.

Nazwa	Typ	Opis
columns	ColumnDefinition[]	Lista kolumn używanych przez dane w tym strumieniu.

SyslogDataSource

Objekt

Definicja, które dane dziennika systemowego zostaną zebrane i jak zostaną zebrane. Zbierane tylko z maszyn z systemem Linux.

Nazwa	Typ	Opis
facilityNames	KnownSyslogDataSourceFacilityNames[]	Lista nazw obiektów.
logLevels	KnownSyslogDataSourceLogLevels[]	Poziomy dziennika do zebrania.
name	string	Przyjazna nazwa źródła danych. Ta nazwa powinna być unikatowa we wszystkich źródłach danych (niezależnie od typu) w regule zbierania danych.
streams	KnownSyslogDataSourceStreams[]	Lista strumieni, do których zostanie wysłane to źródło danych. Strumień wskazuje, do jakiego schematu będą używane te dane, a zwykle do której tabeli w usłudze Log Analytics będą wysyłane dane.
transformKql	string	Zapytanie KQL w celu przekształcenia źródła danych.

SystemData

Objekt

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string (date-time)	Sygnatura czasowa tworzenia zasobu (UTC).
createdBy	string	Tożsamość, która utworzyła zasób.
createdByType	createdByType	Typ tożsamości, która utworzyła zasób.
lastModifiedAt	string (date-time)	Znacznik czasu ostatniej modyfikacji zasobu (UTC)
lastModifiedBy	string	Tożsamość, która ostatnio zmodyfikowała zasób.
lastModifiedByType	createdByType	Typ tożsamości, która ostatnio zmodyfikowała zasób.

Text

Objekt

Ustawienia tekstu

Nazwa	Typ	Opis
recordStartTimestampFormat	KnownLogFileTextSettingsRecordStartTimestampFormat	Jeden z obsługiwanych formatów znacznika czasu

UserAssignedIdentity

Objekt

Właściwości tożsamości przypisanej przez użytkownika

Nazwa	Typ	Opis
clientId	string (uuid)	Identyfikator klienta przypisanej tożsamości.
principalId	string (uuid)	Identyfikator podmiotu zabezpieczeń przypisanej tożsamości.

WindowsEventLogDataSource

Objekt

Definicja, które zdarzenia dziennika zdarzeń systemu Windows zostaną zebrane i jak będą zbierane. Zbierane tylko z maszyn z systemem Windows.

Nazwa	Typ	Opis
name	string	Przyjazna nazwa źródła danych. Ta nazwa powinna być unikatowa we wszystkich źródłach danych (niezależnie od typu) w regule zbierania danych.
streams	KnownWindowsEventLogDataSourceStreams[]	Lista strumieni, do których zostanie wysłane to źródło danych. Strumień wskazuje, do jakiego schematu będą używane te dane, a zwykle do której tabeli w usłudze Log Analytics będą wysyłane dane.
transformKql	string	Zapytanie KQL w celu przekształcenia źródła danych.
xPathQueries	string[]	Lista zapytań dziennika zdarzeń systemu Windows w formacie XPATH.

WindowsFirewallLogsDataSource

Objekt

Umożliwia zbieranie dzienników zapory przez tę regułę zbierania danych.

Nazwa	Typ	Opis
name	string	Przyjazna nazwa źródła danych. Ta nazwa powinna być unikatowa we wszystkich źródłach danych (niezależnie od typu) w regule zbierania danych.
profileFilter	KnownWindowsFirewallLogsDataSourceProfileFilter[]	Filtr profilu dzienników zapory
streams	string[]	Strumienie dzienników zapory