Data Collection Rules - Create

Servizio:

Monitor

Versione API:

2023-03-11

Crea o aggiorna una regola di raccolta dati.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
dataCollectionRuleName	path	True	string	Nome della regola di raccolta dati. Il nome non fa distinzione tra maiuscole e minuscole.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.
subscriptionId	path	True	string minLength: 1	ID della sottoscrizione di destinazione.
api-version	query	True	string minLength: 1	Versione dell'API da usare per questa operazione.

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
location	True	string	Posizione geografica in cui risiede la risorsa.
identity		Identity	Identità del servizio gestita della risorsa.
kind		KnownDataCollectionRuleResourceKind	Tipo di risorsa.
properties.agentSettings		AgentSettings	Impostazioni dell'agente usate per modificare il comportamento dell'agente in un determinato host
properties.dataCollectionEndpointId		string	ID risorsa dell'endpoint di raccolta dati con cui è possibile usare questa regola.
properties.dataFlows		DataFlow[]	Specifica dei flussi di dati.
properties.dataSources		DataSources	Specifica delle origini dati. Questa proprietà è facoltativa e può essere omessa se la regola deve essere usata tramite chiamate dirette all'endpoint di cui è stato effettuato il provisioning.
properties.description		string	Descrizione della regola di raccolta dati.
properties.destinations		Destinations	Specifica delle destinazioni.
properties.references		References	Definisce tutti i riferimenti che possono essere usati in altre sezioni del Registro Azure Container
properties.streamDeclarations		<string,  StreamDeclaration>	Dichiarazione di flussi personalizzati usati in questa regola.
tags		object	Tag di risorsa.

Risposte

Nome	Tipo	Descrizione
200 OK	DataCollectionRuleResource	Regola di raccolta dati aggiornata correttamente
201 Created	DataCollectionRuleResource	La regola di raccolta dati è stata creata correttamente
Other Status Codes	ErrorResponseCommonV2	Errore

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

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

Esempio di richiesta

HTTP

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

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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.monitor import MonitorManagementClient

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

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


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

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


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

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

Risposta di esempio

Codice di stato:

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

Codice di stato:

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

Esempio di richiesta

HTTP

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

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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.monitor import MonitorManagementClient

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

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


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

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


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

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

Risposta di esempio

Codice di stato:

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

Codice di stato:

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

Esempio di richiesta

HTTP

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

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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.monitor import MonitorManagementClient

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

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


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

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


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

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

Risposta di esempio

Codice di stato:

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

Codice di stato:

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

Esempio di richiesta

HTTP

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

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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.monitor import MonitorManagementClient

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

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


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

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


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

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

Risposta di esempio

Codice di stato:

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

Codice di stato:

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

Definizioni

