Data Collection Rules - Create

Servicio:: Monitor

Versión de la API:: 2023-03-11

Crea o actualiza una regla de recopilación de datos.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
dataCollectionRuleName	path	True	string	Nombre de la regla de recopilación de datos. El nombre no distingue mayúsculas de minúsculas.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.
subscriptionId	path	True	string minLength: 1	Identificador de la suscripción de destino.
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta operación.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
location	True	string	Ubicación geográfica donde reside el recurso.
identity		Identity	Identidad de servicio administrada del recurso.
kind		KnownDataCollectionRuleResourceKind	Tipo del recurso.
properties.agentSettings		AgentSettings	Configuración del agente usada para modificar el comportamiento del agente en un host determinado
properties.dataCollectionEndpointId		string	Identificador de recurso del punto de conexión de recopilación de datos con el que se puede usar esta regla.
properties.dataFlows		DataFlow[]	Especificación de flujos de datos.
properties.dataSources		DataSources	Especificación de orígenes de datos. Esta propiedad es opcional y se puede omitir si la regla está pensada para usarse a través de llamadas directas al punto de conexión aprovisionado.
properties.description		string	Descripción de la regla de recopilación de datos.
properties.destinations		Destinations	Especificación de destinos.
properties.references		References	Define todas las referencias que se pueden usar en otras secciones del DCR.
properties.streamDeclarations		<string, StreamDeclaration>	Declaración de flujos personalizados usados en esta regla.
tags		object	Etiquetas de recursos.

Respuestas

Nombre	Tipo	Description
200 OK	DataCollectionRuleResource	La regla de recopilación de datos se actualizó correctamente
201 Created	DataCollectionRuleResource	La regla de recopilación de datos se creó correctamente
Other Status Codes	ErrorResponseCommonV2	Error

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

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

Respuesta de muestra

status code:: 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"
}

status code:: 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

Solicitud de ejemplo

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

Respuesta de muestra

status code:: 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"
}

status code:: 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

Solicitud de ejemplo

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

Respuesta de muestra

status code:: 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"
}

status code:: 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

Solicitud de ejemplo

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

Respuesta de muestra

status code:: 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"
}

status code:: 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"
}

Definiciones

