Data Collection Rules - Create

サービス:: Monitor

API バージョン:: 2023-03-11

データ収集規則を作成または更新します。

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

URI パラメーター

名前	/	必須	型	説明
dataCollectionRuleName	path	True	string	データ収集規則の名前。名前では大文字と小文字が区別されません。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	リソースグループの名前。名前では大文字と小文字が区別されません。
subscriptionId	path	True	string minLength: 1	ターゲットサブスクリプションの ID。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

要求本文

名前	必須	型	説明
location	True	string	リソースが存在する地理的な場所。
identity		Identity	リソースのマネージドサービス ID。
kind		KnownDataCollectionRuleResourceKind	リソースの種類。
properties.agentSettings		AgentSettings	特定のホストでのエージェントの動作を変更するために使用されるエージェント設定
properties.dataCollectionEndpointId		string	このルールを使用できるデータ収集エンドポイントのリソース ID。
properties.dataFlows		DataFlow[]	データフローの仕様。
properties.dataSources		DataSources	データソースの仕様。このプロパティは省略可能であり、ルールがプロビジョニングされたエンドポイントへの直接呼び出しで使用される場合は省略できます。
properties.description		string	データ収集規則の説明。
properties.destinations		Destinations	変換先の指定。
properties.references		References	DCR の他のセクションで使用できるすべての参照を定義します。
properties.streamDeclarations		<string, StreamDeclaration>	この規則で使用されるカスタムストリームの宣言。
tags		object	リソースタグ。

応答

名前	型	説明
200 OK	DataCollectionRuleResource	データ収集ルールが正常に更新されました
201 Created	DataCollectionRuleResource	データ収集規則が正常に作成されました
Other Status Codes	ErrorResponseCommonV2	エラー

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザーアカウントを偽装する

例

Create or update an agent settings configuration

Create or update data collection rule

Create or update data collection rule with embedded ingestion endpoints

Create or update data collection rule with enrichment

Create or update an agent settings configuration

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

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

from azure.identity import DefaultAzureCredential

from azure.mgmt.monitor import MonitorManagementClient

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

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


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

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


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

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

応答のサンプル

状態コード:: 200

{
  "id": "/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.Insights/dataCollectionRules/myCollectionRule",
  "name": "myCollectionRule",
  "type": "Microsoft.Insights/dataCollectionRules",
  "location": "eastus",
  "kind": "AgentSettings",
  "properties": {
    "description": "An agent settings configuration",
    "immutableId": "dcr-76ce901eee3a400b9945b1e263a70000",
    "agentSettings": {
      "logs": [
        {
          "name": "MaxDiskQuotaInMB",
          "value": "5000"
        },
        {
          "name": "UseTimeReceivedForForwardedEvents",
          "value": "1"
        }
      ]
    },
    "provisioningState": "Succeeded"
  },
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2024-03-26T05:41:40.7885407Z",
    "lastModifiedBy": "user1",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-03-26T05:41:40.7885407Z"
  },
  "etag": "070057da-0000-0000-0000-5ba70d6c0000"
}

状態コード:: 201

{
  "id": "/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.Insights/dataCollectionRules/myCollectionRule",
  "name": "myCollectionRule",
  "type": "Microsoft.Insights/dataCollectionRules",
  "location": "eastus",
  "kind": "AgentSettings",
  "properties": {
    "description": "An agent settings configuration",
    "immutableId": "dcr-76ce901eee3a400b9945b1e263a70000",
    "agentSettings": {
      "logs": [
        {
          "name": "MaxDiskQuotaInMB",
          "value": "5000"
        },
        {
          "name": "UseTimeReceivedForForwardedEvents",
          "value": "1"
        }
      ]
    },
    "provisioningState": "Succeeded"
  },
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2024-03-26T05:41:40.7885407Z",
    "lastModifiedBy": "user1",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-03-26T05:41:40.7885407Z"
  },
  "etag": "070057da-0000-0000-0000-5ba70d6c0000"
}

Create or update data collection rule

要求のサンプル

HTTP
Python

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

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

from azure.identity import DefaultAzureCredential

from azure.mgmt.monitor import MonitorManagementClient

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

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


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

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


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

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

応答のサンプル

状態コード:: 200

{
  "id": "/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.Insights/dataCollectionRules/myCollectionRule",
  "name": "myCollectionRule",
  "type": "Microsoft.Insights/dataCollectionRules",
  "location": "eastus",
  "tags": {
    "tag1": "A",
    "tag2": "B"
  },
  "properties": {
    "immutableId": "dcr-b74e0d383fc9415abaa584ec41adece3",
    "dataSources": {
      "performanceCounters": [
        {
          "name": "cloudTeamCoreCounters",
          "streams": [
            "Microsoft-Perf"
          ],
          "samplingFrequencyInSeconds": 15,
          "counterSpecifiers": [
            "\\Processor(_Total)\\% Processor Time",
            "\\Memory\\Committed Bytes",
            "\\LogicalDisk(_Total)\\Free Megabytes",
            "\\PhysicalDisk(_Total)\\Avg. Disk Queue Length"
          ]
        },
        {
          "name": "appTeamExtraCounters",
          "streams": [
            "Microsoft-Perf"
          ],
          "samplingFrequencyInSeconds": 30,
          "counterSpecifiers": [
            "\\Process(_Total)\\Thread Count"
          ]
        }
      ],
      "windowsEventLogs": [
        {
          "name": "cloudSecurityTeamEvents",
          "streams": [
            "Microsoft-WindowsEvent"
          ],
          "xPathQueries": [
            "Security!"
          ]
        },
        {
          "name": "appTeam1AppEvents",
          "streams": [
            "Microsoft-WindowsEvent"
          ],
          "xPathQueries": [
            "System![System[(Level = 1 or Level = 2 or Level = 3)]]",
            "Application!*[System[(Level = 1 or Level = 2 or Level = 3)]]"
          ]
        }
      ],
      "syslog": [
        {
          "name": "cronSyslog",
          "streams": [
            "Microsoft-Syslog"
          ],
          "facilityNames": [
            "cron"
          ],
          "logLevels": [
            "Debug",
            "Critical",
            "Emergency"
          ]
        },
        {
          "name": "syslogBase",
          "streams": [
            "Microsoft-Syslog"
          ],
          "facilityNames": [
            "syslog"
          ],
          "logLevels": [
            "Alert",
            "Critical",
            "Emergency"
          ]
        }
      ]
    },
    "destinations": {
      "logAnalytics": [
        {
          "workspaceResourceId": "/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.OperationalInsights/workspaces/centralTeamWorkspace",
          "workspaceId": "9ba8bc53-bd36-4156-8667-e983e7ae0e4f",
          "name": "centralWorkspace"
        }
      ]
    },
    "dataFlows": [
      {
        "streams": [
          "Microsoft-Perf",
          "Microsoft-Syslog",
          "Microsoft-WindowsEvent"
        ],
        "destinations": [
          "centralWorkspace"
        ]
      }
    ]
  },
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2021-04-01T12:34:56.1234567Z",
    "lastModifiedBy": "user2",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2021-04-02T12:34:56.1234567Z"
  },
  "etag": "070057da-0000-0000-0000-5ba70d6c0000"
}

