Data Collection Rules - Create

Serviço:: Monitor

Versão da API:: 2023-03-11

Cria ou atualiza uma regra de coleta de dados.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
dataCollectionRuleName	path	True	string	O nome da regra de coleta de dados. O nome não diferencia maiúsculas de minúsculas.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string minLength: 1	A ID da assinatura de destino.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
location	True	string	A localização geográfica onde o recurso reside.
identity		Identity	Identidade de serviço gerenciada do recurso.
kind		KnownDataCollectionRuleResourceKind	O tipo do recurso.
properties.agentSettings		AgentSettings	Configurações do agente usadas para modificar o comportamento do agente em um determinado host
properties.dataCollectionEndpointId		string	A ID do recurso do ponto de extremidade de coleta de dados com o qual essa regra pode ser usada.
properties.dataFlows		DataFlow[]	A especificação dos fluxos de dados.
properties.dataSources		DataSources	A especificação de fontes de dados. Essa propriedade é opcional e pode ser omitida se a regra deve ser usada por meio de chamadas diretas para o ponto de extremidade provisionado.
properties.description		string	Descrição da regra de coleta de dados.
properties.destinations		Destinations	A especificação de destinos.
properties.references		References	Define todas as referências que podem ser usadas em outras seções do DCR
properties.streamDeclarations		<string, StreamDeclaration>	Declaração de fluxos personalizados usados nesta regra.
tags		object	Marcas de recurso.

Respostas

Nome	Tipo	Description
200 OK	DataCollectionRuleResource	A regra de coleta de dados foi atualizada com êxito
201 Created	DataCollectionRuleResource	A regra de coleta de dados foi criada com êxito
Other Status Codes	ErrorResponseCommonV2	Erro

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

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

Resposta de exemplo

Código de status:: 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"
}

Código de status:: 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

Solicitação de exemplo

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

Resposta de exemplo

Código de status:: 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"
}

Código de status:: 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

Solicitação de exemplo

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

Resposta de exemplo

Código de status:: 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"
}

Código de status:: 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

Solicitação de exemplo

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

Resposta de exemplo

Código de status:: 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"
}

Código de status:: 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"
}

Definições