Nombre	Description
AdxDestination	Destino de Azure Data Explorer (Adx).
AgentSetting	Configuración que se usa para controlar el comportamiento de un agente en una máquina host
AgentSettings	Configuración del agente usada para modificar el comportamiento del agente en un host determinado
AzureMonitorMetrics	Destino de métricas de Azure Monitor.
ColumnDefinition	Definición de la columna de datos personalizada.
createdByType	Tipo de identidad que creó el recurso.
DataCollectionRuleResource	Definición del recurso de nivel superior con seguimiento de ARM.
DataFlow	Definición de qué flujos se envían a qué destinos.
DataImports	Especificaciones de orígenes de datos basados en extracción
DataSources	Especificación de orígenes de datos. Esta propiedad es opcional y se puede omitir si la regla está pensada para usarse a través de llamadas directas al punto de conexión aprovisionado.
Destinations	Especificación de destinos.
Endpoints	Define los puntos de conexión de ingesta a los que se van a enviar datos a través de esta regla.
EnrichmentData	Todos los orígenes de datos de enriquecimiento a los que se hace referencia en los flujos de datos
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponseCommonV2	Respuesta de error
EventHub	Definición de la configuración del centro de eventos.
EventHubDestination
EventHubDirectDestination
ExtensionDataSource	Definición de los datos que se recopilarán de una extensión de máquina virtual independiente que se integre con el agente de Azure Monitor. Se recopilan de máquinas Windows y Linux, en función de la extensión definida.
Identity	Identidad de servicio administrada del recurso.
IisLogsDataSource	Permite recopilar registros de IIS mediante esta regla de recopilación de datos.
KnownAgentSettingName	Nombre de la configuración. Debe formar parte de la lista de configuraciones admitidas.
KnownColumnDefinitionType	Tipo de los datos de columna.
KnownDataCollectionRuleProvisioningState	Estado de aprovisionamiento de recursos.
KnownDataCollectionRuleResourceKind	Tipo del recurso.
KnownDataFlowStreams	Lista de secuencias para este flujo de datos.
KnownExtensionDataSourceStreams	Lista de secuencias a las que se enviará este origen de datos. Una secuencia indica a qué esquema se usará para estos datos y, normalmente, a qué tabla de Log Analytics se enviarán los datos.
KnownLogFilesDataSourceFormat	Formato de datos de los archivos de registro
KnownLogFileTextSettingsRecordStartTimestampFormat	Uno de los formatos de marca de tiempo admitidos
KnownPerfCounterDataSourceStreams	Lista de secuencias a las que se enviará este origen de datos. Una secuencia indica a qué esquema se usará para estos datos y, normalmente, a qué tabla de Log Analytics se enviarán los datos.
KnownPrometheusForwarderDataSourceStreams	Lista de secuencias a las que se enviará este origen de datos.
KnownStorageBlobLookupType	Tipo de búsqueda que se va a realizar en el blob
KnownSyslogDataSourceFacilityNames	Lista de nombres de instalación.
KnownSyslogDataSourceLogLevels	Niveles de registro que se van a recopilar.
KnownSyslogDataSourceStreams	Lista de secuencias a las que se enviará este origen de datos. Una secuencia indica a qué esquema se usará para estos datos y, normalmente, a qué tabla de Log Analytics se enviarán los datos.
KnownWindowsEventLogDataSourceStreams	Lista de secuencias a las que se enviará este origen de datos. Una secuencia indica a qué esquema se usará para estos datos y, normalmente, a qué tabla de Log Analytics se enviarán los datos.
KnownWindowsFirewallLogsDataSourceProfileFilter	Filtro de perfil de registros de firewall
LogAnalyticsDestination	Destino de Log Analytics.
LogFilesDataSource	Definición de los archivos de registro personalizados que recopilará esta regla de recopilación de datos
ManagedServiceIdentityType	Tipo de identidad de servicio administrada (donde se permiten los tipos SystemAssigned y UserAssigned).
Metadata	Metadatos sobre el recurso
MicrosoftFabricDestination	Destino de Microsoft Fabric (que no es de Azure).
MonitoringAccountDestination	Destino de la cuenta de supervisión.
PerfCounterDataSource	Definición de qué contadores de rendimiento se recopilarán y cómo se recopilarán mediante esta regla de recopilación de datos. Se recopilan de máquinas Windows y Linux en las que el contador está presente.
PlatformTelemetryDataSource	Definición de la configuración del origen de datos de telemetría de la plataforma
PrometheusForwarderDataSource	Definición de la configuración de reenvío de métricas de Prometheus.
References	Define todas las referencias que se pueden usar en otras secciones del DCR.
Settings	Configuración específica de los archivos de registro.
StorageBlob
StorageBlobDestination
StorageTableDestination
StreamDeclaration	Declaración de una secuencia personalizada.
SyslogDataSource	Definición de los datos de syslog que se recopilarán y cómo se recopilarán. Solo se recopilan de máquinas Linux.
SystemData	Metadatos relativos a la creación y última modificación del recurso.
Text	Configuración de texto
UserAssignedIdentity	Propiedades de identidad asignadas por el usuario
WindowsEventLogDataSource	Definición de los eventos del registro de eventos de Windows que se recopilarán y cómo se recopilarán. Solo se recopilan de máquinas Windows.
WindowsFirewallLogsDataSource	Permite recopilar registros de firewall mediante esta regla de recopilación de datos.

AdxDestination

Objeto

Destino de Azure Data Explorer (Adx).

Nombre	Tipo	Description
databaseName	string	Nombre de la base de datos a la que se ingerirán los datos.
ingestionUri	string	Identificador URI de ingesta del recurso Adx.
name	string	Nombre descriptivo para el destino. Este nombre debe ser único en todos los destinos (independientemente del tipo) dentro de la regla de recopilación de datos.
resourceId	string	Identificador de recurso de ARM del recurso de Adx.

