Data Collection Rules - Create

Hizmet:

Monitor

API Sürümü:

2023-03-11

Veri toplama kuralı oluşturur veya güncelleştirir.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
dataCollectionRuleName	path	True	string	Veri toplama kuralının adı. Ad büyük/küçük harfe duyarsız.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Kaynak grubunun adı. Ad büyük/küçük harfe duyarsız.
subscriptionId	path	True	string minLength: 1	Hedef aboneliğin kimliği.
api-version	query	True	string minLength: 1	Bu işlem için kullanılacak API sürümü.

İstek Gövdesi

Name	Gerekli	Tür	Description
location	True	string	Kaynağın bulunduğu coğrafi konum.
identity		Identity	Kaynağın yönetilen hizmet kimliği.
kind		KnownDataCollectionRuleResourceKind	Kaynağın türü.
properties.agentSettings		AgentSettings	Belirli bir konakta aracı davranışını değiştirmek için kullanılan aracı ayarları
properties.dataCollectionEndpointId		string	Bu kuralın birlikte kullanabildiği veri toplama uç noktasının kaynak kimliği.
properties.dataFlows		DataFlow[]	Veri akışlarının belirtimi.
properties.dataSources		DataSources	Veri kaynaklarının belirtimi. Bu özellik isteğe bağlıdır ve kuralın sağlanan uç noktaya doğrudan çağrılar yoluyla kullanılması amaçlanıyorsa atlanabilir.
properties.description		string	Veri toplama kuralının açıklaması.
properties.destinations		Destinations	Hedeflerin belirtimi.
properties.references		References	DCR'nin diğer bölümlerinde kullanılabilecek tüm başvuruları tanımlar
properties.streamDeclarations		<string,  StreamDeclaration>	Bu kuralda kullanılan özel akışların bildirimi.
tags		object	Kaynak etiketleri.

Yanıtlar

Name	Tür	Description
200 OK	DataCollectionRuleResource	Veri toplama kuralı başarıyla güncelleştirildi
201 Created	DataCollectionRuleResource	Veri toplama kuralı başarıyla oluşturuldu
Other Status Codes	ErrorResponseCommonV2	Hata

Güvenlik

azure_auth

Azure Active Directory OAuth2 Akışı

Tür: oauth2
Akış: implicit
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/authorize

Kapsamlar

Name	Description
user_impersonation	kullanıcı hesabınızın kimliğine bürünme

Örnekler

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

Örnek isteği

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

Örnek yanıt

Durum kodu:

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

Durum kodu:

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

Örnek isteği

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

Örnek yanıt

Durum kodu:

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

Durum kodu:

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

Örnek isteği

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

Örnek yanıt

Durum kodu:

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

Durum kodu:

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

Örnek isteği

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

Örnek yanıt

Durum kodu:

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

Durum kodu:

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

Tanımlar

