Databricks SDK for JavaScript
    Preparing search index...

    Interface AlertTask

    interface AlertTask {
        alertId?: string;
        parameters?: Record<string, string>;
        subscribers?: AlertTaskSubscriber[];
        warehouseId?: string;
        workspacePath?: string;
    }
    Index

    Properties

    alertId? parameters? subscribers? warehouseId? workspacePath?

    Properties

    alertId?: string

    The alert_id is the canonical identifier of the alert.

    parameters?: Record<string, string>

    Per-run parameter overrides, keyed by parameter name, applied onto the alert's stored query parameters before the query is executed. Only scalar values are supported. Values may reference job parameters with {{job.parameters.*}}, which are resolved before the task runs. An override whose key does not match a stored parameter fails the task run. Limited to 10000 characters when serialized as JSON; keys must be 1-100 characters and contain only letters, digits, underscores, dashes, and periods.

    subscribers?: AlertTaskSubscriber[]

    The subscribers receive alert evaluation result notifications after the alert task is completed. The number of subscriptions is limited to 100.

    warehouseId?: string

    The warehouse_id identifies the warehouse settings used by the alert task.

    workspacePath?: string

    The workspace_path is the path to the alert file in the workspace. The path:

    • must start with "/Workspace"
    • must be a normalized path. User has to select only one of alert_id or workspace_path to identify the alert.

    Settings

    Member Visibility

    On This Page

    Properties