AgentSetting

Objeto

Configuración que se usa para controlar el comportamiento de un agente en una máquina host

Nombre	Tipo	Description
name	KnownAgentSettingName	Nombre de la configuración. Debe formar parte de la lista de configuraciones admitidas.
value	string	Valor de la configuración

AgentSettings

Objeto

Configuración del agente usada para modificar el comportamiento del agente en un host determinado

Nombre	Tipo	Description
logs	AgentSetting[]	Toda la configuración que se aplica al agente de registros (AMA)

AzureMonitorMetrics

Objeto

Destino de métricas de Azure Monitor.

Nombre	Tipo	Description
name	string	Nombre descriptivo para el destino. Este nombre debe ser único en todos los destinos (independientemente del tipo) dentro de la regla de recopilación de datos.

ColumnDefinition

Objeto

Definición de la columna de datos personalizada.

Nombre	Tipo	Description
name	string	Nombre de la columna.
type	KnownColumnDefinitionType	Tipo de los datos de columna.

createdByType

Enumeración

Tipo de identidad que creó el recurso.

Valor	Description
User
Application
ManagedIdentity
Key

DataCollectionRuleResource

Objeto

Definición del recurso de nivel superior con seguimiento de ARM.

Nombre	Tipo	Description
etag	string	Etiqueta de entidad de recurso (ETag).
id	string	Identificador completo del recurso.
identity	Identity	Identidad de servicio administrada del recurso.
kind	KnownDataCollectionRuleResourceKind	Tipo del recurso.
location	string	Ubicación geográfica donde reside el recurso.
name	string	Nombre del recurso.
properties.agentSettings	AgentSettings	Configuración del agente usada para modificar el comportamiento del agente en un host determinado
properties.dataCollectionEndpointId	string	Identificador de recurso del punto de conexión de recopilación de datos con el que se puede usar esta regla.
properties.dataFlows	DataFlow[]	Especificación de flujos de datos.
properties.dataSources	DataSources	Especificación de orígenes de datos. Esta propiedad es opcional y se puede omitir si la regla está pensada para usarse a través de llamadas directas al punto de conexión aprovisionado.
properties.description	string	Descripción de la regla de recopilación de datos.
properties.destinations	Destinations	Especificación de destinos.
properties.endpoints	Endpoints	Define los puntos de conexión de ingesta a los que se van a enviar datos a través de esta regla.
properties.immutableId	string	Identificador inmutable de esta regla de recopilación de datos. Esta propiedad es READ-ONLY.
properties.metadata	Metadata	Metadatos sobre el recurso
properties.provisioningState	KnownDataCollectionRuleProvisioningState	Estado de aprovisionamiento de recursos.
properties.references	References	Define todas las referencias que se pueden usar en otras secciones del DCR.
properties.streamDeclarations	<string, StreamDeclaration>	Declaración de flujos personalizados usados en esta regla.
systemData	SystemData	Metadatos relativos a la creación y última modificación del recurso.
tags	object	Etiquetas de recursos.
type	string	Tipo del recurso.

DataFlow

Objeto

Definición de qué flujos se envían a qué destinos.

Nombre	Tipo	Description
builtInTransform	string	Transformación builtIn para transformar los datos del flujo
captureOverflow	boolean	Marca para habilitar la columna de desbordamiento en destinos de LA
destinations	string[]	Lista de destinos para este flujo de datos.
outputStream	string	Flujo de salida de la transformación. Solo es necesario si la transformación cambia los datos a una secuencia diferente.
streams	KnownDataFlowStreams[]	Lista de secuencias para este flujo de datos.
transformKql	string	Consulta KQL para transformar los datos de flujo.

DataImports

Objeto

Especificaciones de orígenes de datos basados en extracción

Nombre	Tipo	Description
eventHub	EventHub	Definición de la configuración del centro de eventos.