Name	Description
AdxDestination	Azure Veri Gezgini (Adx) hedefi.
AgentSetting	Konak makinede aracı davranışını denetlemek için kullanılan ayar
AgentSettings	Belirli bir konakta aracı davranışını değiştirmek için kullanılan aracı ayarları
AzureMonitorMetrics	Azure İzleyici Ölçümleri hedefi.
ColumnDefinition	Özel veri sütununun tanımı.
createdByType	Kaynağı oluşturan kimliğin türü.
DataCollectionRuleResource	ARM izlenen en üst düzey kaynağın tanımı.
DataFlow	Hangi akışların hangi hedeflere gönderildiğinin tanımı.
DataImports	Çekme tabanlı veri kaynaklarının belirtimleri
DataSources	Veri kaynaklarının belirtimi. Bu özellik isteğe bağlıdır ve kuralın sağlanan uç noktaya doğrudan çağrılar yoluyla kullanılması amaçlanıyorsa atlanabilir.
Destinations	Hedeflerin belirtimi.
Endpoints	Bu kural aracılığıyla veri göndermek için alım uç noktalarını tanımlar.
EnrichmentData	Veri akışlarında başvurulan tüm zenginleştirme veri kaynakları
ErrorAdditionalInfo	Kaynak yönetimi hatası ek bilgileri.
ErrorDetail	Hata ayrıntısı.
ErrorResponseCommonV2	Hata yanıtı
EventHub	Event Hub yapılandırmasının tanımı.
EventHubDestination
EventHubDirectDestination
ExtensionDataSource	Azure İzleyici Aracısı ile tümleşen ayrı bir VM uzantısından hangi verilerin toplanacağına ilişkin tanım. Hangi uzantının tanımlandığına bağlı olarak Windows ve Linux makinelerinden toplanır.
Identity	Kaynağın yönetilen hizmet kimliği.
IisLogsDataSource	IIS günlüklerinin bu veri toplama kuralı tarafından toplanmasını sağlar.
KnownAgentSettingName	Ayarın adı. Desteklenen ayarlar listesinin bir parçası olmalıdır
KnownColumnDefinitionType	Sütun verilerinin türü.
KnownDataCollectionRuleProvisioningState	Kaynak sağlama durumu.
KnownDataCollectionRuleResourceKind	Kaynağın türü.
KnownDataFlowStreams	Bu veri akışı için akışların listesi.
KnownExtensionDataSourceStreams	Bu veri kaynağının gönderileceği akışların listesi. Akış, bu veriler için kullanılacak şemayı ve genellikle verilerin Log Analytics'teki hangi tabloya gönderileceğini gösterir.
KnownLogFilesDataSourceFormat	Günlük dosyalarının veri biçimi
KnownLogFileTextSettingsRecordStartTimestampFormat	Desteklenen zaman damgası biçimlerinden biri
KnownPerfCounterDataSourceStreams	Bu veri kaynağının gönderileceği akışların listesi. Akış, bu veriler için kullanılacak şemayı ve genellikle verilerin Log Analytics'teki hangi tabloya gönderileceğini gösterir.
KnownPrometheusForwarderDataSourceStreams	Bu veri kaynağının gönderileceği akışların listesi.
KnownStorageBlobLookupType	Blob üzerinde gerçekleştirilecek arama türü
KnownSyslogDataSourceFacilityNames	Tesis adlarının listesi.
KnownSyslogDataSourceLogLevels	Toplayacak günlük düzeyleri.
KnownSyslogDataSourceStreams	Bu veri kaynağının gönderileceği akışların listesi. Akış, bu veriler için kullanılacak şemayı ve genellikle verilerin Log Analytics'teki hangi tabloya gönderileceğini gösterir.
KnownWindowsEventLogDataSourceStreams	Bu veri kaynağının gönderileceği akışların listesi. Akış, bu veriler için kullanılacak şemayı ve genellikle verilerin Log Analytics'teki hangi tabloya gönderileceğini gösterir.
KnownWindowsFirewallLogsDataSourceProfileFilter	Güvenlik duvarı günlükleri profil filtresi
LogAnalyticsDestination	Log Analytics hedefi.
LogFilesDataSource	Bu veri toplama kuralı tarafından hangi özel günlük dosyalarının toplanacağı tanımı
ManagedServiceIdentityType	Yönetilen hizmet kimliği türü (hem SystemAssigned hem de UserAssigned türlerine izin verilir).
Metadata	Kaynak hakkındaki meta veriler
MicrosoftFabricDestination	Microsoft Fabric hedefi (Azure dışı).
MonitoringAccountDestination	hesap hedefini izleme.
PerfCounterDataSource	Hangi performans sayaçlarının toplanacağı ve bu veri toplama kuralı tarafından nasıl toplanacağı tanımlanmaktadır. Sayacın bulunduğu windows ve Linux makinelerinden toplanır.
PlatformTelemetryDataSource	Platform telemetrisi veri kaynağı yapılandırmasının tanımı
PrometheusForwarderDataSource	Prometheus ölçüm iletme yapılandırmasının tanımı.
References	DCR'nin diğer bölümlerinde kullanılabilecek tüm başvuruları tanımlar
Settings	Günlük dosyalarına özgü ayarlar.
StorageBlob
StorageBlobDestination
StorageTableDestination
StreamDeclaration	Özel akış bildirimi.
SyslogDataSource	Hangi syslog verilerinin toplanacağı ve nasıl toplanacağıyla ilgili tanım. Yalnızca Linux makinelerinden toplanır.
SystemData	Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.
Text	Metin ayarları
UserAssignedIdentity	Kullanıcı tarafından atanan kimlik özellikleri
WindowsEventLogDataSource	Hangi Windows Olay Günlüğü olaylarının toplanacağı ve bunların nasıl toplanacağıyla ilgili tanım. Yalnızca Windows makinelerinden toplanır.
WindowsFirewallLogsDataSource	Güvenlik duvarı günlüklerinin bu veri toplama kuralı tarafından toplanmasını sağlar.