状態コード:: 201

{
  "id": "/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.Insights/dataCollectionRules/myCollectionRule",
  "name": "myCollectionRule",
  "type": "Microsoft.Insights/dataCollectionRules",
  "location": "eastus",
  "tags": {
    "tag1": "A",
    "tag2": "B"
  },
  "properties": {
    "immutableId": "dcr-b74e0d383fc9415abaa584ec41adece3",
    "dataSources": {
      "performanceCounters": [
        {
          "name": "cloudTeamCoreCounters",
          "streams": [
            "Microsoft-Perf"
          ],
          "samplingFrequencyInSeconds": 15,
          "counterSpecifiers": [
            "\\Processor(_Total)\\% Processor Time",
            "\\Memory\\Committed Bytes",
            "\\LogicalDisk(_Total)\\Free Megabytes",
            "\\PhysicalDisk(_Total)\\Avg. Disk Queue Length"
          ]
        },
        {
          "name": "appTeamExtraCounters",
          "streams": [
            "Microsoft-Perf"
          ],
          "samplingFrequencyInSeconds": 30,
          "counterSpecifiers": [
            "\\Process(_Total)\\Thread Count"
          ]
        }
      ],
      "windowsEventLogs": [
        {
          "name": "cloudSecurityTeamEvents",
          "streams": [
            "Microsoft-WindowsEvent"
          ],
          "xPathQueries": [
            "Security!"
          ]
        },
        {
          "name": "appTeam1AppEvents",
          "streams": [
            "Microsoft-WindowsEvent"
          ],
          "xPathQueries": [
            "System![System[(Level = 1 or Level = 2 or Level = 3)]]",
            "Application!*[System[(Level = 1 or Level = 2 or Level = 3)]]"
          ]
        }
      ],
      "syslog": [
        {
          "name": "cronSyslog",
          "streams": [
            "Microsoft-Syslog"
          ],
          "facilityNames": [
            "cron"
          ],
          "logLevels": [
            "Debug",
            "Critical",
            "Emergency"
          ]
        },
        {
          "name": "syslogBase",
          "streams": [
            "Microsoft-Syslog"
          ],
          "facilityNames": [
            "syslog"
          ],
          "logLevels": [
            "Alert",
            "Critical",
            "Emergency"
          ]
        }
      ]
    },
    "destinations": {
      "logAnalytics": [
        {
          "workspaceResourceId": "/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.OperationalInsights/workspaces/centralTeamWorkspace",
          "workspaceId": "9ba8bc53-bd36-4156-8667-e983e7ae0e4f",
          "name": "centralWorkspace"
        }
      ]
    },
    "dataFlows": [
      {
        "streams": [
          "Microsoft-Perf",
          "Microsoft-Syslog",
          "Microsoft-WindowsEvent"
        ],
        "destinations": [
          "centralWorkspace"
        ]
      }
    ]
  },
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2021-04-01T12:34:56.1234567Z",
    "lastModifiedBy": "user2",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2021-04-02T12:34:56.1234567Z"
  },
  "etag": "070057da-0000-0000-0000-5ba70d6c0000"
}

Create or update data collection rule with embedded ingestion endpoints

要求のサンプル

HTTP
Python

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

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

from azure.identity import DefaultAzureCredential

from azure.mgmt.monitor import MonitorManagementClient

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

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


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

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


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

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

応答のサンプル

状態コード:: 200

{
  "id": "/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.Insights/dataCollectionRules/myCollectionRule",
  "name": "myCollectionRule",
  "type": "Microsoft.Insights/dataCollectionRules",
  "location": "eastus",
  "kind": "Direct",
  "properties": {
    "description": "A Direct Ingestion Rule with builtin ingestion fqdns",
    "immutableId": "dcr-d2a09c11a66243009af059a655750000",
    "endpoints": {
      "logsIngestion": "https://mycollectionrule-8ykm-eastus2euap.logs.z1.canary.ingest.monitor.azure.com",
      "metricsIngestion": "https://mycollectionrule-jcvc-eastus2euap.metrics.z1.canary.ingest.monitor.azure.com"
    },
    "streamDeclarations": {
      "Custom-LOGS1_CL": {
        "columns": [
          {
            "name": "Time",
            "type": "datetime"
          },
          {
            "name": "Computer",
            "type": "string"
          },
          {
            "name": "AdditionalContext",
            "type": "string"
          },
          {
            "name": "CounterName",
            "type": "string"
          },
          {
            "name": "CounterValue",
            "type": "real"
          }
        ]
      }
    },
    "destinations": {
      "logAnalytics": [
        {
          "workspaceResourceId": "/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.OperationalInsights/workspaces/centralTeamWorkspace",
          "name": "centralWorkspace"
        }
      ]
    },
    "dataFlows": [
      {
        "streams": [
          "Custom-LOGS1_CL"
        ],
        "destinations": [
          "myworkspace"
        ],
        "transformKql": "source | extend jsonContext = parse_json(AdditionalContext) | project TimeGenerated = Time, Computer, AdditionalContext = jsonContext, CounterName=tostring(jsonContext.CounterName), CounterValue=toreal(jsonContext.CounterValue)",
        "outputStream": "Custom-LOGS1_CL"
      }
    ],
    "provisioningState": "Succeeded"
  },
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2024-01-30T17:50:40.5383301Z",
    "lastModifiedBy": "user1",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-01-30T17:50:40.5383301Z"
  },
  "etag": "070057da-0000-0000-0000-5ba70d6c0000"
}

