@pulumi/databricks
Version:
A Pulumi package for creating and managing databricks cloud resources.
150 lines (149 loc) • 5.54 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "./types/output";
/**
* [](https://docs.databricks.com/aws/en/release-notes/release-types)
*
* 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
*
* ### Retrieve Alert by ID
* This example retrieves a specific alert by its ID:
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as databricks from "@pulumi/databricks";
*
* const _this = databricks.getAlertV2({
* id: "123",
* });
* ```
*/
export declare function getAlertV2(args: GetAlertV2Args, opts?: pulumi.InvokeOptions): Promise<GetAlertV2Result>;
/**
* A collection of arguments for invoking getAlertV2.
*/
export interface GetAlertV2Args {
/**
* UUID identifying the alert
*/
id: 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;
/**
* (AlertV2RunAs) - 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
*/
readonly effectiveRunAs: outputs.GetAlertV2EffectiveRunAs;
/**
* (AlertV2Evaluation)
*/
readonly evaluation: outputs.GetAlertV2Evaluation;
/**
* (string) - UUID identifying the alert
*/
readonly id: string;
/**
* (string) - Indicates whether the query is trashed. Possible values are: `ACTIVE`, `DELETED`
*/
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;
/**
* (AlertV2RunAs) - 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 `userName` to the email of an active workspace user. Users can only set this to their own email.
* - For service principal: Set `servicePrincipalName` to the application ID. Requires the `servicePrincipal/user` role.
* If not specified, the alert will run as the request user
*/
readonly runAs: outputs.GetAlertV2RunAs;
/**
* (string, deprecated) - 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 `runAs` field instead. This field will be removed in a future release
*/
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;
}
/**
* [](https://docs.databricks.com/aws/en/release-notes/release-types)
*
* 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
*
* ### Retrieve Alert by ID
* This example retrieves a specific alert by its ID:
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as databricks from "@pulumi/databricks";
*
* const _this = databricks.getAlertV2({
* id: "123",
* });
* ```
*/
export declare function getAlertV2Output(args: GetAlertV2OutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetAlertV2Result>;
/**
* A collection of arguments for invoking getAlertV2.
*/
export interface GetAlertV2OutputArgs {
/**
* UUID identifying the alert
*/
id: pulumi.Input<string>;
}