Nome	Descrizione
AdxDestination	Destinazione di Esplora dati di Azure (Adx).
AgentSetting	Impostazione usata per controllare il comportamento di un agente in un computer host
AgentSettings	Impostazioni dell'agente usate per modificare il comportamento dell'agente in un determinato host
AzureMonitorMetrics	Destinazione metriche di Monitoraggio di Azure.
ColumnDefinition	Definizione della colonna di dati personalizzata.
createdByType	Tipo di identità che ha creato la risorsa.
DataCollectionRuleResource	Definizione della risorsa di primo livello rilevata da ARM.
DataFlow	Definizione dei flussi inviati a quali destinazioni.
DataImports	Specifiche delle origini dati basate sul pull
DataSources	Specifica delle origini dati. Questa proprietà è facoltativa e può essere omessa se la regola deve essere usata tramite chiamate dirette all'endpoint di cui è stato effettuato il provisioning.
Destinations	Specifica delle destinazioni.
Endpoints	Definisce gli endpoint di inserimento a cui inviare dati tramite questa regola.
EnrichmentData	Tutte le origini dati di arricchimento a cui si fa riferimento nei flussi di dati
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponseCommonV2	Risposta di errore
EventHub	Definizione della configurazione dell'hub eventi.
EventHubDestination
EventHubDirectDestination
ExtensionDataSource	Definizione dei dati raccolti da un'estensione di macchina virtuale separata che si integra con l'agente di Monitoraggio di Azure. Raccolto da computer Windows e Linux, a seconda dell'estensione definita.
Identity	Identità del servizio gestita della risorsa.
IisLogsDataSource	Consente di raccogliere i log IIS da questa regola di raccolta dati.
KnownAgentSettingName	Nome dell'impostazione. Deve far parte dell'elenco delle impostazioni supportate
KnownColumnDefinitionType	Tipo di dati della colonna.
KnownDataCollectionRuleProvisioningState	Stato del provisioning delle risorse.
KnownDataCollectionRuleResourceKind	Tipo di risorsa.
KnownDataFlowStreams	Elenco di flussi per questo flusso di dati.
KnownExtensionDataSourceStreams	Elenco di flussi a cui verrà inviata l'origine dati. Un flusso indica lo schema che verrà usato per questi dati e in genere la tabella in Log Analitica i dati verranno inviati.
KnownLogFilesDataSourceFormat	Formato dei dati dei file di log
KnownLogFileTextSettingsRecordStartTimestampFormat	Uno dei formati di timestamp supportati
KnownPerfCounterDataSourceStreams	Elenco di flussi a cui verrà inviata l'origine dati. Un flusso indica lo schema che verrà usato per questi dati e in genere la tabella in Log Analitica i dati verranno inviati.
KnownPrometheusForwarderDataSourceStreams	Elenco di flussi a cui verrà inviata l'origine dati.
KnownStorageBlobLookupType	Tipo di ricerca da eseguire nel BLOB
KnownSyslogDataSourceFacilityNames	Elenco dei nomi delle strutture.
KnownSyslogDataSourceLogLevels	Livelli di log da raccogliere.
KnownSyslogDataSourceStreams	Elenco di flussi a cui verrà inviata l'origine dati. Un flusso indica lo schema che verrà usato per questi dati e in genere la tabella in Log Analitica i dati verranno inviati.
KnownWindowsEventLogDataSourceStreams	Elenco di flussi a cui verrà inviata l'origine dati. Un flusso indica lo schema che verrà usato per questi dati e in genere la tabella in Log Analitica i dati verranno inviati.
KnownWindowsFirewallLogsDataSourceProfileFilter	Filtro del profilo dei log del firewall
LogAnalyticsDestination	Destinazione di Log Analytics.
LogFilesDataSource	Definizione dei file di log personalizzati raccolti da questa regola di raccolta dati
ManagedServiceIdentityType	Tipo di identità del servizio gestito (in cui sono consentiti sia i tipi SystemAssigned che UserAssigned).
Metadata	Metadati relativi alla risorsa
MicrosoftFabricDestination	Destinazione Di Microsoft Fabric (non Azure).
MonitoringAccountDestination	Destinazione dell'account di monitoraggio.
PerfCounterDataSource	Definizione dei contatori delle prestazioni che verranno raccolti e di come verranno raccolti da questa regola di raccolta dati. Raccolto da computer Windows e Linux in cui è presente il contatore.
PlatformTelemetryDataSource	Definizione della configurazione dell'origine dati di telemetria della piattaforma
PrometheusForwarderDataSource	Definizione della configurazione di inoltro delle metriche prometheus.
References	Definisce tutti i riferimenti che possono essere usati in altre sezioni del Registro Azure Container
Settings	Impostazioni specifiche dei file di log.
StorageBlob
StorageBlobDestination
StorageTableDestination
StreamDeclaration	Dichiarazione di un flusso personalizzato.
SyslogDataSource	Definizione dei dati syslog che verranno raccolti e di come verranno raccolti. Raccolto solo dai computer Linux.
SystemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.
Text	Impostazioni del testo
UserAssignedIdentity	Proprietà di identità assegnate dall'utente
WindowsEventLogDataSource	Definizione degli eventi del registro eventi di Windows raccolti e della modalità di raccolta. Raccolto solo dai computer Windows.
WindowsFirewallLogsDataSource	Consente di raccogliere i log del firewall tramite questa regola di raccolta dati.

AdxDestination

Oggetto

Destinazione di Esplora dati di Azure (Adx).

