Class ObservabilityPipelineAzureDataExplorerDestination

The azure_data_explorer destination sends log events to an Azure Data Explorer table.

Supported pipeline types: logs

Hierarchy

  • ObservabilityPipelineAzureDataExplorerDestination

Constructors

constructor

Properties

additionalProperties? auth batch? buffer? compression? database id ingestionEndpointKey? inputs mappingReference? table tokenScope? type

Constructors

constructor

Properties

Optional additionalProperties

additionalProperties?: {
    [key: string]: any;
}

A container for additional, undeclared properties. This is a holder for any undeclared properties as specified with the 'additionalProperties' keyword in the OAS document.

Type declaration

  • [key: string]: any

auth

auth: ObservabilityPipelineAzureDataExplorerDestinationAuth

Authentication configuration for Azure Data Explorer. The azure_credential_kind field selects the credential type.

Optional batch

batch?: ObservabilityPipelineAzureDataExplorerDestinationBatch

Event batching settings for Azure Data Explorer ingestion.

Optional buffer

buffer?: ObservabilityPipelineBufferOptions

Configuration for buffer settings on destination components.

Optional compression

compression?: ObservabilityPipelineAzureStorageDestinationCompressionGzip

Gzip compression.

database

database: string

The name of the Azure Data Explorer database to ingest into. Supports template syntax.

id

id: string

The unique identifier for this component.

Optional ingestionEndpointKey

ingestionEndpointKey?: string

Name of the environment variable or secret that holds the Azure Data Explorer ingestion endpoint URL. Defaults to DESTINATION_AZURE_DATA_EXPLORER_INGESTION_ENDPOINT (prefixed with DD_OP_ at runtime).

inputs

inputs: string[]

A list of component IDs whose output is used as the input for this component.

Optional mappingReference

mappingReference?: string

The name of a pre-created ingestion mapping on the table used to map incoming events to columns. Supports template syntax.

table

table: string

The name of the Azure Data Explorer table to ingest into. Supports template syntax.

Optional tokenScope

tokenScope?: string

The OAuth scope requested when acquiring an access token for Azure Data Explorer. Defaults to https://kusto.kusto.windows.net/.default.

type

type: ObservabilityPipelineAzureDataExplorerDestinationType

The destination type. The value should always be azure_data_explorer.

Settings

Member Visibility

Theme

Generated using TypeDoc