Nome	Description
AdxDestination	Destino do Adx (Azure Data Explorer).
AgentSetting	Uma configuração usada para controlar o comportamento de um agente em um computador host
AgentSettings	Configurações do agente usadas para modificar o comportamento do agente em um determinado host
AzureMonitorMetrics	Destino das Métricas do Azure Monitor.
ColumnDefinition	Definição da coluna de dados personalizada.
createdByType	O tipo de identidade que criou o recurso.
DataCollectionRuleResource	Definição de recurso de nível superior controlado pelo ARM.
DataFlow	Definição de quais fluxos são enviados para quais destinos.
DataImports	Especificações de fontes de dados baseadas em pull
DataSources	A especificação de fontes de dados. Essa propriedade é opcional e pode ser omitida se a regra deve ser usada por meio de chamadas diretas para o ponto de extremidade provisionado.
Destinations	A especificação de destinos.
Endpoints	Define os pontos de extremidade de ingestão para os quais enviar dados por meio dessa regra.
EnrichmentData	Todas as fontes de dados de enriquecimento referenciadas em fluxos de dados
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponseCommonV2	Resposta de erro
EventHub	Definição de configuração do Hub de Eventos.
EventHubDestination
EventHubDirectDestination
ExtensionDataSource	Definição de quais dados serão coletados de uma extensão de VM separada que se integra ao Agente do Azure Monitor. Coletado de computadores Windows e Linux, dependendo de qual extensão é definida.
Identity	Identidade de serviço gerenciada do recurso.
IisLogsDataSource	Permite que os logs do IIS sejam coletados por essa regra de coleta de dados.
KnownAgentSettingName	O nome da configuração. Deve fazer parte da lista de configurações com suporte
KnownColumnDefinitionType	O tipo dos dados da coluna.
KnownDataCollectionRuleProvisioningState	O estado de provisionamento de recursos.
KnownDataCollectionRuleResourceKind	O tipo do recurso.
KnownDataFlowStreams	Lista de fluxos para esse fluxo de dados.
KnownExtensionDataSourceStreams	Lista de fluxos para os quais essa fonte de dados será enviada. Um fluxo indica para qual esquema será usado para esses dados e, geralmente, para qual tabela no Log Analytics os dados serão enviados.
KnownLogFilesDataSourceFormat	O formato de dados dos arquivos de log
KnownLogFileTextSettingsRecordStartTimestampFormat	Um dos formatos de carimbo de data/hora com suporte
KnownPerfCounterDataSourceStreams	Lista de fluxos para os quais essa fonte de dados será enviada. Um fluxo indica para qual esquema será usado para esses dados e, geralmente, para qual tabela no Log Analytics os dados serão enviados.
KnownPrometheusForwarderDataSourceStreams	Lista de fluxos para os quais essa fonte de dados será enviada.
KnownStorageBlobLookupType	O tipo de pesquisa a ser executada no blob
KnownSyslogDataSourceFacilityNames	A lista de nomes de instalações.
KnownSyslogDataSourceLogLevels	Os níveis de log a serem coletados.
KnownSyslogDataSourceStreams	Lista de fluxos para os quais essa fonte de dados será enviada. Um fluxo indica para qual esquema será usado para esses dados e, geralmente, para qual tabela no Log Analytics os dados serão enviados.
KnownWindowsEventLogDataSourceStreams	Lista de fluxos para os quais essa fonte de dados será enviada. Um fluxo indica para qual esquema será usado para esses dados e, geralmente, para qual tabela no Log Analytics os dados serão enviados.
KnownWindowsFirewallLogsDataSourceProfileFilter	Filtro de perfil de logs de firewall
LogAnalyticsDestination	Destino do Log Analytics.
LogFilesDataSource	Definição de quais arquivos de log personalizados serão coletados por essa regra de coleta de dados
ManagedServiceIdentityType	Tipo de identidade de serviço gerenciado (em que os tipos SystemAssigned e UserAssigned são permitidos).
Metadata	Metadados sobre o recurso
MicrosoftFabricDestination	Destino do Microsoft Fabric (não Azure).
MonitoringAccountDestination	Monitorando o destino da conta.
PerfCounterDataSource	Definição de quais contadores de desempenho serão coletados e como eles serão coletados por essa regra de coleta de dados. Coletado de computadores Windows e Linux em que o contador está presente.
PlatformTelemetryDataSource	Definição da configuração da fonte de dados de telemetria de plataforma
PrometheusForwarderDataSource	Definição da configuração de encaminhamento de métricas do Prometheus.
References	Define todas as referências que podem ser usadas em outras seções do DCR
Settings	As configurações específicas dos arquivos de log.
StorageBlob
StorageBlobDestination
StorageTableDestination
StreamDeclaration	Declaração de um fluxo personalizado.
SyslogDataSource	Definição de quais dados do syslog serão coletados e como eles serão coletados. Coletado somente de computadores Linux.
SystemData	Metadados relativos à criação e última modificação do recurso.
Text	Configurações de texto
UserAssignedIdentity	Propriedades de identidade atribuídas pelo usuário
WindowsEventLogDataSource	Definição de quais eventos do Log de Eventos do Windows serão coletados e como eles serão coletados. Coletado somente de computadores Windows.
WindowsFirewallLogsDataSource	Permite que os logs de firewall sejam coletados por essa regra de coleta de dados.

AdxDestination

Objeto

Destino do Adx (Azure Data Explorer).

Nome	Tipo	Description
databaseName	string	O nome do banco de dados ao qual os dados serão ingeridos.
ingestionUri	string	O uri de ingestão do recurso do Adx.
name	string	Um nome amigável para o destino. Esse nome deve ser exclusivo em todos os destinos (independentemente do tipo) dentro da regra de coleta de dados.
resourceId	string	A ID de recurso do ARM do recurso do Adx.

AgentSetting

Objeto

Uma configuração usada para controlar o comportamento de um agente em um computador host

Nome	Tipo	Description
name	KnownAgentSettingName	O nome da configuração. Deve fazer parte da lista de configurações com suporte
value	string	O valor da configuração

AgentSettings

Objeto

Configurações do agente usadas para modificar o comportamento do agente em um determinado host

Nome	Tipo	Description
logs	AgentSetting[]	Todas as configurações aplicáveis ao AMA (agente de logs)

AzureMonitorMetrics

Objeto

Destino das Métricas do Azure Monitor.

Nome	Tipo	Description
name	string	Um nome amigável para o destino. Esse nome deve ser exclusivo em todos os destinos (independentemente do tipo) dentro da regra de coleta de dados.