AdxDestination

Nesne

Azure Veri Gezgini (Adx) hedefi.

Name	Tür	Description
databaseName	string	Verilerin alınacağı veritabanının adı.
ingestionUri	string	Adx kaynağının alma uri'si.
name	string	Hedef için kolay bir ad. Bu ad, veri toplama kuralındaki tüm hedeflerde (türü ne olursa olsun) benzersiz olmalıdır.
resourceId	string	Adx kaynağının ARM kaynak kimliği.

AgentSetting

Nesne

Konak makinede aracı davranışını denetlemek için kullanılan ayar

Name	Tür	Description
name	KnownAgentSettingName	Ayarın adı. Desteklenen ayarlar listesinin bir parçası olmalıdır
value	string	Ayarın değeri

AgentSettings

Nesne

Belirli bir konakta aracı davranışını değiştirmek için kullanılan aracı ayarları

Name	Tür	Description
logs	AgentSetting[]	Günlük aracısı (AMA) için geçerli olan tüm ayarlar

AzureMonitorMetrics

Nesne

Azure İzleyici Ölçümleri hedefi.

Name	Tür	Description
name	string	Hedef için kolay bir ad. Bu ad, veri toplama kuralındaki tüm hedeflerde (türü ne olursa olsun) benzersiz olmalıdır.

ColumnDefinition

Nesne

Özel veri sütununun tanımı.

Name	Tür	Description
name	string	Sütunun adı.
type	KnownColumnDefinitionType	Sütun verilerinin türü.

createdByType

Numaralandırma

Kaynağı oluşturan kimliğin türü.

Değer	Description
User
Application
ManagedIdentity
Key

DataCollectionRuleResource

Nesne

ARM izlenen en üst düzey kaynağın tanımı.

Name	Tür	Description
etag	string	Kaynak varlığı etiketi (ETag).
id	string	Kaynağın tam kimliği.
identity	Identity	Kaynağın yönetilen hizmet kimliği.
kind	KnownDataCollectionRuleResourceKind	Kaynağın türü.
location	string	Kaynağın bulunduğu coğrafi konum.
name	string	Kaynağın adı.
properties.agentSettings	AgentSettings	Belirli bir konakta aracı davranışını değiştirmek için kullanılan aracı ayarları
properties.dataCollectionEndpointId	string	Bu kuralın birlikte kullanabildiği veri toplama uç noktasının kaynak kimliği.
properties.dataFlows	DataFlow[]	Veri akışlarının belirtimi.
properties.dataSources	DataSources	Veri kaynaklarının belirtimi. Bu özellik isteğe bağlıdır ve kuralın sağlanan uç noktaya doğrudan çağrılar yoluyla kullanılması amaçlanıyorsa atlanabilir.
properties.description	string	Veri toplama kuralının açıklaması.
properties.destinations	Destinations	Hedeflerin belirtimi.
properties.endpoints	Endpoints	Bu kural aracılığıyla veri göndermek için alım uç noktalarını tanımlar.
properties.immutableId	string	Bu veri toplama kuralının sabit kimliği. Bu özellik SALT OKUNURdur.
properties.metadata	Metadata	Kaynak hakkındaki meta veriler
properties.provisioningState	KnownDataCollectionRuleProvisioningState	Kaynak sağlama durumu.
properties.references	References	DCR'nin diğer bölümlerinde kullanılabilecek tüm başvuruları tanımlar
properties.streamDeclarations	<string,  StreamDeclaration>	Bu kuralda kullanılan özel akışların bildirimi.
systemData	SystemData	Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.
tags	object	Kaynak etiketleri.
type	string	Kaynağın türü.

DataFlow

Nesne

Hangi akışların hangi hedeflere gönderildiğinin tanımı.

Name	Tür	Description
builtInTransform	string	Akış verilerini dönüştürmek için builtIn dönüşümü
captureOverflow	boolean	LA hedeflerinde taşma sütununu etkinleştirmek için bayrak ekleme
destinations	string[]	Bu veri akışı için hedeflerin listesi.
outputStream	string	Dönüşümün çıkış akışı. Yalnızca dönüşüm verileri farklı bir akışa değiştirirse gereklidir.
streams	KnownDataFlowStreams[]	Bu veri akışı için akışların listesi.
transformKql	string	Akış verilerini dönüştürmek için KQL sorgusu.

