@pulumi/databricks/getAlertV2.d.ts

A Pulumi package for creating and managing databricks cloud resources.

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
/**
 * The SQL Alert v2 data source allows you to retrieve detailed information about a specific alert in Databricks SQL. This data source provides access to all alert properties, including its configuration, evaluation criteria, notification settings, and schedule.
 *
 * You can use this data source to:
 * - Retrieve alert details for reference in other resources
 * - Check the current state and configuration of an alert
 * - Verify notification settings and subscribers
 * - Examine the schedule configuration
 *
 * ## Example Usage
 */
export declare function getAlertV2(args?: GetAlertV2Args, opts?: pulumi.InvokeOptions): Promise<GetAlertV2Result>;
/**
 * A collection of arguments for invoking getAlertV2.
 */
export interface GetAlertV2Args {
    /**
     * (string) - Custom description for the alert. support mustache template
     */
    customDescription?: string;
    /**
     * (string) - Custom summary for the alert. support mustache template
     */
    customSummary?: string;
    /**
     * (string) - The display name of the alert
     */
    displayName?: string;
    /**
     * (AlertV2Evaluation) -
     */
    evaluation?: inputs.GetAlertV2Evaluation;
    /**
     * (string) - The workspace path of the folder containing the alert. Can only be set on create, and cannot be updated
     */
    parentPath?: string;
    /**
     * (string) - Text of the query to be run
     */
    queryText?: string;
    /**
     * (CronSchedule) -
     */
    schedule?: inputs.GetAlertV2Schedule;
    /**
     * (string) - ID of the SQL warehouse attached to the alert
     */
    warehouseId?: string;
}
/**
 * A collection of values returned by getAlertV2.
 */
export interface GetAlertV2Result {
    /**
     * (string) - The timestamp indicating when the alert was created
     */
    readonly createTime: string;
    /**
     * (string) - Custom description for the alert. support mustache template
     */
    readonly customDescription?: string;
    /**
     * (string) - Custom summary for the alert. support mustache template
     */
    readonly customSummary?: string;
    /**
     * (string) - The display name of the alert
     */
    readonly displayName?: string;
    /**
     * (AlertV2Evaluation) -
     */
    readonly evaluation?: outputs.GetAlertV2Evaluation;
    /**
     * (string) - UUID identifying the alert
     */
    readonly id: string;
    /**
     * (string) - Indicates whether the query is trashed. Possible values are: `ACTIVE`, `TRASHED`
     */
    readonly lifecycleState: string;
    /**
     * (string) - The owner's username. This field is set to "Unavailable" if the user has been deleted
     */
    readonly ownerUserName: string;
    /**
     * (string) - The workspace path of the folder containing the alert. Can only be set on create, and cannot be updated
     */
    readonly parentPath?: string;
    /**
     * (string) - Text of the query to be run
     */
    readonly queryText?: string;
    /**
     * (string) - The run as username. This field is set to "Unavailable" if the user has been deleted
     */
    readonly runAsUserName: string;
    /**
     * (CronSchedule) -
     */
    readonly schedule?: outputs.GetAlertV2Schedule;
    /**
     * (string) - The timestamp indicating when the alert was updated
     */
    readonly updateTime: string;
    /**
     * (string) - ID of the SQL warehouse attached to the alert
     */
    readonly warehouseId?: string;
}
/**
 * The SQL Alert v2 data source allows you to retrieve detailed information about a specific alert in Databricks SQL. This data source provides access to all alert properties, including its configuration, evaluation criteria, notification settings, and schedule.
 *
 * You can use this data source to:
 * - Retrieve alert details for reference in other resources
 * - Check the current state and configuration of an alert
 * - Verify notification settings and subscribers
 * - Examine the schedule configuration
 *
 * ## Example Usage
 */
export declare function getAlertV2Output(args?: GetAlertV2OutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetAlertV2Result>;
/**
 * A collection of arguments for invoking getAlertV2.
 */
export interface GetAlertV2OutputArgs {
    /**
     * (string) - Custom description for the alert. support mustache template
     */
    customDescription?: pulumi.Input<string>;
    /**
     * (string) - Custom summary for the alert. support mustache template
     */
    customSummary?: pulumi.Input<string>;
    /**
     * (string) - The display name of the alert
     */
    displayName?: pulumi.Input<string>;
    /**
     * (AlertV2Evaluation) -
     */
    evaluation?: pulumi.Input<inputs.GetAlertV2EvaluationArgs>;
    /**
     * (string) - The workspace path of the folder containing the alert. Can only be set on create, and cannot be updated
     */
    parentPath?: pulumi.Input<string>;
    /**
     * (string) - Text of the query to be run
     */
    queryText?: pulumi.Input<string>;
    /**
     * (CronSchedule) -
     */
    schedule?: pulumi.Input<inputs.GetAlertV2ScheduleArgs>;
    /**
     * (string) - ID of the SQL warehouse attached to the alert
     */
    warehouseId?: pulumi.Input<string>;
}