Azure Platform Logs

<div class="condensed-table">
| | |
| --- | --- |
| Version | 1.20.3 (View all) |
| Compatible Kibana version(s) | 8.13.0 or higher |
| Supported Serverless project types
What’s this? | Security
Observability |
| Subscription level
What’s this? | Basic |

</div>
Platform logs provide detailed diagnostic and auditing information for Azure resources and the Azure platform they depend on.

Refer to the Azure Logs page for more information about setting up and using this integration.

eventhub : string It is a fully managed, real-time data ingestion service. Elastic recommends using only letters, numbers, and the hyphen (-) character for Event Hub names to maximize compatibility. You can use existing Event Hubs having underscores (_) in the Event Hub name; in this case, the integration will replace underscores with hyphens (-) when it uses the Event Hub name to create dependent Azure resources behind the scenes (e.g., the storage account container to store Event Hub consumer offsets). Elastic also recommends using a separate event hub for each log type as the field mappings of each log type differ. Default value insights-operational-logs.

consumer_group : string The publish/subscribe mechanism of Event Hubs is enabled through consumer groups. A consumer group is a view (state, position, or offset) of an entire event hub. Consumer groups enable multiple consuming applications to each have a separate view of the event stream, and to read the stream independently at their own pace and with their own offsets. Default value: $Default

connection_string : string The connection string required to communicate with Event Hubs, steps here https://docs.microsoft.com/en-us/azure/event-hubs/event-hubs-get-connection-string.

A Blob Storage account is required in order to store/retrieve/update the offset or state of the eventhub messages. This means that after stopping the filebeat azure module it can start back up at the spot that it stopped processing messages.

storage_account : string The name of the storage account the state/offsets will be stored and updated.

storage_account_key : string The storage account key, this key will be used to authorize access to data in your storage account.

storage_account_container : string The storage account container where the integration stores the checkpoint data for the consumer group. It is an advanced option to use with extreme care. You MUST use a dedicated storage account container for each Azure log type (activity, sign-in, audit logs, and others). DO NOT REUSE the same container name for more than one Azure log type. See Container Names for details on naming rules from Microsoft. The integration generates a default container name if not specified.

resource_manager_endpoint : string Optional, by default we are using the azure public environment, to override, users can provide a specific resource manager endpoint in order to use a different azure environment.

Resource manager endpoints:

# Azure ChinaCloud
https://management.chinacloudapi.cn/

# Azure GermanCloud
https://management.microsoftazure.de/

# Azure PublicCloud
https://management.azure.com/

# Azure USGovernmentCloud
https://management.usgovcloudapi.net/

The platformlogs dataset of the Azure Logs package will collect any platform events that have been streamed through an azure event hub.

{
    "@timestamp": "2020-11-05T14:07:32.000Z",
    "agent": {
        "ephemeral_id": "d3c4d56c-e7c7-489e-9d25-683452d16ec9",
        "hostname": "DESKTOP-RFOOE09",
        "id": "c1118415-bcb7-4cf9-b64d-a6c6e8ebcfac",
        "name": "DESKTOP-RFOOE09",
        "type": "filebeat",
        "version": "7.10.0"
    },
    "azure": {
        "platformlogs": {
            "ActivityId": "5890c6fc-fc6b-47cd-971a-2366a1641d99",
            "Caller": "Portal",
            "Environment": "PROD",
            "EventTimeString": "11/5/2020 2:07:32 PM +00:00",
            "ScaleUnit": "PROD-AM3-AZ501",
            "category": "OperationalLogs",
            "event_category": "Administrative",
            "properties": {
                "Namespace": "obstesteventhubs",
                "SubscriptionId": "7657426d-c4c3-44ac-88a2-3b2cd59e6dba",
                "TrackingId": "5890c6fc-fc6b-47cd-971a-2366a1641d99_M8CH3_M8CH3_G8S3",
                "Via": "https://obstesteventhubs.servicebus.windows.net/$Resources/eventhubs?api-version=2017-04&$skip=0&$top=100"
            }
        },
        "resource": {
            "group": "OBS-TEST",
            "id": "/SUBSCRIPTIONS/7657426D-C4C3-44AC-88A2-3B2CD59E6DBA/RESOURCEGROUPS/OBS-TEST/PROVIDERS/MICROSOFT.EVENTHUB/NAMESPACES/OBSTESTEVENTHUBS",
            "name": "OBSTESTEVENTHUBS",
            "provider": "MICROSOFT.EVENTHUB/NAMESPACES"
        },
        "subscription_id": "7657426D-C4C3-44AC-88A2-3B2CD59E6DBA"
    },
    "cloud": {
        "provider": "azure",
        "region": "West Europe"
    },
    "data_stream": {
        "dataset": "azure.platformlogs",
        "namespace": "default",
        "type": "logs"
    },
    "ecs": {
        "version": "8.11.0"
    },
    "elastic_agent": {
        "id": "02f4e39d-8a1b-4506-a531-b45d0f492ee7",
        "snapshot": false,
        "version": "7.10.0"
    },
    "event": {
        "action": "Retreive Namespace",
        "dataset": "azure.platformlogs",
        "ingested": "2020-11-01T12:02:34.237205200Z",
        "kind": "event",
        "outcome": "success"
    },
    "host": {
        "name": "DESKTOP-RFOOE09"
    }
}

ECS Field Reference

Please refer to the following document for detailed information on ECS fields.