DataSources

Objeto

Especificación de orígenes de datos. Esta propiedad es opcional y se puede omitir si la regla está pensada para usarse a través de llamadas directas al punto de conexión aprovisionado.

Nombre	Tipo	Description
dataImports	DataImports	Especificaciones de orígenes de datos basados en extracción
extensions	ExtensionDataSource[]	Lista de configuraciones de orígenes de datos de extensión de máquina virtual de Azure.
iisLogs	IisLogsDataSource[]	La lista de configuraciones de origen de registros de IIS.
logFiles	LogFilesDataSource[]	Lista de configuraciones de origen de archivos de registro.
performanceCounters	PerfCounterDataSource[]	Lista de configuraciones del origen de datos del contador de rendimiento.
platformTelemetry	PlatformTelemetryDataSource[]	Lista de configuraciones de telemetría de plataforma
prometheusForwarder	PrometheusForwarderDataSource[]	Lista de configuraciones de origen de datos del reenviador de Prometheus.
syslog	SyslogDataSource[]	Lista de configuraciones de origen de datos de Syslog.
windowsEventLogs	WindowsEventLogDataSource[]	Lista de configuraciones de origen de datos del registro de eventos de Windows.
windowsFirewallLogs	WindowsFirewallLogsDataSource[]	La lista de configuraciones de origen de registros del Firewall de Windows.

Destinations

Objeto

Especificación de destinos.

Nombre	Tipo	Description
azureDataExplorer	AdxDestination[]	Lista de destinos de Azure Data Explorer.
azureMonitorMetrics	AzureMonitorMetrics	Destino de métricas de Azure Monitor.
eventHubs	EventHubDestination[]	Lista de destinos de Event Hubs.
eventHubsDirect	EventHubDirectDestination[]	Lista de destinos directos de Event Hubs.
logAnalytics	LogAnalyticsDestination[]	Lista de destinos de Log Analytics.
microsoftFabric	MicrosoftFabricDestination[]	Lista de destinos de Microsoft Fabric.
monitoringAccounts	MonitoringAccountDestination[]	Lista de destinos de cuenta de supervisión.
storageAccounts	StorageBlobDestination[]	Lista de destinos de cuentas de almacenamiento.
storageBlobsDirect	StorageBlobDestination[]	Lista de destinos de Storage Blob Direct. Para usarse solo para enviar datos directamente para almacenarlos desde el agente.
storageTablesDirect	StorageTableDestination[]	Lista de destinos de Storage Table Direct.

Endpoints

Objeto

Define los puntos de conexión de ingesta a los que se van a enviar datos a través de esta regla.

Nombre	Tipo	Description
logsIngestion	string	Punto de conexión de ingesta para registros
metricsIngestion	string	Punto de conexión de ingesta para métricas

EnrichmentData

Objeto

Todos los orígenes de datos de enriquecimiento a los que se hace referencia en los flujos de datos

Nombre	Tipo	Description
storageBlobs	StorageBlob[]	Todos los blobs de almacenamiento usados como orígenes de datos de enriquecimiento

ErrorAdditionalInfo

Objeto

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Objeto

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	Mensaje de error.
target	string	Destino del error.

ErrorResponseCommonV2

Objeto

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

EventHub

Objeto

Definición de la configuración del centro de eventos.

Nombre	Tipo	Description
consumerGroup	string	Nombre del grupo de consumidores del centro de eventos
name	string	Nombre descriptivo para el origen de datos. Este nombre debe ser único en todos los orígenes de datos (independientemente del tipo) dentro de la regla de recopilación de datos.
stream	string	Secuencia que se va a recopilar de EventHub

EventHubDestination

Objeto

Nombre	Tipo	Description
eventHubResourceId	string	Identificador de recurso del centro de eventos.
name	string	Nombre descriptivo para el destino. Este nombre debe ser único en todos los destinos (independientemente del tipo) dentro de la regla de recopilación de datos.