Nome	Tipo	Descrizione
databaseName	string	Nome del database in cui verranno inseriti i dati.
ingestionUri	string	URI di inserimento della risorsa Adx.
name	string	Nome descrittivo per la destinazione. Questo nome deve essere univoco in tutte le destinazioni (indipendentemente dal tipo) all'interno della regola di raccolta dati.
resourceId	string	ID risorsa ARM della risorsa Adx.

AgentSetting

Oggetto

Impostazione usata per controllare il comportamento di un agente in un computer host

Nome	Tipo	Descrizione
name	KnownAgentSettingName	Nome dell'impostazione. Deve far parte dell'elenco delle impostazioni supportate
value	string	Valore dell'impostazione

AgentSettings

Oggetto

Impostazioni dell'agente usate per modificare il comportamento dell'agente in un determinato host

Nome	Tipo	Descrizione
logs	AgentSetting[]	Tutte le impostazioni applicabili all'agente di log

AzureMonitorMetrics

Oggetto

Destinazione metriche di Monitoraggio di Azure.

Nome	Tipo	Descrizione
name	string	Nome descrittivo per la destinazione. Questo nome deve essere univoco in tutte le destinazioni (indipendentemente dal tipo) all'interno della regola di raccolta dati.

ColumnDefinition

Oggetto

Definizione della colonna di dati personalizzata.

Nome	Tipo	Descrizione
name	string	Nome della colonna.
type	KnownColumnDefinitionType	Tipo di dati della colonna.

createdByType

Enumerazione

Tipo di identità che ha creato la risorsa.

Valore	Descrizione
User
Application
ManagedIdentity
Key

DataCollectionRuleResource

Oggetto

Definizione della risorsa di primo livello rilevata da ARM.

Nome	Tipo	Descrizione
etag	string	Tag di entità risorsa (ETag).
id	string	ID completo della risorsa.
identity	Identity	Identità del servizio gestita della risorsa.
kind	KnownDataCollectionRuleResourceKind	Tipo di risorsa.
location	string	Posizione geografica in cui risiede la risorsa.
name	string	Nome della risorsa.
properties.agentSettings	AgentSettings	Impostazioni dell'agente usate per modificare il comportamento dell'agente in un determinato host
properties.dataCollectionEndpointId	string	ID risorsa dell'endpoint di raccolta dati con cui è possibile usare questa regola.
properties.dataFlows	DataFlow[]	Specifica dei flussi di dati.
properties.dataSources	DataSources	Specifica delle origini dati. Questa proprietà è facoltativa e può essere omessa se la regola deve essere usata tramite chiamate dirette all'endpoint di cui è stato effettuato il provisioning.
properties.description	string	Descrizione della regola di raccolta dati.
properties.destinations	Destinations	Specifica delle destinazioni.
properties.endpoints	Endpoints	Definisce gli endpoint di inserimento a cui inviare dati tramite questa regola.
properties.immutableId	string	ID non modificabile di questa regola di raccolta dati. Questa proprietà è DI SOLA LETTURA.
properties.metadata	Metadata	Metadati relativi alla risorsa
properties.provisioningState	KnownDataCollectionRuleProvisioningState	Stato del provisioning delle risorse.
properties.references	References	Definisce tutti i riferimenti che possono essere usati in altre sezioni del Registro Azure Container
properties.streamDeclarations	<string,  StreamDeclaration>	Dichiarazione di flussi personalizzati usati in questa regola.
systemData	SystemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.
tags	object	Tag di risorsa.
type	string	Tipo della risorsa.

DataFlow

Oggetto

Definizione dei flussi inviati a quali destinazioni.

Nome	Tipo	Descrizione
builtInTransform	string	Trasformazione builtIn per trasformare i dati del flusso
captureOverflow	boolean	Flag per abilitare la colonna overflow nelle destinazioni LA
destinations	string[]	Elenco delle destinazioni per questo flusso di dati.
outputStream	string	Flusso di output della trasformazione. Obbligatorio solo se la trasformazione modifica i dati in un flusso diverso.
streams	KnownDataFlowStreams[]	Elenco di flussi per questo flusso di dati.
transformKql	string	Query KQL per trasformare i dati del flusso.

