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 do URI

Name	Em	Necessá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 do Pedido

Name	Necessário	Tipo	Description
location	True	string	A geolocalização onde o recurso vive.
identity		Identity	Identidade de serviço gerenciado do recurso.
kind		KnownDataCollectionRuleResourceKind	O tipo de 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 esta regra pode ser usada.
properties.dataFlows		DataFlow[]	A especificação de fluxos de dados.
properties.dataSources		DataSources	A especificação das fontes de dados. Essa propriedade é opcional e pode ser omitida se a regra se destinar a ser usada por meio de chamadas diretas para o ponto de extremidade provisionado.
properties.description		string	Descrição da regra de recolha 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 dos fluxos aduaneiros utilizados nesta regra.
tags		object	Tags de recursos.

Respostas

Name	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

Azure Ative Directory OAuth2 Flow

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

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

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 da amostra

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

Pedido de amostra

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 da amostra

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

Pedido de amostra

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 da amostra

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

Pedido de amostra

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 da amostra

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

Name	Description
AdxDestination	Destino do Azure Data Explorer (Adx).
AgentSetting	Uma configuração usada para controlar o comportamento de um agente em uma máquina host
AgentSettings	Configurações do agente usadas para modificar o comportamento do agente em um determinado host
AzureMonitorMetrics	Destino do Azure Monitor Metrics.
ColumnDefinition	Definição de coluna de dados personalizada.
createdByType	O tipo de identidade que criou o recurso.
DataCollectionRuleResource	Definição de recurso de nível superior rastreado por ARM.
DataFlow	Definição de quais fluxos são enviados para quais destinos.
DataImports	Especificações de fontes de dados pull based
DataSources	A especificação das fontes de dados. Essa propriedade é opcional e pode ser omitida se a regra se destinar a 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	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponseCommonV2	Resposta de erro
EventHub	Definição da 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 Azure Monitor Agent. Coletado de máquinas Windows e Linux, dependendo de qual extensão é definida.
Identity	Identidade de serviço gerenciado 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 suportadas
KnownColumnDefinitionType	O tipo de dados da coluna.
KnownDataCollectionRuleProvisioningState	O estado de provisionamento de recursos.
KnownDataCollectionRuleResourceKind	O tipo de recurso.
KnownDataFlowStreams	Lista de fluxos para este fluxo de dados.
KnownExtensionDataSourceStreams	Lista de fluxos para os quais essa fonte de dados será enviada. Um fluxo indica 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 suportados
KnownPerfCounterDataSourceStreams	Lista de fluxos para os quais essa fonte de dados será enviada. Um fluxo indica 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 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 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 esta regra de coleta de dados
ManagedServiceIdentityType	Tipo de identidade de serviço gerenciado (onde os tipos SystemAssigned e UserAssigned são permitidos).
Metadata	Metadados sobre o recurso
MicrosoftFabricDestination	Destino do Microsoft Fabric (não Azure).
MonitoringAccountDestination	Monitoramento do destino da conta.
PerfCounterDataSource	Definição de quais contadores de desempenho serão coletados e como eles serão coletados por esta regra de coleta de dados. Coletado de máquinas Windows e Linux onde o contador está presente.
PlatformTelemetryDataSource	Definição da configuração da fonte de dados de telemetria da plataforma
PrometheusForwarderDataSource	Definição da configuração de encaminhamento de métricas 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 aduaneiro.
SyslogDataSource	Definição de quais dados syslog serão coletados e como serão coletados. Apenas recolhidos de máquinas Linux.
SystemData	Metadados referentes à 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. Apenas recolhidos de máquinas Windows.
WindowsFirewallLogsDataSource	Permite que os logs do Firewall sejam coletados por essa regra de coleta de dados.

AdxDestination

Object

Destino do Azure Data Explorer (Adx).

Name	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 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 do recurso ARM do recurso Adx.

AgentSetting

Object

Uma configuração usada para controlar o comportamento de um agente em uma máquina host

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

AgentSettings

Object

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

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

AzureMonitorMetrics

Object

Destino do Azure Monitor Metrics.

Name	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

Object

Definição de coluna de dados personalizada.

Name	Tipo	Description
name	string	O nome da coluna.
type	KnownColumnDefinitionType	O tipo de dados da coluna.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
User
Application
ManagedIdentity
Key