ColumnDefinition

Objeto

Definição da coluna de dados personalizada.

Nome	Tipo	Description
name	string	O nome da coluna.
type	KnownColumnDefinitionType	O tipo dos dados da coluna.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
User
Application
ManagedIdentity
Key

DataCollectionRuleResource

Objeto

Definição de recurso de nível superior controlado pelo ARM.

Nome	Tipo	Description
etag	string	Marca de entidade de recurso (ETag).
id	string	ID totalmente qualificada do recurso.
identity	Identity	Identidade de serviço gerenciada do recurso.
kind	KnownDataCollectionRuleResourceKind	O tipo do recurso.
location	string	A localização geográfica onde o recurso reside.
name	string	O nome do recurso.
properties.agentSettings	AgentSettings	Configurações do agente usadas para modificar o comportamento do agente em um determinado host
properties.dataCollectionEndpointId	string	A ID do recurso do ponto de extremidade de coleta de dados com o qual essa regra pode ser usada.
properties.dataFlows	DataFlow[]	A especificação dos fluxos de dados.
properties.dataSources	DataSources	A especificação de fontes de dados. Essa propriedade é opcional e pode ser omitida se a regra deve ser usada por meio de chamadas diretas para o ponto de extremidade provisionado.
properties.description	string	Descrição da regra de coleta de dados.
properties.destinations	Destinations	A especificação de destinos.
properties.endpoints	Endpoints	Define os pontos de extremidade de ingestão para os quais enviar dados por meio dessa regra.
properties.immutableId	string	A ID imutável dessa regra de coleta de dados. Essa propriedade é READ-ONLY.
properties.metadata	Metadata	Metadados sobre o recurso
properties.provisioningState	KnownDataCollectionRuleProvisioningState	O estado de provisionamento de recursos.
properties.references	References	Define todas as referências que podem ser usadas em outras seções do DCR
properties.streamDeclarations	<string, StreamDeclaration>	Declaração de fluxos personalizados usados nesta regra.
systemData	SystemData	Metadados relativos à criação e última modificação do recurso.
tags	object	Marcas de recurso.
type	string	O tipo do recurso.

DataFlow

Objeto

Definição de quais fluxos são enviados para quais destinos.

Nome	Tipo	Description
builtInTransform	string	A transformação builtIn para transformar dados de fluxo
captureOverflow	boolean	Sinalizador para habilitar a coluna de estouro em destinos de LA
destinations	string[]	Lista de destinos para esse fluxo de dados.
outputStream	string	O fluxo de saída da transformação. Necessário somente se a transformação alterar os dados para um fluxo diferente.
streams	KnownDataFlowStreams[]	Lista de fluxos para esse fluxo de dados.
transformKql	string	A consulta KQL para transformar dados de fluxo.

DataImports

Objeto

Especificações de fontes de dados baseadas em pull

Nome	Tipo	Description
eventHub	EventHub	Definição de configuração do Hub de Eventos.

DataSources

Objeto

A especificação de fontes de dados. Essa propriedade é opcional e pode ser omitida se a regra deve ser usada por meio de chamadas diretas para o ponto de extremidade provisionado.

Nome	Tipo	Description
dataImports	DataImports	Especificações de fontes de dados baseadas em pull
extensions	ExtensionDataSource[]	A lista de configurações de fonte de dados de extensão da VM do Azure.
iisLogs	IisLogsDataSource[]	A lista de configurações de origem de logs do IIS.
logFiles	LogFilesDataSource[]	A lista de configurações de origem dos arquivos de log.
performanceCounters	PerfCounterDataSource[]	A lista de configurações de fonte de dados do contador de desempenho.
platformTelemetry	PlatformTelemetryDataSource[]	A lista de configurações de telemetria de plataforma
prometheusForwarder	PrometheusForwarderDataSource[]	A lista de configurações de fonte de dados do encaminhador prometheus.
syslog	SyslogDataSource[]	A lista de configurações de fonte de dados do Syslog.
windowsEventLogs	WindowsEventLogDataSource[]	A lista de configurações de fonte de dados do Log de Eventos do Windows.
windowsFirewallLogs	WindowsFirewallLogsDataSource[]	A lista de configurações de origem de logs do Firewall do Windows.

Destinations

Objeto

A especificação de destinos.