DataImports

Nesne

Çekme tabanlı veri kaynaklarının belirtimleri

Name	Tür	Description
eventHub	EventHub	Event Hub yapılandırmasının tanımı.

DataSources

Nesne

Veri kaynaklarının belirtimi. Bu özellik isteğe bağlıdır ve kuralın sağlanan uç noktaya doğrudan çağrılar yoluyla kullanılması amaçlanıyorsa atlanabilir.

Name	Tür	Description
dataImports	DataImports	Çekme tabanlı veri kaynaklarının belirtimleri
extensions	ExtensionDataSource[]	Azure VM uzantısı veri kaynağı yapılandırmalarının listesi.
iisLogs	IisLogsDataSource[]	IIS günlükleri kaynak yapılandırmalarının listesi.
logFiles	LogFilesDataSource[]	Günlük dosyaları kaynak yapılandırmalarının listesi.
performanceCounters	PerfCounterDataSource[]	Performans sayacı veri kaynağı yapılandırmalarının listesi.
platformTelemetry	PlatformTelemetryDataSource[]	Platform telemetri yapılandırmalarının listesi
prometheusForwarder	PrometheusForwarderDataSource[]	Prometheus ileticisi veri kaynağı yapılandırmalarının listesi.
syslog	SyslogDataSource[]	Syslog veri kaynağı yapılandırmalarının listesi.
windowsEventLogs	WindowsEventLogDataSource[]	Windows Olay Günlüğü veri kaynağı yapılandırmalarının listesi.
windowsFirewallLogs	WindowsFirewallLogsDataSource[]	Windows Güvenlik Duvarı listesi kaynak yapılandırmalarını günlüğe kaydeder.

Destinations

Nesne

Hedeflerin belirtimi.

Name	Tür	Description
azureDataExplorer	AdxDestination[]	Azure Veri Gezgini hedeflerinin listesi.
azureMonitorMetrics	AzureMonitorMetrics	Azure İzleyici Ölçümleri hedefi.
eventHubs	EventHubDestination[]	Event Hubs hedeflerinin listesi.
eventHubsDirect	EventHubDirectDestination[]	Event Hubs Doğrudan hedeflerinin listesi.
logAnalytics	LogAnalyticsDestination[]	Log Analytics hedeflerinin listesi.
microsoftFabric	MicrosoftFabricDestination[]	Microsoft Fabric hedeflerinin listesi.
monitoringAccounts	MonitoringAccountDestination[]	İzleme hesabı hedeflerinin listesi.
storageAccounts	StorageBlobDestination[]	Depolama hesabı hedeflerinin listesi.
storageBlobsDirect	StorageBlobDestination[]	Depolama Blobu Doğrudan hedeflerinin listesi. Yalnızca aracıdan depolamak üzere doğrudan veri göndermek için kullanılır.
storageTablesDirect	StorageTableDestination[]	Depolama Tablosu Doğrudan hedeflerinin listesi.

Endpoints

Nesne

Bu kural aracılığıyla veri göndermek için alım uç noktalarını tanımlar.

Name	Tür	Description
logsIngestion	string	Günlükler için alım uç noktası
metricsIngestion	string	Ölçümler için alım uç noktası

EnrichmentData

Nesne

Veri akışlarında başvurulan tüm zenginleştirme veri kaynakları

Name	Tür	Description
storageBlobs	StorageBlob[]	Zenginleştirme veri kaynakları olarak kullanılan tüm depolama blobları

ErrorAdditionalInfo

Nesne

Kaynak yönetimi hatası ek bilgileri.

Name	Tür	Description
info	object	Ek bilgiler.
type	string	Ek bilgi türü.

ErrorDetail

Nesne

Hata ayrıntısı.

Name	Tür	Description
additionalInfo	ErrorAdditionalInfo[]	Hata ek bilgileri.
code	string	Hata kodu.
details	ErrorDetail[]	Hata ayrıntıları.
message	string	Hata iletisi.
target	string	Hata hedefi.

ErrorResponseCommonV2

Nesne

Hata yanıtı

Name	Tür	Description
error	ErrorDetail	Hata nesnesi.

EventHub

Nesne

Event Hub yapılandırmasının tanımı.