状態コード:: 201

{
  "id": "/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.Insights/dataCollectionRules/myCollectionRule",
  "name": "myCollectionRule",
  "type": "Microsoft.Insights/dataCollectionRules",
  "location": "eastus",
  "kind": "Direct",
  "properties": {
    "description": "A Direct Ingestion Rule with builtin ingestion fqdns",
    "immutableId": "dcr-d2a09c11a66243009af059a655750000",
    "endpoints": {
      "logsIngestion": "https://mycollectionrule-8ykm-eastus2euap.logs.z1.canary.ingest.monitor.azure.com",
      "metricsIngestion": "https://mycollectionrule-jcvc-eastus2euap.metrics.z1.canary.ingest.monitor.azure.com"
    },
    "streamDeclarations": {
      "Custom-LOGS1_CL": {
        "columns": [
          {
            "name": "Time",
            "type": "datetime"
          },
          {
            "name": "Computer",
            "type": "string"
          },
          {
            "name": "AdditionalContext",
            "type": "string"
          },
          {
            "name": "CounterName",
            "type": "string"
          },
          {
            "name": "CounterValue",
            "type": "real"
          }
        ]
      }
    },
    "destinations": {
      "logAnalytics": [
        {
          "workspaceResourceId": "/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.OperationalInsights/workspaces/centralTeamWorkspace",
          "name": "centralWorkspace"
        }
      ]
    },
    "dataFlows": [
      {
        "streams": [
          "Custom-LOGS1_CL"
        ],
        "destinations": [
          "myworkspace"
        ],
        "transformKql": "source | extend jsonContext = parse_json(AdditionalContext) | project TimeGenerated = Time, Computer, AdditionalContext = jsonContext, CounterName=tostring(jsonContext.CounterName), CounterValue=toreal(jsonContext.CounterValue)",
        "outputStream": "Custom-LOGS1_CL"
      }
    ],
    "provisioningState": "Succeeded"
  },
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2024-01-30T17:50:40.5383301Z",
    "lastModifiedBy": "user1",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-01-30T17:50:40.5383301Z"
  },
  "etag": "070057da-0000-0000-0000-5ba70d6c0000"
}

Create or update data collection rule with enrichment

要求のサンプル

HTTP
Python

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

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

from azure.identity import DefaultAzureCredential

from azure.mgmt.monitor import MonitorManagementClient

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

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


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

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


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

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

応答のサンプル

状態コード:: 200

{
  "id": "/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.Insights/dataCollectionRules/myCollectionRule",
  "name": "myCollectionRule",
  "type": "Microsoft.Insights/dataCollectionRules",
  "location": "eastus",
  "properties": {
    "description": "A rule showcasing ingestion time enrichment",
    "immutableId": "dcr-ad96300ff0734d08a6a7195eb2be0000",
    "dataCollectionEndpointId": "/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.Insights/dataCollectionEndpoints/myDataCollectionEndpoint",
    "references": {
      "enrichmentData": {
        "storageBlobs": [
          {
            "resourceId": "/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourcegroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myenrichmentstorage",
            "blobUrl": "https://myenrichmentstorage.blob.core.windows.net/enrichment",
            "lookupType": "String",
            "name": "mytextdatastore"
          }
        ]
      }
    },
    "streamDeclarations": {
      "Custom-TabularDataABC": {
        "columns": [
          {
            "name": "TimeGenerated",
            "type": "datetime"
          },
          {
            "name": "Message",
            "type": "string"
          },
          {
            "name": "AdditionalContext",
            "type": "string"
          }
        ]
      }
    },
    "dataSources": {
      "logFiles": [
        {
          "streams": [
            "Custom-TabularDataABC"
          ],
          "filePatterns": [
            "C:\\JavaLogs\\*\\*.log"
          ],
          "format": "text",
          "settings": {
            "text": {
              "recordStartTimestampFormat": "ISO 8601"
            }
          },
          "name": "myTabularLogDataSource"
        }
      ]
    },
    "destinations": {
      "logAnalytics": [
        {
          "workspaceResourceId": "/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.OperationalInsights/workspaces/centralTeamWorkspace",
          "workspaceId": "9ba8bc53-bd36-4156-8667-e983e7ae0e4f",
          "name": "centralWorkspace"
        }
      ]
    },
    "dataFlows": [
      {
        "streams": [
          "Custom-TabularDataABC"
        ],
        "destinations": [
          "centralWorkspace"
        ],
        "transformKql": "source | extend LookupData = lookup_string_am('mytextdatastore', Message) | project TimeGenerated, Message, AdditionalContext = LookupData.Message",
        "outputStream": "Custom-LOGS1_CL"
      }
    ],
    "provisioningState": "Succeeded"
  },
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2024-01-30T17:50:40.5383301Z",
    "lastModifiedBy": "user1",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-01-30T17:50:40.5383301Z"
  },
  "etag": "070057da-0000-0000-0000-5ba70d6c0000"
}

状態コード:: 201