Nome	Tipo	Description
azureDataExplorer	AdxDestination[]	Lista de destinos do Azure Data Explorer.
azureMonitorMetrics	AzureMonitorMetrics	Destino das Métricas do Azure Monitor.
eventHubs	EventHubDestination[]	Lista de destinos dos Hubs de Eventos.
eventHubsDirect	EventHubDirectDestination[]	Lista de destinos diretos dos Hubs de Eventos.
logAnalytics	LogAnalyticsDestination[]	Lista de destinos do Log Analytics.
microsoftFabric	MicrosoftFabricDestination[]	Lista de destinos do Microsoft Fabric.
monitoringAccounts	MonitoringAccountDestination[]	Lista de destinos de conta de monitoramento.
storageAccounts	StorageBlobDestination[]	Lista de destinos de contas de armazenamento.
storageBlobsDirect	StorageBlobDestination[]	Lista de destinos diretos do Blob de Armazenamento. Para ser usado apenas para enviar dados diretamente para armazenar do agente.
storageTablesDirect	StorageTableDestination[]	Lista de destinos diretos da tabela de armazenamento.

Endpoints

Objeto

Define os pontos de extremidade de ingestão para os quais enviar dados por meio dessa regra.

Nome	Tipo	Description
logsIngestion	string	O ponto de extremidade de ingestão para logs
metricsIngestion	string	O ponto de extremidade de ingestão para métricas

EnrichmentData

Objeto

Todas as fontes de dados de enriquecimento referenciadas em fluxos de dados

Nome	Tipo	Description
storageBlobs	StorageBlob[]	Todos os blobs de armazenamento usados como fontes de dados de enriquecimento

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Objeto

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponseCommonV2

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

EventHub

Objeto

Definição de configuração do Hub de Eventos.

Nome	Tipo	Description
consumerGroup	string	Nome do grupo de consumidores do Hub de Eventos
name	string	Um nome amigável para a fonte de dados. Esse nome deve ser exclusivo em todas as fontes de dados (independentemente do tipo) dentro da regra de coleta de dados.
stream	string	O fluxo a ser coletado do EventHub

EventHubDestination

Objeto

Nome	Tipo	Description
eventHubResourceId	string	A ID do recurso do hub de eventos.
name	string	Um nome amigável para o destino. Esse nome deve ser exclusivo em todos os destinos (independentemente do tipo) dentro da regra de coleta de dados.

EventHubDirectDestination

Objeto

Nome	Tipo	Description
eventHubResourceId	string	A ID do recurso do hub de eventos.
name	string	Um nome amigável para o destino. Esse nome deve ser exclusivo em todos os destinos (independentemente do tipo) dentro da regra de coleta de dados.

ExtensionDataSource

Objeto

Definição de quais dados serão coletados de uma extensão de VM separada que se integra ao Agente do Azure Monitor. Coletado de computadores Windows e Linux, dependendo de qual extensão é definida.

Nome	Tipo	Description
extensionName	string	O nome da extensão da VM.
extensionSettings	object	As configurações de extensão. O formato é específico para uma extensão específica.
inputDataSources	string[]	A lista de fontes de dados da qual essa extensão precisa de dados.
name	string	Um nome amigável para a fonte de dados. Esse nome deve ser exclusivo em todas as fontes de dados (independentemente do tipo) dentro da regra de coleta de dados.
streams	KnownExtensionDataSourceStreams[]	Lista de fluxos para os quais essa fonte de dados será enviada. Um fluxo indica para qual esquema será usado para esses dados e, geralmente, para qual tabela no Log Analytics os dados serão enviados.

Identity

Objeto

Identidade de serviço gerenciada do recurso.

Nome	Tipo	Description
principalId	string (uuid)	A ID da entidade de serviço da identidade atribuída pelo sistema. Essa propriedade será fornecida apenas para uma identidade atribuída pelo sistema.
tenantId	string (uuid)	A ID do locatário da identidade atribuída pelo sistema. Essa propriedade será fornecida apenas para uma identidade atribuída pelo sistema.
type	ManagedServiceIdentityType	Tipo de identidade de serviço gerenciado (em que os tipos SystemAssigned e UserAssigned são permitidos).
userAssignedIdentities	<string, UserAssignedIdentity>	Identidades de User-Assigned O conjunto de identidades atribuídas pelo usuário associadas ao recurso. As chaves do dicionário userAssignedIdentities serão IDs de recurso do ARM no formulário: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Os valores do dicionário podem ser objetos vazios ({}) em solicitações.