Name	Tür	Description
consumerGroup	string	Event Hub tüketici grubu adı
name	string	Veri kaynağı için kolay bir ad. Bu ad, veri toplama kuralındaki tüm veri kaynaklarında (türü ne olursa olsun) benzersiz olmalıdır.
stream	string	EventHub'dan toplayacak akış

EventHubDestination

Nesne

Name	Tür	Description
eventHubResourceId	string	Olay hub'ının kaynak kimliği.
name	string	Hedef için kolay bir ad. Bu ad, veri toplama kuralındaki tüm hedeflerde (türü ne olursa olsun) benzersiz olmalıdır.

EventHubDirectDestination

Nesne

Name	Tür	Description
eventHubResourceId	string	Olay hub'ının kaynak kimliği.
name	string	Hedef için kolay bir ad. Bu ad, veri toplama kuralındaki tüm hedeflerde (türü ne olursa olsun) benzersiz olmalıdır.

ExtensionDataSource

Nesne

Azure İzleyici Aracısı ile tümleşen ayrı bir VM uzantısından hangi verilerin toplanacağına ilişkin tanım. Hangi uzantının tanımlandığına bağlı olarak Windows ve Linux makinelerinden toplanır.

Name	Tür	Description
extensionName	string	VM uzantısının adı.
extensionSettings	object	Uzantı ayarları. Biçim, belirli bir uzantıya özgüdür.
inputDataSources	string[]	Bu uzantının veriye ihtiyacı olan veri kaynaklarının listesi.
name	string	Veri kaynağı için kolay bir ad. Bu ad, veri toplama kuralındaki tüm veri kaynaklarında (türü ne olursa olsun) benzersiz olmalıdır.
streams	KnownExtensionDataSourceStreams[]	Bu veri kaynağının gönderileceği akışların listesi. Akış, bu veriler için kullanılacak şemayı ve genellikle verilerin Log Analytics'teki hangi tabloya gönderileceğini gösterir.

Identity

Nesne

Kaynağın yönetilen hizmet kimliği.

Name	Tür	Description
principalId	string (uuid)	Sistem tarafından atanan kimliğin hizmet sorumlusu kimliği. Bu özellik yalnızca sistem tarafından atanan kimlik için sağlanacaktır.
tenantId	string (uuid)	Sistem tarafından atanan kimliğin kiracı kimliği. Bu özellik yalnızca sistem tarafından atanan kimlik için sağlanacaktır.
type	ManagedServiceIdentityType	Yönetilen hizmet kimliği türü (hem SystemAssigned hem de UserAssigned türlerine izin verilir).
userAssignedIdentities	<string,  UserAssignedIdentity>	kimlikleri User-Assigned Kaynakla ilişkili kullanıcı tarafından atanan kimlik kümesi. userAssignedIdentities sözlük anahtarları şu formda ARM kaynak kimlikleri olacaktır: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Sözlük değerleri, isteklerdeki boş nesneler ({}) olabilir.

IisLogsDataSource

Nesne

IIS günlüklerinin bu veri toplama kuralı tarafından toplanmasını sağlar.

Name	Tür	Description
logDirectories	string[]	Mutlak yollar dosya konumu
name	string	Veri kaynağı için kolay bir ad. Bu ad, veri toplama kuralındaki tüm veri kaynaklarında (türü ne olursa olsun) benzersiz olmalıdır.
streams	string[]	IIS akışları
transformKql	string	Veri kaynağını dönüştürmek için KQL sorgusu.

KnownAgentSettingName

Numaralandırma

Ayarın adı. Desteklenen ayarlar listesinin bir parçası olmalıdır

Değer	Description
MaxDiskQuotaInMB
UseTimeReceivedForForwardedEvents

KnownColumnDefinitionType

Numaralandırma

Sütun verilerinin türü.

Değer	Description
string
int
long
real
boolean
datetime
dynamic

KnownDataCollectionRuleProvisioningState

Numaralandırma

Kaynak sağlama durumu.

Değer	Description
Creating
Updating
Deleting
Succeeded
Canceled
Failed

KnownDataCollectionRuleResourceKind

Numaralandırma

Kaynağın türü.

Değer	Description
Linux
Windows

KnownDataFlowStreams

Numaralandırma

Bu veri akışı için akışların listesi.

Değer	Description
Microsoft-Event
Microsoft-InsightsMetrics
Microsoft-Perf
Microsoft-Syslog
Microsoft-WindowsEvent