DataImports

Oggetto

Specifiche delle origini dati basate sul pull

Nome	Tipo	Descrizione
eventHub	EventHub	Definizione della configurazione dell'hub eventi.

DataSources

Oggetto

Specifica delle origini dati. Questa proprietà è facoltativa e può essere omessa se la regola deve essere usata tramite chiamate dirette all'endpoint di cui è stato effettuato il provisioning.

Nome	Tipo	Descrizione
dataImports	DataImports	Specifiche delle origini dati basate sul pull
extensions	ExtensionDataSource[]	Elenco delle configurazioni dell'origine dati dell'estensione macchina virtuale di Azure.
iisLogs	IisLogsDataSource[]	Elenco delle configurazioni di origine dei log IIS.
logFiles	LogFilesDataSource[]	Elenco delle configurazioni di origine dei file di log.
performanceCounters	PerfCounterDataSource[]	Elenco delle configurazioni dell'origine dati del contatore delle prestazioni.
platformTelemetry	PlatformTelemetryDataSource[]	Elenco delle configurazioni di telemetria della piattaforma
prometheusForwarder	PrometheusForwarderDataSource[]	Elenco delle configurazioni dell'origine dati del server d'inoltro Prometheus.
syslog	SyslogDataSource[]	Elenco delle configurazioni dell'origine dati Syslog.
windowsEventLogs	WindowsEventLogDataSource[]	Elenco delle configurazioni dell'origine dati del registro eventi di Windows.
windowsFirewallLogs	WindowsFirewallLogsDataSource[]	Elenco delle configurazioni di origine dei log di Windows Firewall.

Destinations

Oggetto

Specifica delle destinazioni.

Nome	Tipo	Descrizione
azureDataExplorer	AdxDestination[]	Elenco delle destinazioni di Esplora dati di Azure.
azureMonitorMetrics	AzureMonitorMetrics	Destinazione metriche di Monitoraggio di Azure.
eventHubs	EventHubDestination[]	Elenco delle destinazioni di Hub eventi.
eventHubsDirect	EventHubDirectDestination[]	Elenco delle destinazioni dirette di Hub eventi.
logAnalytics	LogAnalyticsDestination[]	Elenco delle destinazioni di log Analitica.
microsoftFabric	MicrosoftFabricDestination[]	Elenco delle destinazioni di Microsoft Fabric.
monitoringAccounts	MonitoringAccountDestination[]	Elenco delle destinazioni dell'account di monitoraggio.
storageAccounts	StorageBlobDestination[]	Elenco delle destinazioni degli account di archiviazione.
storageBlobsDirect	StorageBlobDestination[]	Elenco di destinazioni dirette blob di archiviazione. Da usare solo per l'invio di dati direttamente da archiviare dall'agente.
storageTablesDirect	StorageTableDestination[]	Elenco delle destinazioni dirette della tabella di archiviazione.

Endpoints

Oggetto

Definisce gli endpoint di inserimento a cui inviare dati tramite questa regola.

Nome	Tipo	Descrizione
logsIngestion	string	Endpoint di inserimento per i log
metricsIngestion	string	Endpoint di inserimento per le metriche

EnrichmentData

Oggetto

Tutte le origini dati di arricchimento a cui si fa riferimento nei flussi di dati

Nome	Tipo	Descrizione
storageBlobs	StorageBlob[]	Tutti i BLOB di archiviazione usati come origini dati di arricchimento

ErrorAdditionalInfo

Oggetto

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorDetail

Oggetto

Dettagli dell'errore.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorDetail[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorResponseCommonV2

Oggetto

Risposta di errore

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.

EventHub

Oggetto

Definizione della configurazione dell'hub eventi.

Nome	Tipo	Descrizione
consumerGroup	string	Nome del gruppo di consumer dell'hub eventi
name	string	Nome descrittivo per l'origine dati. Questo nome deve essere univoco in tutte le origini dati (indipendentemente dal tipo) all'interno della regola di raccolta dati.
stream	string	Flusso da raccogliere da EventHub

EventHubDestination

Oggetto