IisLogsDataSource

Objeto

Permite que os logs do IIS sejam coletados por essa regra de coleta de dados.

Nome	Tipo	Description
logDirectories	string[]	Localização de arquivo de caminhos absolutos
name	string	Um nome amigável para a fonte de dados. Esse nome deve ser exclusivo em todas as fontes de dados (independentemente do tipo) dentro da regra de coleta de dados.
streams	string[]	Fluxos do IIS
transformKql	string	A consulta KQL para transformar a fonte de dados.

KnownAgentSettingName

Enumeração

O nome da configuração. Deve fazer parte da lista de configurações com suporte

Valor	Description
MaxDiskQuotaInMB
UseTimeReceivedForForwardedEvents

KnownColumnDefinitionType

Enumeração

O tipo dos dados da coluna.

Valor	Description
string
int
long
real
boolean
datetime
dynamic

KnownDataCollectionRuleProvisioningState

Enumeração

O estado de provisionamento de recursos.

Valor	Description
Creating
Updating
Deleting
Succeeded
Canceled
Failed

KnownDataCollectionRuleResourceKind

Enumeração

O tipo do recurso.

Valor	Description
Linux
Windows

KnownDataFlowStreams

Enumeração

Lista de fluxos para esse fluxo de dados.

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

KnownExtensionDataSourceStreams

Enumeração

Lista de fluxos para os quais essa fonte de dados será enviada. Um fluxo indica para qual esquema será usado para esses dados e, geralmente, para qual tabela no Log Analytics os dados serão enviados.

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

KnownLogFilesDataSourceFormat

Enumeração

O formato de dados dos arquivos de log

Valor	Description
json
text

KnownLogFileTextSettingsRecordStartTimestampFormat

Enumeração

Um dos formatos de carimbo de data/hora com suporte

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

Enumeração

Valor	Description
Microsoft-Perf
Microsoft-InsightsMetrics

KnownPrometheusForwarderDataSourceStreams

Enumeração

Lista de fluxos para os quais essa fonte de dados será enviada.

Valor	Description
Microsoft-PrometheusMetrics

KnownStorageBlobLookupType

Enumeração

O tipo de pesquisa a ser executada no blob

Valor	Description
String
Cidr

KnownSyslogDataSourceFacilityNames

Enumeração

A lista de nomes de instalações.

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

Enumeração

Os níveis de log a serem coletados.

Valor	Description
Debug
Info
Notice
Warning
Error
Critical
Alert
Emergency
*

KnownSyslogDataSourceStreams

Enumeração

Valor	Description
Microsoft-Syslog

KnownWindowsEventLogDataSourceStreams

Enumeração

Valor	Description
Microsoft-WindowsEvent
Microsoft-Event

KnownWindowsFirewallLogsDataSourceProfileFilter

Enumeração

Filtro de perfil de logs de firewall

Valor	Description
Domain
Private
Public

LogAnalyticsDestination

Objeto

Destino do Log Analytics.

Nome	Tipo	Description
name	string	Um nome amigável para o destino. Esse nome deve ser exclusivo em todos os destinos (independentemente do tipo) dentro da regra de coleta de dados.
workspaceId	string	A ID do cliente do workspace do Log Analytics.
workspaceResourceId	string	A ID do recurso do workspace do Log Analytics.

LogFilesDataSource

Objeto

Definição de quais arquivos de log personalizados serão coletados por essa regra de coleta de dados

Nome	Tipo	Description
filePatterns	string[]	Padrões de arquivo em que os arquivos de log estão localizados
format	KnownLogFilesDataSourceFormat	O formato de dados dos arquivos de log
name	string	Um nome amigável para a fonte de dados. Esse nome deve ser exclusivo em todas as fontes de dados (independentemente do tipo) dentro da regra de coleta de dados.
settings	Settings	As configurações específicas dos arquivos de log.
streams	string[]	Lista de fluxos para os quais essa fonte de dados será enviada. Um fluxo indica qual esquema será usado para essa fonte de dados
transformKql	string	A consulta KQL para transformar a fonte de dados.

ManagedServiceIdentityType

Enumeração

Tipo de identidade de serviço gerenciado (em que os tipos SystemAssigned e UserAssigned são permitidos).