{
  "id": "/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.Insights/dataCollectionRules/myCollectionRule",
  "name": "myCollectionRule",
  "type": "Microsoft.Insights/dataCollectionRules",
  "location": "eastus",
  "properties": {
    "description": "A rule showcasing ingestion time enrichment",
    "immutableId": "dcr-ad96300ff0734d08a6a7195eb2be0000",
    "dataCollectionEndpointId": "/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.Insights/dataCollectionEndpoints/myDataCollectionEndpoint",
    "references": {
      "enrichmentData": {
        "storageBlobs": [
          {
            "resourceId": "/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourcegroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myenrichmentstorage",
            "blobUrl": "https://myenrichmentstorage.blob.core.windows.net/enrichment",
            "lookupType": "String",
            "name": "mytextdatastore"
          }
        ]
      }
    },
    "streamDeclarations": {
      "Custom-TabularDataABC": {
        "columns": [
          {
            "name": "TimeGenerated",
            "type": "datetime"
          },
          {
            "name": "Message",
            "type": "string"
          },
          {
            "name": "AdditionalContext",
            "type": "string"
          }
        ]
      }
    },
    "dataSources": {
      "logFiles": [
        {
          "streams": [
            "Custom-TabularDataABC"
          ],
          "filePatterns": [
            "C:\\JavaLogs\\*\\*.log"
          ],
          "format": "text",
          "settings": {
            "text": {
              "recordStartTimestampFormat": "ISO 8601"
            }
          },
          "name": "myTabularLogDataSource"
        }
      ]
    },
    "destinations": {
      "logAnalytics": [
        {
          "workspaceResourceId": "/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.OperationalInsights/workspaces/centralTeamWorkspace",
          "workspaceId": "9ba8bc53-bd36-4156-8667-e983e7ae0e4f",
          "name": "centralWorkspace"
        }
      ]
    },
    "dataFlows": [
      {
        "streams": [
          "Custom-TabularDataABC"
        ],
        "destinations": [
          "centralWorkspace"
        ],
        "transformKql": "source | extend LookupData = lookup_string_am('mytextdatastore', Message) | project TimeGenerated, Message, AdditionalContext = LookupData.Message",
        "outputStream": "Custom-LOGS1_CL"
      }
    ],
    "provisioningState": "Succeeded"
  },
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2024-01-30T17:50:40.5383301Z",
    "lastModifiedBy": "user1",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-01-30T17:50:40.5383301Z"
  },
  "etag": "070057da-0000-0000-0000-5ba70d6c0000"
}

定義

名前	説明
AdxDestination	Azure Data Explorer (Adx) の変換先。
AgentSetting	ホストコンピューターでのエージェントの動作を制御するために使用される設定
AgentSettings	特定のホストでのエージェントの動作を変更するために使用されるエージェント設定
AzureMonitorMetrics	Azure Monitor メトリックの宛先。
ColumnDefinition	カスタムデータ列の定義。
createdByType	リソースを作成した ID の種類。
DataCollectionRuleResource	ARM で追跡される最上位レベルのリソースの定義。
DataFlow	送信先に送信されるストリームの定義。
DataImports	プルベースのデータソースの仕様
DataSources	データソースの仕様。このプロパティは省略可能であり、ルールがプロビジョニングされたエンドポイントへの直接呼び出しで使用される場合は省略できます。
Destinations	変換先の指定。
Endpoints	このルールを使用してデータを送信するインジェストエンドポイントを定義します。
EnrichmentData	データフローで参照されるすべてのエンリッチメントデータソース
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponseCommonV2	エラー応答
EventHub	イベントハブ構成の定義。
EventHubDestination
EventHubDirectDestination
ExtensionDataSource	Azure Monitor エージェントと統合される別の VM 拡張機能から収集されるデータの定義。定義されている拡張機能に応じて、Windows マシンと Linux マシンから収集されます。
Identity	リソースのマネージドサービス ID。
IisLogsDataSource	このデータ収集規則によって IIS ログを収集できるようにします。
KnownAgentSettingName	設定の名前。サポートされている設定の一覧に含まれている必要があります
KnownColumnDefinitionType	列データの型。
KnownDataCollectionRuleProvisioningState	リソースのプロビジョニング状態。
KnownDataCollectionRuleResourceKind	リソースの種類。
KnownDataFlowStreams	このデータフローのストリームの一覧。
KnownExtensionDataSourceStreams	このデータソースが送信されるストリームの一覧。ストリームは、このデータに使用されるスキーマと、通常、データの送信先となる Log Analytics のテーブルを示します。
KnownLogFilesDataSourceFormat	ログファイルのデータ形式
KnownLogFileTextSettingsRecordStartTimestampFormat	サポートされているタイムスタンプ形式の 1 つ
KnownPerfCounterDataSourceStreams	このデータソースが送信されるストリームの一覧。ストリームは、このデータに使用されるスキーマと、通常、データの送信先となる Log Analytics のテーブルを示します。
KnownPrometheusForwarderDataSourceStreams	このデータソースが送信されるストリームの一覧。
KnownStorageBlobLookupType	BLOB で実行する参照の種類
KnownSyslogDataSourceFacilityNames	施設名の一覧。
KnownSyslogDataSourceLogLevels	収集するログレベル。
KnownSyslogDataSourceStreams	このデータソースが送信されるストリームの一覧。ストリームは、このデータに使用されるスキーマと、通常、データの送信先となる Log Analytics のテーブルを示します。
KnownWindowsEventLogDataSourceStreams	このデータソースが送信されるストリームの一覧。ストリームは、このデータに使用されるスキーマと、通常、データの送信先となる Log Analytics のテーブルを示します。
KnownWindowsFirewallLogsDataSourceProfileFilter	ファイアウォールログプロファイルフィルター
LogAnalyticsDestination	Log Analytics の宛先。
LogFilesDataSource	このデータ収集規則によって収集されるカスタムログファイルの定義
ManagedServiceIdentityType	マネージドサービス ID の種類 (SystemAssigned 型と UserAssigned 型の両方が許可されます)。
Metadata	リソースに関するメタデータ
MicrosoftFabricDestination	Microsoft Fabric の宛先 (Azure 以外)。
MonitoringAccountDestination	監視アカウントの宛先。
PerfCounterDataSource	収集されるパフォーマンスカウンターと、このデータ収集規則によって収集される方法の定義。カウンターが存在する Windows マシンと Linux マシンの両方から収集されます。
PlatformTelemetryDataSource	プラットフォームテレメトリデータソース構成の定義
PrometheusForwarderDataSource	Prometheus メトリック転送構成の定義。
References	DCR の他のセクションで使用できるすべての参照を定義します。
Settings	ログファイル固有の設定。
StorageBlob
StorageBlobDestination
StorageTableDestination
StreamDeclaration	カスタムストリームの宣言。
SyslogDataSource	収集する Syslog データと収集方法の定義。 Linux マシンからのみ収集されます。
SystemData	リソースの作成と最後の変更に関連するメタデータ。
Text	テキスト設定
UserAssignedIdentity	ユーザー割り当て ID プロパティ
WindowsEventLogDataSource	収集する Windows イベントログイベントの定義と、その収集方法。 Windows マシンからのみ収集されます。
WindowsFirewallLogsDataSource	このデータ収集規則によってファイアウォールログを収集できるようにします。