Nome	Tipo	Descrizione
eventHubResourceId	string	ID risorsa dell'hub eventi.
name	string	Nome descrittivo per la destinazione. Questo nome deve essere univoco in tutte le destinazioni (indipendentemente dal tipo) all'interno della regola di raccolta dati.

EventHubDirectDestination

Oggetto

Nome	Tipo	Descrizione
eventHubResourceId	string	ID risorsa dell'hub eventi.
name	string	Nome descrittivo per la destinazione. Questo nome deve essere univoco in tutte le destinazioni (indipendentemente dal tipo) all'interno della regola di raccolta dati.

ExtensionDataSource

Oggetto

Definizione dei dati raccolti da un'estensione di macchina virtuale separata che si integra con l'agente di Monitoraggio di Azure. Raccolto da computer Windows e Linux, a seconda dell'estensione definita.

Nome	Tipo	Descrizione
extensionName	string	Nome dell'estensione della macchina virtuale.
extensionSettings	object	Impostazioni dell'estensione. Il formato è specifico per una particolare estensione.
inputDataSources	string[]	L'elenco di origini dati da cui questa estensione necessita di dati.
name	string	Nome descrittivo per l'origine dati. Questo nome deve essere univoco in tutte le origini dati (indipendentemente dal tipo) all'interno della regola di raccolta dati.
streams	KnownExtensionDataSourceStreams[]	Elenco di flussi a cui verrà inviata l'origine dati. Un flusso indica lo schema che verrà usato per questi dati e in genere la tabella in Log Analitica i dati verranno inviati.

Identity

Oggetto

Identità del servizio gestita della risorsa.

Nome	Tipo	Descrizione
principalId	string (uuid)	ID entità servizio dell'identità assegnata dal sistema. Questa proprietà verrà fornita solo per un'identità assegnata dal sistema.
tenantId	string (uuid)	ID tenant dell'identità assegnata dal sistema. Questa proprietà verrà fornita solo per un'identità assegnata dal sistema.
type	ManagedServiceIdentityType	Tipo di identità del servizio gestito (in cui sono consentiti sia i tipi SystemAssigned che UserAssigned).
userAssignedIdentities	<string,  UserAssignedIdentity>	identità User-Assigned Set di identità assegnate dall'utente associate alla risorsa. Le chiavi del dizionario userAssignedIdentities saranno ID risorsa ARM nel formato : '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. I valori del dizionario possono essere oggetti vuoti ({}) nelle richieste.

IisLogsDataSource

Oggetto

Consente di raccogliere i log IIS da questa regola di raccolta dati.

Nome	Tipo	Descrizione
logDirectories	string[]	Percorso file di percorsi assoluti
name	string	Nome descrittivo per l'origine dati. Questo nome deve essere univoco in tutte le origini dati (indipendentemente dal tipo) all'interno della regola di raccolta dati.
streams	string[]	Flussi IIS
transformKql	string	Query KQL per trasformare l'origine dati.

KnownAgentSettingName

Enumerazione

Nome dell'impostazione. Deve far parte dell'elenco delle impostazioni supportate

Valore	Descrizione
MaxDiskQuotaInMB
UseTimeReceivedForForwardedEvents

KnownColumnDefinitionType

Enumerazione

Tipo di dati della colonna.

Valore	Descrizione
string
int
long
real
boolean
datetime
dynamic

KnownDataCollectionRuleProvisioningState

Enumerazione

Stato del provisioning delle risorse.

Valore	Descrizione
Creating
Updating
Deleting
Succeeded
Canceled
Failed

KnownDataCollectionRuleResourceKind

Enumerazione

Tipo di risorsa.

Valore	Descrizione
Linux
Windows

KnownDataFlowStreams

Enumerazione

Elenco di flussi per questo flusso di dati.

Valore	Descrizione
Microsoft-Event
Microsoft-InsightsMetrics
Microsoft-Perf
Microsoft-Syslog
Microsoft-WindowsEvent

KnownExtensionDataSourceStreams

Enumerazione

Elenco di flussi a cui verrà inviata l'origine dati. Un flusso indica lo schema che verrà usato per questi dati e in genere la tabella in Log Analitica i dati verranno inviati.