EventHubDirectDestination

Objeto

Nombre	Tipo	Description
eventHubResourceId	string	Identificador de recurso del centro de eventos.
name	string	Nombre descriptivo para el destino. Este nombre debe ser único en todos los destinos (independientemente del tipo) dentro de la regla de recopilación de datos.

ExtensionDataSource

Objeto

Definición de los datos que se recopilarán de una extensión de máquina virtual independiente que se integre con el agente de Azure Monitor. Se recopilan de máquinas Windows y Linux, en función de la extensión definida.

Nombre	Tipo	Description
extensionName	string	Nombre de la extensión de máquina virtual.
extensionSettings	object	Configuración de la extensión. El formato es específico para una extensión determinada.
inputDataSources	string[]	La lista de orígenes de datos de los que esta extensión necesita datos.
name	string	Nombre descriptivo para el origen de datos. Este nombre debe ser único en todos los orígenes de datos (independientemente del tipo) dentro de la regla de recopilación de datos.
streams	KnownExtensionDataSourceStreams[]	Lista de secuencias a las que se enviará este origen de datos. Una secuencia indica a qué esquema se usará para estos datos y, normalmente, a qué tabla de Log Analytics se enviarán los datos.

Identity

Objeto

Identidad de servicio administrada del recurso.

Nombre	Tipo	Description
principalId	string (uuid)	Identificador de entidad de servicio de la identidad asignada por el sistema. Esta propiedad solo se proporcionará para una identidad asignada por el sistema.
tenantId	string (uuid)	Identificador de inquilino de la identidad asignada por el sistema. Esta propiedad solo se proporcionará para una identidad asignada por el sistema.
type	ManagedServiceIdentityType	Tipo de identidad de servicio administrada (donde se permiten los tipos SystemAssigned y UserAssigned).
userAssignedIdentities	<string, UserAssignedIdentity>	identidades de User-Assigned Conjunto de identidades asignadas por el usuario asociadas al recurso. Las claves de diccionario userAssignedIdentities serán identificadores de recursos de ARM con el formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Los valores del diccionario pueden ser objetos vacíos ({}) en las solicitudes.

IisLogsDataSource

Objeto

Permite recopilar registros de IIS mediante esta regla de recopilación de datos.

Nombre	Tipo	Description
logDirectories	string[]	Ubicación del archivo de rutas de acceso absolutas
name	string	Nombre descriptivo para el origen de datos. Este nombre debe ser único en todos los orígenes de datos (independientemente del tipo) dentro de la regla de recopilación de datos.
streams	string[]	Secuencias de IIS
transformKql	string	Consulta KQL para transformar el origen de datos.

KnownAgentSettingName

Enumeración

Nombre de la configuración. Debe formar parte de la lista de configuraciones admitidas.

Valor	Description
MaxDiskQuotaInMB
UseTimeReceivedForForwardedEvents

KnownColumnDefinitionType

Enumeración

Tipo de los datos de columna.

Valor	Description
string
int
long
real
boolean
datetime
dynamic

KnownDataCollectionRuleProvisioningState

Enumeración

Estado de aprovisionamiento de recursos.

Valor	Description
Creating
Updating
Deleting
Succeeded
Canceled
Failed

KnownDataCollectionRuleResourceKind

Enumeración

Tipo del recurso.

Valor	Description
Linux
Windows

KnownDataFlowStreams

Enumeración

Lista de secuencias para este flujo de datos.

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

KnownExtensionDataSourceStreams

Enumeración

Lista de secuencias a las que se enviará este origen de datos. Una secuencia indica a qué esquema se usará para estos datos y, normalmente, a qué tabla de Log Analytics se enviarán los datos.

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

KnownLogFilesDataSourceFormat

Enumeración

Formato de datos de los archivos de registro

Valor	Description
json
text

KnownLogFileTextSettingsRecordStartTimestampFormat

Enumeración

Uno de los formatos de marca de tiempo admitidos

Valor	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

Enumeración