AdxDestination

Object

Azure Data Explorer (Adx) の変換先。

名前	型	説明
databaseName	string	データの取り込み先となるデータベースの名前。
ingestionUri	string	Adx リソースのインジェスト URI。
name	string	宛先のフレンドリ名。この名前は、データ収集規則内のすべての宛先 (種類に関係なく) で一意である必要があります。
resourceId	string	Adx リソースの ARM リソース ID。

AgentSetting

Object

ホストコンピューターでのエージェントの動作を制御するために使用される設定

名前	型	説明
name	KnownAgentSettingName	設定の名前。サポートされている設定の一覧に含まれている必要があります
value	string	設定の値

AgentSettings

Object

特定のホストでのエージェントの動作を変更するために使用されるエージェント設定

名前	型	説明
logs	AgentSetting[]	ログエージェント (AMA) に適用されるすべての設定

AzureMonitorMetrics

Object

Azure Monitor メトリックの宛先。

名前	型	説明
name	string	宛先のフレンドリ名。この名前は、データ収集規則内のすべての宛先 (種類に関係なく) で一意である必要があります。

ColumnDefinition

Object

カスタムデータ列の定義。

名前	型	説明
name	string	列の名前。
type	KnownColumnDefinitionType	列データの型。

createdByType

列挙

リソースを作成した ID の種類。

値	説明
User
Application
ManagedIdentity
Key

DataCollectionRuleResource

Object

ARM で追跡される最上位レベルのリソースの定義。

名前	型	説明
etag	string	リソースエンティティタグ (ETag)。
id	string	リソースの完全修飾 ID。
identity	Identity	リソースのマネージドサービス ID。
kind	KnownDataCollectionRuleResourceKind	リソースの種類。
location	string	リソースが存在する地理的な場所。
name	string	リソースの名前。
properties.agentSettings	AgentSettings	特定のホストでのエージェントの動作を変更するために使用されるエージェント設定
properties.dataCollectionEndpointId	string	このルールを使用できるデータ収集エンドポイントのリソース ID。
properties.dataFlows	DataFlow[]	データフローの仕様。
properties.dataSources	DataSources	データソースの仕様。このプロパティは省略可能であり、ルールがプロビジョニングされたエンドポイントへの直接呼び出しで使用される場合は省略できます。
properties.description	string	データ収集規則の説明。
properties.destinations	Destinations	変換先の指定。
properties.endpoints	Endpoints	このルールを使用してデータを送信するインジェストエンドポイントを定義します。
properties.immutableId	string	このデータ収集規則の変更できない ID。このプロパティは読み取り専用です。
properties.metadata	Metadata	リソースに関するメタデータ
properties.provisioningState	KnownDataCollectionRuleProvisioningState	リソースのプロビジョニング状態。
properties.references	References	DCR の他のセクションで使用できるすべての参照を定義します。
properties.streamDeclarations	<string, StreamDeclaration>	この規則で使用されるカスタムストリームの宣言。
systemData	SystemData	リソースの作成と最後の変更に関連するメタデータ。
tags	object	リソースタグ。
type	string	リソースの種類。

DataFlow

Object

送信先に送信されるストリームの定義。

名前	型	説明
builtInTransform	string	ストリームデータを変換する builtIn 変換
captureOverflow	boolean	LA 宛先でオーバーフロー列を有効にするフラグ
destinations	string[]	このデータフローの宛先の一覧。
outputStream	string	変換の出力ストリーム。変換がデータを別のストリームに変更する場合にのみ必要です。
streams	KnownDataFlowStreams[]	このデータフローのストリームの一覧。
transformKql	string	ストリームデータを変換する KQL クエリ。

DataImports

Object

プルベースのデータソースの仕様

名前	型	説明
eventHub	EventHub	イベントハブ構成の定義。

DataSources

Object

データソースの仕様。このプロパティは省略可能であり、ルールがプロビジョニングされたエンドポイントへの直接呼び出しで使用される場合は省略できます。

名前	型	説明
dataImports	DataImports	プルベースのデータソースの仕様
extensions	ExtensionDataSource[]	Azure VM 拡張機能のデータソース構成の一覧。
iisLogs	IisLogsDataSource[]	IIS ログのソース構成の一覧。
logFiles	LogFilesDataSource[]	ログファイルのソース構成の一覧。
performanceCounters	PerfCounterDataSource[]	パフォーマンスカウンターのデータソース構成の一覧。
platformTelemetry	PlatformTelemetryDataSource[]	プラットフォームテレメトリ構成の一覧
prometheusForwarder	PrometheusForwarderDataSource[]	Prometheus フォワーダーデータソース構成の一覧。
syslog	SyslogDataSource[]	Syslog データソース構成の一覧。
windowsEventLogs	WindowsEventLogDataSource[]	Windows イベントログのデータソース構成の一覧。
windowsFirewallLogs	WindowsFirewallLogsDataSource[]	Windows ファイアウォールログのソース構成の一覧。