Valor	Description
None
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned

Metadata

Objeto

Metadados sobre o recurso

Nome	Tipo	Description
provisionedBy	string	A oferta do Azure para gerenciar esse recurso em nome do cliente.
provisionedByImmutableId	string	Id imutável do azure oferecendo o gerenciamento desse recurso em nome do cliente.
provisionedByResourceId	string	ID de recurso da oferta do Azure gerenciando esse recurso em nome do cliente.

MicrosoftFabricDestination

Objeto

Destino do Microsoft Fabric (não Azure).

Nome	Tipo	Description
artifactId	string	A ID do artefato do recurso do Microsoft Fabric.
databaseName	string	O nome do banco de dados ao qual os dados serão ingeridos.
ingestionUri	string	O uri de ingestão do recurso do Microsoft Fabric.
name	string	Um nome amigável para o destino. Esse nome deve ser exclusivo em todos os destinos (independentemente do tipo) dentro da regra de coleta de dados.
tenantId	string	A ID do locatário do recurso do Microsoft Fabric.

MonitoringAccountDestination

Objeto

Monitorando o destino da conta.

Nome	Tipo	Description
accountId	string	A ID imutável da conta.
accountResourceId	string	A ID do recurso da conta de monitoramento.
name	string	Um nome amigável para o destino. Esse nome deve ser exclusivo em todos os destinos (independentemente do tipo) dentro da regra de coleta de dados.

PerfCounterDataSource

Objeto

Definição de quais contadores de desempenho serão coletados e como eles serão coletados por essa regra de coleta de dados. Coletado de computadores Windows e Linux em que o contador está presente.

Nome	Tipo	Description
counterSpecifiers	string[]	Uma lista de nomes especificadores dos contadores de desempenho que você deseja coletar. Use um curinga (*) para coletar um contador para todas as instâncias. Para obter uma lista de contadores de desempenho no Windows, execute o comando 'typeperf'.
name	string	Um nome amigável para a fonte de dados. Esse nome deve ser exclusivo em todas as fontes de dados (independentemente do tipo) dentro da regra de coleta de dados.
samplingFrequencyInSeconds	integer (int32)	O número de segundos entre medidas de contador consecutivas (exemplos).
streams	KnownPerfCounterDataSourceStreams[]	Lista de fluxos para os quais essa fonte de dados será enviada. Um fluxo indica para qual esquema será usado para esses dados e, geralmente, para qual tabela no Log Analytics os dados serão enviados.
transformKql	string	A consulta KQL para transformar a fonte de dados.

PlatformTelemetryDataSource

Objeto

Definição da configuração da fonte de dados de telemetria de plataforma

Nome	Tipo	Description
name	string	Um nome amigável para a fonte de dados. Esse nome deve ser exclusivo em todas as fontes de dados (independentemente do tipo) dentro da regra de coleta de dados.
streams	string[]	Lista de fluxos de telemetria de plataforma a serem coletados

PrometheusForwarderDataSource

Objeto

Definição da configuração de encaminhamento de métricas do Prometheus.

Nome	Tipo	Description
labelIncludeFilter	object	A lista de filtros de inclusão de rótulo na forma de pares de rótulo "name-value". Atualmente, há suporte para apenas um rótulo: 'microsoft_metrics_include_label'. Os valores de rótulo são correspondidos sem diferenciar maiúsculas de minúsculas.
name	string	Um nome amigável para a fonte de dados. Esse nome deve ser exclusivo em todas as fontes de dados (independentemente do tipo) dentro da regra de coleta de dados.
streams	KnownPrometheusForwarderDataSourceStreams[]	Lista de fluxos para os quais essa fonte de dados será enviada.

References

Objeto

Define todas as referências que podem ser usadas em outras seções do DCR

Nome	Tipo	Description
enrichmentData	EnrichmentData	Todas as fontes de dados de enriquecimento referenciadas em fluxos de dados

Settings

Objeto

As configurações específicas dos arquivos de log.

Nome	Tipo	Description
text	Text	Configurações de texto

StorageBlob

Objeto

Nome	Tipo	Description
blobUrl	string	URL do blob de armazenamento
lookupType	KnownStorageBlobLookupType	O tipo de pesquisa a ser executada no blob
name	string	O nome da fonte de dados de enriquecimento usada como alias ao referenciar essa fonte de dados em fluxos de dados
resourceId	string	ID do recurso da conta de armazenamento que hospeda o blob