KnownExtensionDataSourceStreams

Numaralandırma

Bu veri kaynağının gönderileceği akışların listesi. Akış, bu veriler için kullanılacak şemayı ve genellikle verilerin Log Analytics'teki hangi tabloya gönderileceğini gösterir.

Değer	Description
Microsoft-Event
Microsoft-InsightsMetrics
Microsoft-Perf
Microsoft-Syslog
Microsoft-WindowsEvent

KnownLogFilesDataSourceFormat

Numaralandırma

Günlük dosyalarının veri biçimi

Değer	Description
json
text

KnownLogFileTextSettingsRecordStartTimestampFormat

Numaralandırma

Desteklenen zaman damgası biçimlerinden biri

Değer	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

Numaralandırma

Bu veri kaynağının gönderileceği akışların listesi. Akış, bu veriler için kullanılacak şemayı ve genellikle verilerin Log Analytics'teki hangi tabloya gönderileceğini gösterir.

Değer	Description
Microsoft-Perf
Microsoft-InsightsMetrics

KnownPrometheusForwarderDataSourceStreams

Numaralandırma

Bu veri kaynağının gönderileceği akışların listesi.

Değer	Description
Microsoft-PrometheusMetrics

KnownStorageBlobLookupType

Numaralandırma

Blob üzerinde gerçekleştirilecek arama türü

Değer	Description
String
Cidr

KnownSyslogDataSourceFacilityNames

Numaralandırma

Tesis adlarının listesi.

Değer	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

Numaralandırma

Toplayacak günlük düzeyleri.

Değer	Description
Debug
Info
Notice
Warning
Error
Critical
Alert
Emergency
*

KnownSyslogDataSourceStreams

Numaralandırma

Bu veri kaynağının gönderileceği akışların listesi. Akış, bu veriler için kullanılacak şemayı ve genellikle verilerin Log Analytics'teki hangi tabloya gönderileceğini gösterir.

Değer	Description
Microsoft-Syslog

KnownWindowsEventLogDataSourceStreams

Numaralandırma

Bu veri kaynağının gönderileceği akışların listesi. Akış, bu veriler için kullanılacak şemayı ve genellikle verilerin Log Analytics'teki hangi tabloya gönderileceğini gösterir.

Değer	Description
Microsoft-WindowsEvent
Microsoft-Event

KnownWindowsFirewallLogsDataSourceProfileFilter

Numaralandırma

Güvenlik duvarı günlükleri profil filtresi

Değer	Description
Domain
Private
Public

LogAnalyticsDestination

Nesne

Log Analytics hedefi.

Name	Tür	Description
name	string	Hedef için kolay bir ad. Bu ad, veri toplama kuralındaki tüm hedeflerde (türü ne olursa olsun) benzersiz olmalıdır.
workspaceId	string	Log Analytics çalışma alanının Müşteri Kimliği.
workspaceResourceId	string	Log Analytics çalışma alanının kaynak kimliği.

LogFilesDataSource

Nesne

Bu veri toplama kuralı tarafından hangi özel günlük dosyalarının toplanacağı tanımı

Name	Tür	Description
filePatterns	string[]	Günlük dosyalarının bulunduğu Dosya Desenleri
format	KnownLogFilesDataSourceFormat	Günlük dosyalarının veri biçimi
name	string	Veri kaynağı için kolay bir ad. Bu ad, veri toplama kuralındaki tüm veri kaynaklarında (türü ne olursa olsun) benzersiz olmalıdır.
settings	Settings	Günlük dosyalarına özgü ayarlar.
streams	string[]	Bu veri kaynağının gönderileceği akışların listesi. Akış, bu veri kaynağı için hangi şemanın kullanılacağını gösterir
transformKql	string	Veri kaynağını dönüştürmek için KQL sorgusu.

ManagedServiceIdentityType

Numaralandırma

Yönetilen hizmet kimliği türü (hem SystemAssigned hem de UserAssigned türlerine izin verilir).

Değer	Description
None
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned

Metadata

Nesne

Kaynak hakkındaki meta veriler

Name	Tür	Description
provisionedBy	string	Bu kaynağı müşteri adına yöneten Azure teklifi.
provisionedByImmutableId	string	Bu kaynağı müşteri adına yöneten azure teklifinin sabit kimliği.
provisionedByResourceId	string	Bu kaynağı müşteri adına yöneten Azure teklifinin kaynak kimliği.