Destinations

Object

変換先の指定。

名前	型	説明
azureDataExplorer	AdxDestination[]	Azure Data Explorer の宛先の一覧。
azureMonitorMetrics	AzureMonitorMetrics	Azure Monitor メトリックの宛先。
eventHubs	EventHubDestination[]	Event Hubs の宛先の一覧。
eventHubsDirect	EventHubDirectDestination[]	Event Hubs Direct の宛先の一覧。
logAnalytics	LogAnalyticsDestination[]	Log Analytics の宛先の一覧。
microsoftFabric	MicrosoftFabricDestination[]	Microsoft Fabric の宛先の一覧。
monitoringAccounts	MonitoringAccountDestination[]	監視アカウントの宛先の一覧。
storageAccounts	StorageBlobDestination[]	ストレージアカウントの宛先の一覧。
storageBlobsDirect	StorageBlobDestination[]	ストレージ BLOB ダイレクトの宛先の一覧。エージェントから格納するデータを直接送信する場合にのみ使用します。
storageTablesDirect	StorageTableDestination[]	ストレージテーブルダイレクトの宛先の一覧。

Endpoints

Object

このルールを使用してデータを送信するインジェストエンドポイントを定義します。

名前	型	説明
logsIngestion	string	ログのインジェストエンドポイント
metricsIngestion	string	メトリックのインジェストエンドポイント

EnrichmentData

Object

データフローで参照されるすべてのエンリッチメントデータソース

名前	型	説明
storageBlobs	StorageBlob[]	エンリッチメントデータソースとして使用されるすべてのストレージ BLOB

ErrorAdditionalInfo

Object

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラーコード。
details	ErrorDetail[]	エラーの詳細。
message	string	エラーメッセージ。
target	string	エラーターゲット。

ErrorResponseCommonV2

Object

エラー応答

名前	型	説明
error	ErrorDetail	エラーオブジェクト。

EventHub

Object

イベントハブ構成の定義。

名前	型	説明
consumerGroup	string	Event Hub コンシューマーグループ名
name	string	データソースのフレンドリ名。この名前は、データ収集規則内のすべてのデータソース (種類に関係なく) で一意である必要があります。
stream	string	EventHub から収集するストリーム

EventHubDestination

Object

名前	型	説明
eventHubResourceId	string	イベントハブのリソース ID。
name	string	宛先のフレンドリ名。この名前は、データ収集規則内のすべての宛先 (種類に関係なく) で一意である必要があります。

EventHubDirectDestination

Object

名前	型	説明
eventHubResourceId	string	イベントハブのリソース ID。
name	string	宛先のフレンドリ名。この名前は、データ収集規則内のすべての宛先 (種類に関係なく) で一意である必要があります。

ExtensionDataSource

Object

Azure Monitor エージェントと統合される別の VM 拡張機能から収集されるデータの定義。定義されている拡張機能に応じて、Windows マシンと Linux マシンから収集されます。

名前	型	説明
extensionName	string	VM 拡張機能の名前。
extensionSettings	object	拡張機能の設定。この形式は、特定の拡張機能に固有です。
inputDataSources	string[]	この拡張機能に必要なデータソースの一覧。
name	string	データソースのフレンドリ名。この名前は、データ収集規則内のすべてのデータソース (種類に関係なく) で一意である必要があります。
streams	KnownExtensionDataSourceStreams[]	このデータソースが送信されるストリームの一覧。ストリームは、このデータに使用されるスキーマと、通常、データの送信先となる Log Analytics のテーブルを示します。

Identity

Object

リソースのマネージドサービス ID。

名前	型	説明
principalId	string (uuid)	システム割り当て ID のサービスプリンシパル ID。このプロパティは、システム割り当て ID にのみ提供されます。
tenantId	string (uuid)	システム割り当て ID のテナント ID。このプロパティは、システム割り当て ID にのみ提供されます。
type	ManagedServiceIdentityType	マネージドサービス ID の種類 (SystemAssigned 型と UserAssigned 型の両方が許可されます)。
userAssignedIdentities	<string, UserAssignedIdentity>	User-Assigned ID リソースに関連付けられているユーザー割り当て ID のセット。 userAssignedIdentities ディクショナリキーは、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} という形式の ARM リソース ID になります。ディクショナリ値は、要求内の空のオブジェクト ({}) にすることができます。

IisLogsDataSource

Object

このデータ収集規則によって IIS ログを収集できるようにします。

名前	型	説明
logDirectories	string[]	絶対パスファイルの場所
name	string	データソースのフレンドリ名。この名前は、データ収集規則内のすべてのデータソース (種類に関係なく) で一意である必要があります。
streams	string[]	IIS ストリーム
transformKql	string	データソースを変換する KQL クエリ。

KnownAgentSettingName

列挙

設定の名前。サポートされている設定の一覧に含まれている必要があります

値	説明
MaxDiskQuotaInMB
UseTimeReceivedForForwardedEvents

KnownColumnDefinitionType

列挙

列データの型。

値	説明
string
int
long
real
boolean
datetime
dynamic

KnownDataCollectionRuleProvisioningState

列挙

リソースのプロビジョニング状態。

値	説明
Creating
Updating
Deleting
Succeeded
Canceled
Failed

KnownDataCollectionRuleResourceKind

列挙

リソースの種類。

値	説明
Linux
Windows

KnownDataFlowStreams

列挙

このデータフローのストリームの一覧。

値	説明
Microsoft-Event
Microsoft-InsightsMetrics
Microsoft-Perf
Microsoft-Syslog
Microsoft-WindowsEvent

KnownExtensionDataSourceStreams