DataCollectionRuleResource

Object

Definição de recurso de nível superior rastreado por ARM.

Name	Tipo	Description
etag	string	Tag de entidade de recurso (ETag).
id	string	ID totalmente qualificado do recurso.
identity	Identity	Identidade de serviço gerenciado do recurso.
kind	KnownDataCollectionRuleResourceKind	O tipo de recurso.
location	string	A geolocalização onde o recurso vive.
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 esta regra pode ser usada.
properties.dataFlows	DataFlow[]	A especificação de fluxos de dados.
properties.dataSources	DataSources	A especificação das fontes de dados. Essa propriedade é opcional e pode ser omitida se a regra se destinar a ser usada por meio de chamadas diretas para o ponto de extremidade provisionado.
properties.description	string	Descrição da regra de recolha 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 desta regra de recolha de dados. Esta 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 dos fluxos aduaneiros utilizados nesta regra.
systemData	SystemData	Metadados referentes à criação e última modificação do recurso.
tags	object	Tags de recursos.
type	string	O tipo do recurso.

DataFlow

Object

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

Name	Tipo	Description
builtInTransform	string	A transformação integrada para transformar dados de fluxo
captureOverflow	boolean	Sinalizador para ativar a coluna de estouro em destinos LA
destinations	string[]	Lista de destinos para este fluxo de dados.
outputStream	string	O fluxo de saída da transformação. Apenas necessário se a transformação alterar os dados para um fluxo diferente.
streams	KnownDataFlowStreams[]	Lista de fluxos para este fluxo de dados.
transformKql	string	A consulta KQL para transformar dados de fluxo.

DataImports

Object

Especificações de fontes de dados pull based

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

DataSources

Object

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

Name	Tipo	Description
dataImports	DataImports	Especificações de fontes de dados pull based
extensions	ExtensionDataSource[]	A lista de configurações de fonte de dados de extensão de VM do Azure.
iisLogs	IisLogsDataSource[]	A lista de logs do IIS configurações de origem.
logFiles	LogFilesDataSource[]	A lista de configurações de origem de 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 Syslog.
windowsEventLogs	WindowsEventLogDataSource[]	A lista de configurações de fonte de dados do Log de Eventos do Windows.
windowsFirewallLogs	WindowsFirewallLogsDataSource[]	A lista de logs do Firewall do Windows nas configurações de origem.

Destinations

Object

A especificação de destinos.

Name	Tipo	Description
azureDataExplorer	AdxDestination[]	Lista de destinos do Azure Data Explorer.
azureMonitorMetrics	AzureMonitorMetrics	Destino do Azure Monitor Metrics.
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 da conta de monitoramento.
storageAccounts	StorageBlobDestination[]	Lista de destinos de contas de armazenamento.
storageBlobsDirect	StorageBlobDestination[]	Lista de destinos do Blob de Armazenamento Direto. Para ser usado apenas para enviar dados diretamente para armazenar do agente.
storageTablesDirect	StorageTableDestination[]	Lista de destinos diretos da tabela de armazenamento.

Endpoints

Object

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

Name	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

Object

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

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

ErrorAdditionalInfo

Object

O erro de gerenciamento de recursos informações adicionais.

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

ErrorDetail

Object

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	O erro informações adicionais.
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

Object

Resposta de erro

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

EventHub

Object

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

Name	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

Object

Name	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

Object

Name	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

Object

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

Name	Tipo	Description
extensionName	string	O nome da extensão 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 das quais 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 qual esquema será usado para esses dados e, geralmente, para qual tabela no Log Analytics os dados serão enviados.

Identity

Object

Identidade de serviço gerenciado do recurso.

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

IisLogsDataSource

Object

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

Name	Tipo	Description
logDirectories	string[]	Local do 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 suportadas

Valor	Description
MaxDiskQuotaInMB
UseTimeReceivedForForwardedEvents

KnownColumnDefinitionType

Enumeração

O tipo de 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 de recurso.

Valor	Description
Linux
Windows

KnownDataFlowStreams

Enumeração

Lista de fluxos para este 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 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 suportados

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

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

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

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

Valor	Description
Microsoft-Syslog

KnownWindowsEventLogDataSourceStreams

Enumeração

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