MicrosoftFabricDestination

Nesne

Microsoft Fabric hedefi (Azure dışı).

Name	Tür	Description
artifactId	string	Microsoft Fabric kaynağının yapıt kimliği.
databaseName	string	Verilerin alınacağı veritabanının adı.
ingestionUri	string	Microsoft Fabric kaynağının alma uri'sini.
name	string	Hedef için kolay bir ad. Bu ad, veri toplama kuralındaki tüm hedeflerde (türü ne olursa olsun) benzersiz olmalıdır.
tenantId	string	Microsoft Fabric kaynağının kiracı kimliği.

MonitoringAccountDestination

Nesne

hesap hedefini izleme.

Name	Tür	Description
accountId	string	Hesabın sabit kimliği.
accountResourceId	string	İzleme hesabının kaynak kimliği.
name	string	Hedef için kolay bir ad. Bu ad, veri toplama kuralındaki tüm hedeflerde (türü ne olursa olsun) benzersiz olmalıdır.

PerfCounterDataSource

Nesne

Hangi performans sayaçlarının toplanacağı ve bu veri toplama kuralı tarafından nasıl toplanacağı tanımlanmaktadır. Sayacın bulunduğu windows ve Linux makinelerinden toplanır.

Name	Tür	Description
counterSpecifiers	string[]	Toplamak istediğiniz performans sayaçlarının tanımlayıcı adlarının listesi. Tüm örnekler için bir sayaç toplamak için joker karakter (*) kullanın. Windows'da performans sayaçlarının listesini almak için 'typeperf' komutunu çalıştırın.
name	string	Veri kaynağı için kolay bir ad. Bu ad, veri toplama kuralındaki tüm veri kaynaklarında (türü ne olursa olsun) benzersiz olmalıdır.
samplingFrequencyInSeconds	integer (int32)	Ardışık sayaç ölçümleri (örnekler) arasındaki saniye sayısı.
streams	KnownPerfCounterDataSourceStreams[]	Bu veri kaynağının gönderileceği akışların listesi. Akış, bu veriler için kullanılacak şemayı ve genellikle verilerin Log Analytics'teki hangi tabloya gönderileceğini gösterir.
transformKql	string	Veri kaynağını dönüştürmek için KQL sorgusu.

PlatformTelemetryDataSource

Nesne

Platform telemetrisi veri kaynağı yapılandırmasının tanımı

Name	Tür	Description
name	string	Veri kaynağı için kolay bir ad. Bu ad, veri toplama kuralındaki tüm veri kaynaklarında (türü ne olursa olsun) benzersiz olmalıdır.
streams	string[]	Toplayacak platform telemetri akışlarının listesi

PrometheusForwarderDataSource

Nesne

Prometheus ölçüm iletme yapılandırmasının tanımı.

Name	Tür	Description
labelIncludeFilter	object	Etiket ekleme listesi, "ad-değer" çiftleri biçiminde filtrelenir. Şu anda yalnızca bir etiket desteklenmektedir: 'microsoft_metrics_include_label'. Etiket değerleri büyük/küçük harfe duyarsız olarak eşleştirilir.
name	string	Veri kaynağı için kolay bir ad. Bu ad, veri toplama kuralındaki tüm veri kaynaklarında (türü ne olursa olsun) benzersiz olmalıdır.
streams	KnownPrometheusForwarderDataSourceStreams[]	Bu veri kaynağının gönderileceği akışların listesi.

References

Nesne

DCR'nin diğer bölümlerinde kullanılabilecek tüm başvuruları tanımlar

Name	Tür	Description
enrichmentData	EnrichmentData	Veri akışlarında başvurulan tüm zenginleştirme veri kaynakları

Settings

Nesne

Günlük dosyalarına özgü ayarlar.

Name	Tür	Description
text	Text	Metin ayarları

StorageBlob

Nesne

Name	Tür	Description
blobUrl	string	Depolama blobunun url'si
lookupType	KnownStorageBlobLookupType	Blob üzerinde gerçekleştirilecek arama türü
name	string	Veri akışlarında bu veri kaynağına başvururken diğer ad olarak kullanılan zenginleştirme veri kaynağının adı
resourceId	string	Blobu barındıran depolama hesabının Kaynak Kimliği

StorageBlobDestination

Nesne