列挙

このデータソースが送信されるストリームの一覧。ストリームは、このデータに使用されるスキーマと、通常、データの送信先となる Log Analytics のテーブルを示します。

値	説明
Microsoft-Event
Microsoft-InsightsMetrics
Microsoft-Perf
Microsoft-Syslog
Microsoft-WindowsEvent

KnownLogFilesDataSourceFormat

列挙

ログファイルのデータ形式

値	説明
json
text

KnownLogFileTextSettingsRecordStartTimestampFormat

列挙

サポートされているタイムスタンプ形式の 1 つ

値	説明
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

列挙

値	説明
Microsoft-Perf
Microsoft-InsightsMetrics

KnownPrometheusForwarderDataSourceStreams

列挙

このデータソースが送信されるストリームの一覧。

値	説明
Microsoft-PrometheusMetrics

KnownStorageBlobLookupType

列挙

BLOB で実行する参照の種類

値	説明
String
Cidr

KnownSyslogDataSourceFacilityNames

列挙

施設名の一覧。

値	説明
*
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

列挙

収集するログレベル。

値	説明
Debug
Info
Notice
Warning
Error
Critical
Alert
Emergency
*

KnownSyslogDataSourceStreams

列挙

値	説明
Microsoft-Syslog

KnownWindowsEventLogDataSourceStreams

列挙

値	説明
Microsoft-WindowsEvent
Microsoft-Event

KnownWindowsFirewallLogsDataSourceProfileFilter

列挙

ファイアウォールログプロファイルフィルター

値	説明
Domain
Private
Public

LogAnalyticsDestination

Object

Log Analytics の宛先。

名前	型	説明
name	string	宛先のフレンドリ名。この名前は、データ収集規則内のすべての宛先 (種類に関係なく) で一意である必要があります。
workspaceId	string	Log Analytics ワークスペースの顧客 ID。
workspaceResourceId	string	Log Analytics ワークスペースのリソース ID。

LogFilesDataSource

Object

このデータ収集規則によって収集されるカスタムログファイルの定義

名前	型	説明
filePatterns	string[]	ログファイルが配置されているファイルパターン
format	KnownLogFilesDataSourceFormat	ログファイルのデータ形式
name	string	データソースのフレンドリ名。この名前は、データ収集規則内のすべてのデータソース (種類に関係なく) で一意である必要があります。
settings	Settings	ログファイル固有の設定。
streams	string[]	このデータソースが送信されるストリームの一覧。ストリームは、このデータソースに使用されるスキーマを示します
transformKql	string	データソースを変換する KQL クエリ。

ManagedServiceIdentityType

列挙

マネージドサービス ID の種類 (SystemAssigned 型と UserAssigned 型の両方が許可されます)。

値	説明
None
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned

Metadata

Object

リソースに関するメタデータ

名前	型	説明
provisionedBy	string	このリソースを顧客に代わって管理する Azure オファリング。
provisionedByImmutableId	string	顧客に代わってこのリソースを管理する Azure オファリングの不変 ID。
provisionedByResourceId	string	このリソースを顧客に代わって管理する Azure オファリングのリソース ID。

MicrosoftFabricDestination

Object

Microsoft Fabric の宛先 (Azure 以外)。

名前	型	説明
artifactId	string	Microsoft Fabric リソースの成果物 ID。
databaseName	string	データの取り込み先となるデータベースの名前。
ingestionUri	string	Microsoft Fabric リソースのインジェスト URI。
name	string	宛先のフレンドリ名。この名前は、データ収集規則内のすべての宛先 (種類に関係なく) で一意である必要があります。
tenantId	string	Microsoft Fabric リソースのテナント ID。

MonitoringAccountDestination

Object

監視アカウントの宛先。

名前	型	説明
accountId	string	アカウントの変更できない ID。
accountResourceId	string	監視アカウントのリソース ID。
name	string	宛先のフレンドリ名。この名前は、データ収集規則内のすべての宛先 (種類に関係なく) で一意である必要があります。

PerfCounterDataSource

Object

収集されるパフォーマンスカウンターと、このデータ収集規則によって収集される方法の定義。カウンターが存在する Windows マシンと Linux マシンの両方から収集されます。

名前	型	説明
counterSpecifiers	string[]	収集するパフォーマンスカウンターの指定子名の一覧。ワイルドカード (*) を使用して、すべてのインスタンスのカウンターを収集します。 Windows でパフォーマンスカウンターの一覧を取得するには、コマンド 'typeperf' を実行します。
name	string	データソースのフレンドリ名。この名前は、データ収集規則内のすべてのデータソース (種類に関係なく) で一意である必要があります。
samplingFrequencyInSeconds	integer (int32)	連続するカウンター測定 (サンプル) 間の秒数。
streams	KnownPerfCounterDataSourceStreams[]	このデータソースが送信されるストリームの一覧。ストリームは、このデータに使用されるスキーマと、通常、データの送信先となる Log Analytics のテーブルを示します。
transformKql	string	データソースを変換する KQL クエリ。

PlatformTelemetryDataSource

Object

プラットフォームテレメトリデータソース構成の定義

名前	型	説明
name	string	データソースのフレンドリ名。この名前は、データ収集規則内のすべてのデータソース (種類に関係なく) で一意である必要があります。
streams	string[]	収集するプラットフォームテレメトリストリームの一覧

PrometheusForwarderDataSource

Object

Prometheus メトリック転送構成の定義。

名前	型	説明
labelIncludeFilter	object	ラベル "名前と値" のペアの形式のラベル包含フィルターの一覧。現在サポートされているラベルは 1 つだけです:'microsoft_metrics_include_label'。ラベルの値は大文字と小文字が区別されずに照合されます。
name	string	データソースのフレンドリ名。この名前は、データ収集規則内のすべてのデータソース (種類に関係なく) で一意である必要があります。
streams	KnownPrometheusForwarderDataSourceStreams[]	このデータソースが送信されるストリームの一覧。