Lista de secuencias a las que se enviará este origen de datos. Una secuencia indica a qué esquema se usará para estos datos y, normalmente, a qué tabla de Log Analytics se enviarán los datos.

Valor	Description
Microsoft-Perf
Microsoft-InsightsMetrics

KnownPrometheusForwarderDataSourceStreams

Enumeración

Lista de secuencias a las que se enviará este origen de datos.

Valor	Description
Microsoft-PrometheusMetrics

KnownStorageBlobLookupType

Enumeración

Tipo de búsqueda que se va a realizar en el blob

Valor	Description
String
Cidr

KnownSyslogDataSourceFacilityNames

Enumeración

Lista de nombres de instalación.

Valor	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

Enumeración

Niveles de registro que se van a recopilar.

Valor	Description
Debug
Info
Notice
Warning
Error
Critical
Alert
Emergency
*

KnownSyslogDataSourceStreams

Enumeración

Lista de secuencias a las que se enviará este origen de datos. Una secuencia indica a qué esquema se usará para estos datos y, normalmente, a qué tabla de Log Analytics se enviarán los datos.

Valor	Description
Microsoft-Syslog

KnownWindowsEventLogDataSourceStreams

Enumeración

Lista de secuencias a las que se enviará este origen de datos. Una secuencia indica a qué esquema se usará para estos datos y, normalmente, a qué tabla de Log Analytics se enviarán los datos.

Valor	Description
Microsoft-WindowsEvent
Microsoft-Event

KnownWindowsFirewallLogsDataSourceProfileFilter

Enumeración

Filtro de perfil de registros de firewall

Valor	Description
Domain
Private
Public

LogAnalyticsDestination

Objeto

Destino de Log Analytics.

Nombre	Tipo	Description
name	string	Nombre descriptivo para el destino. Este nombre debe ser único en todos los destinos (independientemente del tipo) dentro de la regla de recopilación de datos.
workspaceId	string	Identificador de cliente del área de trabajo de Log Analytics.
workspaceResourceId	string	Identificador de recurso del área de trabajo de Log Analytics.

LogFilesDataSource

Objeto

Definición de los archivos de registro personalizados que recopilará esta regla de recopilación de datos

Nombre	Tipo	Description
filePatterns	string[]	Patrones de archivo donde se encuentran los archivos de registro
format	KnownLogFilesDataSourceFormat	Formato de datos de los archivos de registro
name	string	Nombre descriptivo para el origen de datos. Este nombre debe ser único en todos los orígenes de datos (independientemente del tipo) dentro de la regla de recopilación de datos.
settings	Settings	Configuración específica de los archivos de registro.
streams	string[]	Lista de secuencias a las que se enviará este origen de datos. Una secuencia indica qué esquema se usará para este origen de datos.
transformKql	string	Consulta KQL para transformar el origen de datos.

ManagedServiceIdentityType

Enumeración

Tipo de identidad de servicio administrada (donde se permiten los tipos SystemAssigned y UserAssigned).

Valor	Description
None
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned

Metadata

Objeto

Metadatos sobre el recurso

Nombre	Tipo	Description
provisionedBy	string	Oferta de Azure que administra este recurso en nombre del cliente.
provisionedByImmutableId	string	Identificador inmutable de azure que ofrece la administración de este recurso en nombre del cliente.
provisionedByResourceId	string	Identificador de recurso de la oferta de Azure que administra este recurso en nombre del cliente.

MicrosoftFabricDestination

Objeto

Destino de Microsoft Fabric (que no es de Azure).

Nombre	Tipo	Description
artifactId	string	Identificador del artefacto del recurso de Microsoft Fabric.
databaseName	string	Nombre de la base de datos a la que se ingerirán los datos.
ingestionUri	string	Identificador URI de ingesta del recurso de Microsoft Fabric.
name	string	Nombre descriptivo para el destino. Este nombre debe ser único en todos los destinos (independientemente del tipo) dentro de la regla de recopilación de datos.
tenantId	string	Identificador de inquilino del recurso de Microsoft Fabric.