Name	Tür	Description
containerName	string	Depolama Blobunun kapsayıcı adı.
name	string	Hedef için kolay bir ad. Bu ad, veri toplama kuralındaki tüm hedeflerde (türü ne olursa olsun) benzersiz olmalıdır.
storageAccountResourceId	string	Depolama hesabının kaynak kimliği.

StorageTableDestination

Nesne

Name	Tür	Description
name	string	Hedef için kolay bir ad. Bu ad, veri toplama kuralındaki tüm hedeflerde (türü ne olursa olsun) benzersiz olmalıdır.
storageAccountResourceId	string	Depolama hesabının kaynak kimliği.
tableName	string	Depolama Tablosunun adı.

StreamDeclaration

Nesne

Özel akış bildirimi.

Name	Tür	Description
columns	ColumnDefinition[]	Bu akıştaki veriler tarafından kullanılan sütunların listesi.

SyslogDataSource

Nesne

Hangi syslog verilerinin toplanacağı ve nasıl toplanacağıyla ilgili tanım. Yalnızca Linux makinelerinden toplanır.

Name	Tür	Description
facilityNames	KnownSyslogDataSourceFacilityNames[]	Tesis adlarının listesi.
logLevels	KnownSyslogDataSourceLogLevels[]	Toplayacak günlük düzeyleri.
name	string	Veri kaynağı için kolay bir ad. Bu ad, veri toplama kuralındaki tüm veri kaynaklarında (türü ne olursa olsun) benzersiz olmalıdır.
streams	KnownSyslogDataSourceStreams[]	Bu veri kaynağının gönderileceği akışların listesi. Akış, bu veriler için kullanılacak şemayı ve genellikle verilerin Log Analytics'teki hangi tabloya gönderileceğini gösterir.
transformKql	string	Veri kaynağını dönüştürmek için KQL sorgusu.

SystemData

Nesne

Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

Name	Tür	Description
createdAt	string (date-time)	Kaynak oluşturma (UTC) zaman damgası.
createdBy	string	Kaynağı oluşturan kimlik.
createdByType	createdByType	Kaynağı oluşturan kimliğin türü.
lastModifiedAt	string (date-time)	Kaynağın son değişikliğinin zaman damgası (UTC)
lastModifiedBy	string	Kaynağı en son değiştiren kimlik.
lastModifiedByType	createdByType	Kaynağı en son değiştiren kimlik türü.

Text

Nesne

Metin ayarları

Name	Tür	Description
recordStartTimestampFormat	KnownLogFileTextSettingsRecordStartTimestampFormat	Desteklenen zaman damgası biçimlerinden biri

UserAssignedIdentity

Nesne

Kullanıcı tarafından atanan kimlik özellikleri

Name	Tür	Description
clientId	string (uuid)	Atanan kimliğin istemci kimliği.
principalId	string (uuid)	Atanan kimliğin asıl kimliği.

WindowsEventLogDataSource

Nesne

Hangi Windows Olay Günlüğü olaylarının toplanacağı ve bunların nasıl toplanacağıyla ilgili tanım. Yalnızca Windows makinelerinden toplanır.

Name	Tür	Description
name	string	Veri kaynağı için kolay bir ad. Bu ad, veri toplama kuralındaki tüm veri kaynaklarında (türü ne olursa olsun) benzersiz olmalıdır.
streams	KnownWindowsEventLogDataSourceStreams[]	Bu veri kaynağının gönderileceği akışların listesi. Akış, bu veriler için kullanılacak şemayı ve genellikle verilerin Log Analytics'teki hangi tabloya gönderileceğini gösterir.
transformKql	string	Veri kaynağını dönüştürmek için KQL sorgusu.
xPathQueries	string[]	XPATH biçimindeki Windows Olay Günlüğü sorgularının listesi.

WindowsFirewallLogsDataSource

Nesne

Güvenlik duvarı günlüklerinin bu veri toplama kuralı tarafından toplanmasını sağlar.

Name	Tür	Description
name	string	Veri kaynağı için kolay bir ad. Bu ad, veri toplama kuralındaki tüm veri kaynaklarında (türü ne olursa olsun) benzersiz olmalıdır.
profileFilter	KnownWindowsFirewallLogsDataSourceProfileFilter[]	Güvenlik duvarı günlükleri profil filtresi
streams	string[]	Güvenlik duvarı günlükleri akışları