References

Object

DCR の他のセクションで使用できるすべての参照を定義します。

名前	型	説明
enrichmentData	EnrichmentData	データフローで参照されるすべてのエンリッチメントデータソース

Settings

Object

ログファイル固有の設定。

名前	型	説明
text	Text	テキスト設定

StorageBlob

Object

名前	型	説明
blobUrl	string	ストレージ BLOB の URL
lookupType	KnownStorageBlobLookupType	BLOB で実行する参照の種類
name	string	データフローでこのデータソースを参照するときにエイリアスとして使用されるエンリッチメントデータソースの名前
resourceId	string	BLOB をホストするストレージアカウントのリソース ID

StorageBlobDestination

Object

名前	型	説明
containerName	string	ストレージ BLOB のコンテナー名。
name	string	宛先のフレンドリ名。この名前は、データ収集規則内のすべての宛先 (種類に関係なく) で一意である必要があります。
storageAccountResourceId	string	ストレージアカウントのリソース ID。

StorageTableDestination

Object

名前	型	説明
name	string	宛先のフレンドリ名。この名前は、データ収集規則内のすべての宛先 (種類に関係なく) で一意である必要があります。
storageAccountResourceId	string	ストレージアカウントのリソース ID。
tableName	string	ストレージテーブルの名前。

StreamDeclaration

Object

カスタムストリームの宣言。

名前	型	説明
columns	ColumnDefinition[]	このストリーム内のデータによって使用される列の一覧。

SyslogDataSource

Object

収集する Syslog データと収集方法の定義。 Linux マシンからのみ収集されます。

名前	型	説明
facilityNames	KnownSyslogDataSourceFacilityNames[]	施設名の一覧。
logLevels	KnownSyslogDataSourceLogLevels[]	収集するログレベル。
name	string	データソースのフレンドリ名。この名前は、データ収集規則内のすべてのデータソース (種類に関係なく) で一意である必要があります。
streams	KnownSyslogDataSourceStreams[]	このデータソースが送信されるストリームの一覧。ストリームは、このデータに使用されるスキーマと、通常、データの送信先となる Log Analytics のテーブルを示します。
transformKql	string	データソースを変換する KQL クエリ。

SystemData

Object

リソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
createdAt	string (date-time)	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string (date-time)	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。

Text

Object

テキスト設定

名前	型	説明
recordStartTimestampFormat	KnownLogFileTextSettingsRecordStartTimestampFormat	サポートされているタイムスタンプ形式の 1 つ

UserAssignedIdentity

Object

ユーザー割り当て ID プロパティ

名前	型	説明
clientId	string (uuid)	割り当てられた ID のクライアント ID。
principalId	string (uuid)	割り当てられた ID のプリンシパル ID。

WindowsEventLogDataSource

Object

収集する Windows イベントログイベントの定義と、その収集方法。 Windows マシンからのみ収集されます。

名前	型	説明
name	string	データソースのフレンドリ名。この名前は、データ収集規則内のすべてのデータソース (種類に関係なく) で一意である必要があります。
streams	KnownWindowsEventLogDataSourceStreams[]	このデータソースが送信されるストリームの一覧。ストリームは、このデータに使用されるスキーマと、通常、データの送信先となる Log Analytics のテーブルを示します。
transformKql	string	データソースを変換する KQL クエリ。
xPathQueries	string[]	XPATH 形式の Windows イベントログクエリの一覧。

WindowsFirewallLogsDataSource

Object

このデータ収集規則によってファイアウォールログを収集できるようにします。

名前	型	説明
name	string	データソースのフレンドリ名。この名前は、データ収集規則内のすべてのデータソース (種類に関係なく) で一意である必要があります。
profileFilter	KnownWindowsFirewallLogsDataSourceProfileFilter[]	ファイアウォールログプロファイルフィルター
streams	string[]	ファイアウォールログストリーム

次の方法で共有

Data Collection Rules - Create

URI パラメーター

要求本文

応答

セキュリティ

azure_auth

スコープ

例

Create or update an agent settings configuration

要求のサンプル

応答のサンプル

Create or update data collection rule

要求のサンプル

応答のサンプル

Create or update data collection rule with embedded ingestion endpoints

要求のサンプル

応答のサンプル

Create or update data collection rule with enrichment

要求のサンプル

応答のサンプル

定義

AdxDestination

AgentSetting

AgentSettings

AzureMonitorMetrics

ColumnDefinition

createdByType

DataCollectionRuleResource

DataFlow

DataImports

DataSources

Destinations

Endpoints

EnrichmentData

ErrorAdditionalInfo

ErrorDetail

ErrorResponseCommonV2

EventHub

EventHubDestination

EventHubDirectDestination

ExtensionDataSource

Identity

IisLogsDataSource

KnownAgentSettingName

KnownColumnDefinitionType

KnownDataCollectionRuleProvisioningState

KnownDataCollectionRuleResourceKind

KnownDataFlowStreams

KnownExtensionDataSourceStreams

KnownLogFilesDataSourceFormat

KnownLogFileTextSettingsRecordStartTimestampFormat

KnownPerfCounterDataSourceStreams

KnownPrometheusForwarderDataSourceStreams

KnownStorageBlobLookupType

KnownSyslogDataSourceFacilityNames

KnownSyslogDataSourceLogLevels

KnownSyslogDataSourceStreams

KnownWindowsEventLogDataSourceStreams

KnownWindowsFirewallLogsDataSourceProfileFilter

LogAnalyticsDestination

LogFilesDataSource

ManagedServiceIdentityType

Metadata

MicrosoftFabricDestination

MonitoringAccountDestination

PerfCounterDataSource

PlatformTelemetryDataSource

PrometheusForwarderDataSource

References

Settings

StorageBlob

StorageBlobDestination

StorageTableDestination

StreamDeclaration

SyslogDataSource

SystemData

Text

UserAssignedIdentity

WindowsEventLogDataSource