Valore	Descrizione
Microsoft-Event
Microsoft-InsightsMetrics
Microsoft-Perf
Microsoft-Syslog
Microsoft-WindowsEvent

KnownLogFilesDataSourceFormat

Enumerazione

Formato dei dati dei file di log

Valore	Descrizione
json
text

KnownLogFileTextSettingsRecordStartTimestampFormat

Enumerazione

Uno dei formati di timestamp supportati

Valore	Descrizione
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

Enumerazione

Elenco di flussi a cui verrà inviata l'origine dati. Un flusso indica lo schema che verrà usato per questi dati e in genere la tabella in Log Analitica i dati verranno inviati.

Valore	Descrizione
Microsoft-Perf
Microsoft-InsightsMetrics

KnownPrometheusForwarderDataSourceStreams

Enumerazione

Elenco di flussi a cui verrà inviata l'origine dati.

Valore	Descrizione
Microsoft-PrometheusMetrics

KnownStorageBlobLookupType

Enumerazione

Tipo di ricerca da eseguire nel BLOB

Valore	Descrizione
String
Cidr

KnownSyslogDataSourceFacilityNames

Enumerazione

Elenco dei nomi delle strutture.

Valore	Descrizione
*
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

Enumerazione

Livelli di log da raccogliere.

Valore	Descrizione
Debug
Info
Notice
Warning
Error
Critical
Alert
Emergency
*

KnownSyslogDataSourceStreams

Enumerazione

Elenco di flussi a cui verrà inviata l'origine dati. Un flusso indica lo schema che verrà usato per questi dati e in genere la tabella in Log Analitica i dati verranno inviati.

Valore	Descrizione
Microsoft-Syslog

KnownWindowsEventLogDataSourceStreams

Enumerazione

Elenco di flussi a cui verrà inviata l'origine dati. Un flusso indica lo schema che verrà usato per questi dati e in genere la tabella in Log Analitica i dati verranno inviati.

Valore	Descrizione
Microsoft-WindowsEvent
Microsoft-Event

KnownWindowsFirewallLogsDataSourceProfileFilter

Enumerazione

Filtro del profilo dei log del firewall

Valore	Descrizione
Domain
Private
Public

LogAnalyticsDestination

Oggetto

Destinazione di Log Analytics.

Nome	Tipo	Descrizione
name	string	Nome descrittivo per la destinazione. Questo nome deve essere univoco in tutte le destinazioni (indipendentemente dal tipo) all'interno della regola di raccolta dati.
workspaceId	string	ID cliente dell'area di lavoro Log Analytics.
workspaceResourceId	string	ID risorsa dell'area di lavoro Log Analitica.

LogFilesDataSource

Oggetto

Definizione dei file di log personalizzati raccolti da questa regola di raccolta dati

Nome	Tipo	Descrizione
filePatterns	string[]	Modelli di file in cui si trovano i file di log
format	KnownLogFilesDataSourceFormat	Formato dei dati dei file di log
name	string	Nome descrittivo per l'origine dati. Questo nome deve essere univoco in tutte le origini dati (indipendentemente dal tipo) all'interno della regola di raccolta dati.
settings	Settings	Impostazioni specifiche dei file di log.
streams	string[]	Elenco di flussi a cui verrà inviata l'origine dati. Un flusso indica quale schema verrà usato per questa origine dati
transformKql	string	Query KQL per trasformare l'origine dati.

ManagedServiceIdentityType

Enumerazione

Tipo di identità del servizio gestito (in cui sono consentiti sia i tipi SystemAssigned che UserAssigned).

Valore	Descrizione
None
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned

Metadata

Oggetto

Metadati relativi alla risorsa

Nome	Tipo	Descrizione
provisionedBy	string	Offerta di Azure che gestisce questa risorsa per conto del cliente.
provisionedByImmutableId	string	ID non modificabile dell'offerta azure che gestisce questa risorsa per conto del cliente.
provisionedByResourceId	string	ID risorsa dell'offerta azure che gestisce questa risorsa per conto del cliente.

MicrosoftFabricDestination

Oggetto

Destinazione Di Microsoft Fabric (non Azure).

