Databricks SDK for JavaScript
    Preparing search index...

    Interface Alert

    interface Alert {
        createTime?: Instant;
        customDescription?: string;
        customSummary?: string;
        displayName?: string;
        effectiveRunAs?: AlertRunAs;
        evaluation?: AlertEvaluation;
        id?: string;
        lifecycleState?: AlertLifecycleState;
        ownerUserName?: string;
        parameters?: AlertStatementParameter[];
        parentPath?: string;
        queryText?: string;
        runAs?: AlertRunAs;
        runAsUserName?: string;
        schedule?: CronSchedule;
        updateTime?: Instant;
        warehouseId?: string;
    }
    Index

    Properties

    createTime? customDescription? customSummary? displayName? effectiveRunAs? evaluation? id? lifecycleState? ownerUserName? parameters? parentPath? queryText? runAs? runAsUserName? schedule? updateTime? warehouseId?

    Properties

    createTime?: Instant

    The timestamp indicating when the alert was created.

    customDescription?: string

    Custom description for the alert. support mustache template.

    customSummary?: string

    Custom summary for the alert. support mustache template.

    displayName?: string

    The display name of the alert.

    effectiveRunAs?: AlertRunAs

    The actual identity that will be used to execute the alert. This is an output-only field that shows the resolved run-as identity after applying permissions and defaults.

    evaluation?: AlertEvaluation
    id?: string

    The canonical identifier of the alert to retrieve information about.

    lifecycleState?: AlertLifecycleState

    Indicates whether the query is trashed.

    ownerUserName?: string

    The owner's username. This field is set to "Unavailable" if the user has been deleted.

    parameters?: AlertStatementParameter[]

    A list of parameters to pass into the alert SQL query statement containing parameter markers. Static values only.

    Reference a parameter in the query text as :name. Each parameter must have a unique, non-empty name. Each parameter consists of a name, a value, and optionally a type. To represent a NULL value, the value field may be omitted or set to null explicitly. If the type field is omitted, the value is interpreted as a string.

    If the type is given, parameters will be checked for type correctness according to the given type. A value is correct if the provided string can be converted to the requested type using the cast function. The exact semantics are described in the section cast function of the SQL language reference.

    parentPath?: string

    The workspace path of the folder containing the alert. Can only be set on create, and cannot be updated.

    queryText?: string

    Text of the query to be run.

    runAs?: AlertRunAs

    Specifies the identity that will be used to run the alert. This field allows you to configure alerts to run as a specific user or service principal.

    • For user identity: Set user_name to the email of an active workspace user. Users can only set this to their own email.
    • For service principal: Set service_principal_name to the application ID. Requires the servicePrincipal/user role. If not specified, the alert will run as the request user.
    runAsUserName?: string

    The run as username or application ID of service principal. On Create and Update, this field can be set to application ID of an active service principal. Setting this field requires the servicePrincipal/user role. Deprecated: Use run_as field instead. This field will be removed in a future release.

    schedule?: CronSchedule
    updateTime?: Instant

    The timestamp indicating when the alert was updated.

    warehouseId?: string

    ID of the SQL warehouse attached to the alert.

    Settings

    Member Visibility

    On This Page

    Properties