StorageBlobDestination

Objeto

Nome	Tipo	Description
containerName	string	O nome do contêiner do Blob de Armazenamento.
name	string	Um nome amigável para o destino. Esse nome deve ser exclusivo em todos os destinos (independentemente do tipo) dentro da regra de coleta de dados.
storageAccountResourceId	string	A ID do recurso da conta de armazenamento.

StorageTableDestination

Objeto

Nome	Tipo	Description
name	string	Um nome amigável para o destino. Esse nome deve ser exclusivo em todos os destinos (independentemente do tipo) dentro da regra de coleta de dados.
storageAccountResourceId	string	A ID do recurso da conta de armazenamento.
tableName	string	O nome da Tabela de Armazenamento.

StreamDeclaration

Objeto

Declaração de um fluxo personalizado.

Nome	Tipo	Description
columns	ColumnDefinition[]	Lista de colunas usadas pelos dados neste fluxo.

SyslogDataSource

Objeto

Definição de quais dados do syslog serão coletados e como eles serão coletados. Coletado somente de computadores Linux.

Nome	Tipo	Description
facilityNames	KnownSyslogDataSourceFacilityNames[]	A lista de nomes de instalações.
logLevels	KnownSyslogDataSourceLogLevels[]	Os níveis de log a serem coletados.
name	string	Um nome amigável para a fonte de dados. Esse nome deve ser exclusivo em todas as fontes de dados (independentemente do tipo) dentro da regra de coleta de dados.
streams	KnownSyslogDataSourceStreams[]	Lista de fluxos para os quais essa fonte de dados será enviada. Um fluxo indica para qual esquema será usado para esses dados e, geralmente, para qual tabela no Log Analytics os dados serão enviados.
transformKql	string	A consulta KQL para transformar a fonte de dados.

SystemData

Objeto

Metadados relativos à criação e última modificação do recurso.

Nome	Tipo	Description
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

Text

Objeto

Configurações de texto

Nome	Tipo	Description
recordStartTimestampFormat	KnownLogFileTextSettingsRecordStartTimestampFormat	Um dos formatos de carimbo de data/hora com suporte

UserAssignedIdentity

Objeto

Propriedades de identidade atribuídas pelo usuário

Nome	Tipo	Description
clientId	string (uuid)	A ID do cliente da identidade atribuída.
principalId	string (uuid)	A ID da entidade de segurança da identidade atribuída.

WindowsEventLogDataSource

Objeto

Definição de quais eventos do Log de Eventos do Windows serão coletados e como eles serão coletados. Coletado somente de computadores Windows.

Nome	Tipo	Description
name	string	Um nome amigável para a fonte de dados. Esse nome deve ser exclusivo em todas as fontes de dados (independentemente do tipo) dentro da regra de coleta de dados.
streams	KnownWindowsEventLogDataSourceStreams[]	Lista de fluxos para os quais essa fonte de dados será enviada. Um fluxo indica para qual esquema será usado para esses dados e, geralmente, para qual tabela no Log Analytics os dados serão enviados.
transformKql	string	A consulta KQL para transformar a fonte de dados.
xPathQueries	string[]	Uma lista de consultas do Log de Eventos do Windows no formato XPATH.

WindowsFirewallLogsDataSource

Objeto

Permite que os logs de firewall sejam coletados por essa regra de coleta de dados.

Nome	Tipo	Description
name	string	Um nome amigável para a fonte de dados. Esse nome deve ser exclusivo em todas as fontes de dados (independentemente do tipo) dentro da regra de coleta de dados.
profileFilter	KnownWindowsFirewallLogsDataSourceProfileFilter[]	Filtro de perfil de logs de firewall
streams	string[]	Fluxos de logs de firewall

Compartilhar via

Data Collection Rules - Create

Parâmetros de URI

Corpo da solicitação

Respostas

Segurança

azure_auth

Escopos

Exemplos

Create or update an agent settings configuration

Solicitação de exemplo

Resposta de exemplo

Create or update data collection rule

Solicitação de exemplo

Resposta de exemplo

Create or update data collection rule with embedded ingestion endpoints

Solicitação de exemplo

Resposta de exemplo

Create or update data collection rule with enrichment

Solicitação de exemplo

Resposta de exemplo

Definições

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