Nome	Tipo	Descrizione
artifactId	string	ID artefatto della risorsa di Microsoft Fabric.
databaseName	string	Nome del database in cui verranno inseriti i dati.
ingestionUri	string	URI di inserimento della risorsa di Microsoft Fabric.
name	string	Nome descrittivo per la destinazione. Questo nome deve essere univoco in tutte le destinazioni (indipendentemente dal tipo) all'interno della regola di raccolta dati.
tenantId	string	ID tenant della risorsa di Microsoft Fabric.

MonitoringAccountDestination

Oggetto

Destinazione dell'account di monitoraggio.

Nome	Tipo	Descrizione
accountId	string	ID non modificabile dell'account.
accountResourceId	string	ID risorsa dell'account di monitoraggio.
name	string	Nome descrittivo per la destinazione. Questo nome deve essere univoco in tutte le destinazioni (indipendentemente dal tipo) all'interno della regola di raccolta dati.

PerfCounterDataSource

Oggetto

Definizione dei contatori delle prestazioni che verranno raccolti e di come verranno raccolti da questa regola di raccolta dati. Raccolto da computer Windows e Linux in cui è presente il contatore.

Nome	Tipo	Descrizione
counterSpecifiers	string[]	Elenco dei nomi degli identificatori dei contatori delle prestazioni da raccogliere. Usare un carattere jolly (*) per raccogliere un contatore per tutte le istanze. Per ottenere un elenco di contatori delle prestazioni in Windows, eseguire il comando 'typeperf'.
name	string	Nome descrittivo per l'origine dati. Questo nome deve essere univoco in tutte le origini dati (indipendentemente dal tipo) all'interno della regola di raccolta dati.
samplingFrequencyInSeconds	integer (int32)	Numero di secondi tra le misurazioni del contatore consecutive (campioni).
streams	KnownPerfCounterDataSourceStreams[]	Elenco di flussi a cui verrà inviata l'origine dati. Un flusso indica lo schema che verrà usato per questi dati e in genere la tabella in Log Analitica i dati verranno inviati.
transformKql	string	Query KQL per trasformare l'origine dati.

PlatformTelemetryDataSource

Oggetto

Definizione della configurazione dell'origine dati di telemetria della piattaforma

Nome	Tipo	Descrizione
name	string	Nome descrittivo per l'origine dati. Questo nome deve essere univoco in tutte le origini dati (indipendentemente dal tipo) all'interno della regola di raccolta dati.
streams	string[]	Elenco dei flussi di telemetria della piattaforma da raccogliere

PrometheusForwarderDataSource

Oggetto

Definizione della configurazione di inoltro delle metriche prometheus.

Nome	Tipo	Descrizione
labelIncludeFilter	object	Elenco dei filtri di inclusione delle etichette sotto forma di coppie "nome-valore". Attualmente è supportata una sola etichetta: 'microsoft_metrics_include_label'. I valori delle etichette vengono confrontati senza distinzione tra maiuscole e minuscole.
name	string	Nome descrittivo per l'origine dati. Questo nome deve essere univoco in tutte le origini dati (indipendentemente dal tipo) all'interno della regola di raccolta dati.
streams	KnownPrometheusForwarderDataSourceStreams[]	Elenco di flussi a cui verrà inviata l'origine dati.

References

Oggetto

Definisce tutti i riferimenti che possono essere usati in altre sezioni del Registro Azure Container

Nome	Tipo	Descrizione
enrichmentData	EnrichmentData	Tutte le origini dati di arricchimento a cui si fa riferimento nei flussi di dati

Settings

Oggetto

Impostazioni specifiche dei file di log.

Nome	Tipo	Descrizione
text	Text	Impostazioni del testo

StorageBlob

Oggetto

Nome	Tipo	Descrizione
blobUrl	string	URL del BLOB di archiviazione
lookupType	KnownStorageBlobLookupType	Tipo di ricerca da eseguire nel BLOB
name	string	Nome dell'origine dati di arricchimento usata come alias quando si fa riferimento a questa origine dati nei flussi di dati
resourceId	string	ID risorsa dell'account di archiviazione che ospita il BLOB

StorageBlobDestination

Oggetto