MonitoringAccountDestination

Objeto

Destino de la cuenta de supervisión.

Nombre	Tipo	Description
accountId	string	Identificador inmutable de la cuenta.
accountResourceId	string	Identificador de recurso de la cuenta de supervisión.
name	string	Nombre descriptivo para el destino. Este nombre debe ser único en todos los destinos (independientemente del tipo) dentro de la regla de recopilación de datos.

PerfCounterDataSource

Objeto

Definición de qué contadores de rendimiento se recopilarán y cómo se recopilarán mediante esta regla de recopilación de datos. Se recopilan de máquinas Windows y Linux en las que el contador está presente.

Nombre	Tipo	Description
counterSpecifiers	string[]	Lista de nombres de especificador de los contadores de rendimiento que desea recopilar. Use un carácter comodín (*) para recopilar un contador para todas las instancias. Para obtener una lista de contadores de rendimiento en Windows, ejecute el comando "typeperf".
name	string	Nombre descriptivo para el origen de datos. Este nombre debe ser único en todos los orígenes de datos (independientemente del tipo) dentro de la regla de recopilación de datos.
samplingFrequencyInSeconds	integer (int32)	Número de segundos entre medidas de contador consecutivas (muestras).
streams	KnownPerfCounterDataSourceStreams[]	Lista de secuencias a las que se enviará este origen de datos. Una secuencia indica a qué esquema se usará para estos datos y, normalmente, a qué tabla de Log Analytics se enviarán los datos.
transformKql	string	Consulta KQL para transformar el origen de datos.

PlatformTelemetryDataSource

Objeto

Definición de la configuración del origen de datos de telemetría de la plataforma

Nombre	Tipo	Description
name	string	Nombre descriptivo para el origen de datos. Este nombre debe ser único en todos los orígenes de datos (independientemente del tipo) dentro de la regla de recopilación de datos.
streams	string[]	Lista de flujos de telemetría de plataforma que se van a recopilar

PrometheusForwarderDataSource

Objeto

Definición de la configuración de reenvío de métricas de Prometheus.

Nombre	Tipo	Description
labelIncludeFilter	object	La lista de filtros de inclusión de etiquetas en forma de pares de etiqueta "nombre-valor". Actualmente solo se admite una etiqueta: "microsoft_metrics_include_label". Los valores de etiqueta no distinguen mayúsculas de minúsculas.
name	string	Nombre descriptivo para el origen de datos. Este nombre debe ser único en todos los orígenes de datos (independientemente del tipo) dentro de la regla de recopilación de datos.
streams	KnownPrometheusForwarderDataSourceStreams[]	Lista de secuencias a las que se enviará este origen de datos.

References

Objeto

Define todas las referencias que se pueden usar en otras secciones del DCR.

Nombre	Tipo	Description
enrichmentData	EnrichmentData	Todos los orígenes de datos de enriquecimiento a los que se hace referencia en los flujos de datos

Settings

Objeto

Configuración específica de los archivos de registro.

Nombre	Tipo	Description
text	Text	Configuración de texto

StorageBlob

Objeto

Nombre	Tipo	Description
blobUrl	string	Dirección URL del blob de almacenamiento
lookupType	KnownStorageBlobLookupType	Tipo de búsqueda que se va a realizar en el blob
name	string	Nombre del origen de datos de enriquecimiento usado como alias al hacer referencia a este origen de datos en flujos de datos
resourceId	string	Identificador de recurso de la cuenta de almacenamiento que hospeda el blob

StorageBlobDestination

Objeto

Nombre	Tipo	Description
containerName	string	Nombre del contenedor del blob de almacenamiento.
name	string	Nombre descriptivo para el destino. Este nombre debe ser único en todos los destinos (independientemente del tipo) dentro de la regla de recopilación de datos.
storageAccountResourceId	string	Identificador de recurso de la cuenta de almacenamiento.

StorageTableDestination

Objeto