Valor	Description
Microsoft-WindowsEvent
Microsoft-Event

KnownWindowsFirewallLogsDataSourceProfileFilter

Enumeração

Filtro de perfil de logs de firewall

Valor	Description
Domain
Private
Public

LogAnalyticsDestination

Object

Destino do Log Analytics.

Name	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 espaço de trabalho do Log Analytics.
workspaceResourceId	string	O ID do recurso do espaço de trabalho do Log Analytics.

LogFilesDataSource

Object

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

Name	Tipo	Description
filePatterns	string[]	Padrões de arquivo onde 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 (onde os tipos SystemAssigned e UserAssigned são permitidos).

Valor	Description
None
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned

Metadata

Object

Metadados sobre o recurso

Name	Tipo	Description
provisionedBy	string	Oferta do Azure gerenciando esse recurso em nome do cliente.
provisionedByImmutableId	string	ID imutável da oferta azure gerenciando este recurso em nome do cliente.
provisionedByResourceId	string	ID do recurso da oferta azure gerenciando esse recurso em nome do cliente.

MicrosoftFabricDestination

Object

Destino do Microsoft Fabric (não Azure).

Name	Tipo	Description
artifactId	string	A id do artefato do recurso 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 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 Microsoft Fabric.

MonitoringAccountDestination

Object

Monitoramento do destino da conta.

Name	Tipo	Description
accountId	string	O ID imutável da conta.
accountResourceId	string	O 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

Object

Definição de quais contadores de desempenho serão coletados e como eles serão coletados por esta regra de coleta de dados. Coletado de máquinas Windows e Linux onde o contador está presente.

Name	Tipo	Description
counterSpecifiers	string[]	Uma lista de nomes de 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 contramedições consecutivas (amostras).
streams	KnownPerfCounterDataSourceStreams[]	Lista de fluxos para os quais essa fonte de dados será enviada. Um fluxo indica 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

Object

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

Name	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 da plataforma a serem coletados

PrometheusForwarderDataSource

Object

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

Name	Tipo	Description
labelIncludeFilter	object	A lista de filtros de inclusão de rótulo na forma de pares "nome-valor" de rótulo. Atualmente, apenas um rótulo é suportado: "microsoft_metrics_include_label". Os valores dos rótulos não diferenciam 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

Object

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

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

Settings

Object

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

Name	Tipo	Description
text	Text	Configurações de texto

StorageBlob

Object

Name	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 um alias ao fazer referência a essa fonte de dados em fluxos de dados
resourceId	string	ID do recurso da conta de armazenamento que hospeda o blob

StorageBlobDestination

Object

Name	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	O ID do recurso da conta de armazenamento.

StorageTableDestination

Object

Name	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	O ID do recurso da conta de armazenamento.
tableName	string	O nome da tabela de armazenamento.

StreamDeclaration

Object

Declaração de um fluxo aduaneiro.

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

SyslogDataSource

Object

Definição de quais dados syslog serão coletados e como serão coletados. Apenas recolhidos de máquinas Linux.

Name	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 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

Object

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

Name	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

Object

Configurações de texto

Name	Tipo	Description
recordStartTimestampFormat	KnownLogFileTextSettingsRecordStartTimestampFormat	Um dos formatos de carimbo de data/hora suportados

UserAssignedIdentity

Object

Propriedades de identidade atribuídas pelo usuário

Name	Tipo	Description
clientId	string (uuid)	O ID do cliente da identidade atribuída.
principalId	string (uuid)	O ID principal da identidade atribuída.

WindowsEventLogDataSource

Object

Definição de quais eventos do Log de Eventos do Windows serão coletados e como eles serão coletados. Apenas recolhidos de máquinas Windows.

Name	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 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

Object

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

Name	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[]	O firewall registra fluxos

Partilhar via

Data Collection Rules - Create

Parâmetros do URI

Corpo do Pedido

Respostas

Segurança

azure_auth

Âmbitos

Exemplos

Create or update an agent settings configuration

Pedido de amostra

Resposta da amostra

Create or update data collection rule

Pedido de amostra

Resposta da amostra

Create or update data collection rule with embedded ingestion endpoints

Pedido de amostra

Resposta da amostra

Create or update data collection rule with enrichment

Pedido de amostra

Resposta da amostra

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