Nome	Tipo	Descrizione
containerName	string	Nome del contenitore del BLOB di archiviazione.
name	string	Nome descrittivo per la destinazione. Questo nome deve essere univoco in tutte le destinazioni (indipendentemente dal tipo) all'interno della regola di raccolta dati.
storageAccountResourceId	string	ID risorsa dell'account di archiviazione.

StorageTableDestination

Oggetto

Nome	Tipo	Descrizione
name	string	Nome descrittivo per la destinazione. Questo nome deve essere univoco in tutte le destinazioni (indipendentemente dal tipo) all'interno della regola di raccolta dati.
storageAccountResourceId	string	ID risorsa dell'account di archiviazione.
tableName	string	Nome della tabella di archiviazione.

StreamDeclaration

Oggetto

Dichiarazione di un flusso personalizzato.

Nome	Tipo	Descrizione
columns	ColumnDefinition[]	Elenco di colonne usate dai dati in questo flusso.

SyslogDataSource

Oggetto

Definizione dei dati syslog che verranno raccolti e di come verranno raccolti. Raccolto solo dai computer Linux.

Nome	Tipo	Descrizione
facilityNames	KnownSyslogDataSourceFacilityNames[]	Elenco dei nomi delle strutture.
logLevels	KnownSyslogDataSourceLogLevels[]	Livelli di log da raccogliere.
name	string	Nome descrittivo per l'origine dati. Questo nome deve essere univoco in tutte le origini dati (indipendentemente dal tipo) all'interno della regola di raccolta dati.
streams	KnownSyslogDataSourceStreams[]	Elenco di flussi a cui verrà inviata l'origine dati. Un flusso indica lo schema che verrà usato per questi dati e in genere la tabella in Log Analitica i dati verranno inviati.
transformKql	string	Query KQL per trasformare l'origine dati.

SystemData

Oggetto

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome	Tipo	Descrizione
createdAt	string (date-time)	Timestamp della creazione della risorsa (UTC).
createdBy	string	Identità che ha creato la risorsa.
createdByType	createdByType	Tipo di identità che ha creato la risorsa.
lastModifiedAt	string (date-time)	Timestamp dell'ultima modifica della risorsa (UTC)
lastModifiedBy	string	Identità che ha modificato l'ultima volta la risorsa.
lastModifiedByType	createdByType	Tipo di identità che ha modificato l'ultima volta la risorsa.

Text

Oggetto

Impostazioni del testo

Nome	Tipo	Descrizione
recordStartTimestampFormat	KnownLogFileTextSettingsRecordStartTimestampFormat	Uno dei formati di timestamp supportati

UserAssignedIdentity

Oggetto

Proprietà di identità assegnate dall'utente

Nome	Tipo	Descrizione
clientId	string (uuid)	ID client dell'identità assegnata.
principalId	string (uuid)	ID entità dell'identità assegnata.

WindowsEventLogDataSource

Oggetto

Definizione degli eventi del registro eventi di Windows raccolti e della modalità di raccolta. Raccolto solo dai computer Windows.

Nome	Tipo	Descrizione
name	string	Nome descrittivo per l'origine dati. Questo nome deve essere univoco in tutte le origini dati (indipendentemente dal tipo) all'interno della regola di raccolta dati.
streams	KnownWindowsEventLogDataSourceStreams[]	Elenco di flussi a cui verrà inviata l'origine dati. Un flusso indica lo schema che verrà usato per questi dati e in genere la tabella in Log Analitica i dati verranno inviati.
transformKql	string	Query KQL per trasformare l'origine dati.
xPathQueries	string[]	Elenco di query del registro eventi di Windows in formato XPATH.

WindowsFirewallLogsDataSource

Oggetto

Consente di raccogliere i log del firewall tramite questa regola di raccolta dati.

Nome	Tipo	Descrizione
name	string	Nome descrittivo per l'origine dati. Questo nome deve essere univoco in tutte le origini dati (indipendentemente dal tipo) all'interno della regola di raccolta dati.
profileFilter	KnownWindowsFirewallLogsDataSourceProfileFilter[]	Filtro del profilo dei log del firewall
streams	string[]	Flussi dei log del firewall