Nombre	Tipo	Description
name	string	Nombre descriptivo para el destino. Este nombre debe ser único en todos los destinos (independientemente del tipo) dentro de la regla de recopilación de datos.
storageAccountResourceId	string	Identificador de recurso de la cuenta de almacenamiento.
tableName	string	Nombre de la tabla de almacenamiento.

StreamDeclaration

Objeto

Declaración de una secuencia personalizada.

Nombre	Tipo	Description
columns	ColumnDefinition[]	Lista de columnas usadas por los datos de esta secuencia.

SyslogDataSource

Objeto

Definición de los datos de syslog que se recopilarán y cómo se recopilarán. Solo se recopilan de máquinas Linux.

Nombre	Tipo	Description
facilityNames	KnownSyslogDataSourceFacilityNames[]	Lista de nombres de instalación.
logLevels	KnownSyslogDataSourceLogLevels[]	Niveles de registro que se van a recopilar.
name	string	Nombre descriptivo para el origen de datos. Este nombre debe ser único en todos los orígenes de datos (independientemente del tipo) dentro de la regla de recopilación de datos.
streams	KnownSyslogDataSourceStreams[]	Lista de secuencias a las que se enviará este origen de datos. Una secuencia indica a qué esquema se usará para estos datos y, normalmente, a qué tabla de Log Analytics se enviarán los datos.
transformKql	string	Consulta KQL para transformar el origen de datos.

SystemData

Objeto

Metadatos relativos a la creación y última modificación del recurso.

Nombre	Tipo	Description
createdAt	string (date-time)	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string (date-time)	Marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.

Text

Objeto

Configuración de texto

Nombre	Tipo	Description
recordStartTimestampFormat	KnownLogFileTextSettingsRecordStartTimestampFormat	Uno de los formatos de marca de tiempo admitidos

UserAssignedIdentity

Objeto

Propiedades de identidad asignadas por el usuario

Nombre	Tipo	Description
clientId	string (uuid)	Identificador de cliente de la identidad asignada.
principalId	string (uuid)	Identificador de entidad de seguridad de la identidad asignada.

WindowsEventLogDataSource

Objeto

Definición de los eventos del registro de eventos de Windows que se recopilarán y cómo se recopilarán. Solo se recopilan de máquinas Windows.

Nombre	Tipo	Description
name	string	Nombre descriptivo para el origen de datos. Este nombre debe ser único en todos los orígenes de datos (independientemente del tipo) dentro de la regla de recopilación de datos.
streams	KnownWindowsEventLogDataSourceStreams[]	Lista de secuencias a las que se enviará este origen de datos. Una secuencia indica a qué esquema se usará para estos datos y, normalmente, a qué tabla de Log Analytics se enviarán los datos.
transformKql	string	Consulta KQL para transformar el origen de datos.
xPathQueries	string[]	Lista de consultas del registro de eventos de Windows en formato XPATH.

WindowsFirewallLogsDataSource

Objeto

Permite recopilar registros de firewall mediante esta regla de recopilación de datos.

Nombre	Tipo	Description
name	string	Nombre descriptivo para el origen de datos. Este nombre debe ser único en todos los orígenes de datos (independientemente del tipo) dentro de la regla de recopilación de datos.
profileFilter	KnownWindowsFirewallLogsDataSourceProfileFilter[]	Filtro de perfil de registros de firewall
streams	string[]	Flujos de registros de firewall

Compartir a través de

Data Collection Rules - Create

Parámetros de identificador URI

Cuerpo de la solicitud

Respuestas

Seguridad

azure_auth

Ámbitos

Ejemplos

Create or update an agent settings configuration

Solicitud de ejemplo

Respuesta de muestra

Create or update data collection rule

Solicitud de ejemplo

Respuesta de muestra

Create or update data collection rule with embedded ingestion endpoints

Solicitud de ejemplo

Respuesta de muestra

Create or update data collection rule with enrichment

Solicitud de ejemplo

Respuesta de muestra

Definiciones

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