@pulumi/databricks/getDataQualityMonitor.d.ts

A Pulumi package for creating and managing databricks cloud resources.

import * as pulumi from "@pulumi/pulumi";
import * as outputs from "./types/output";
/**
 * [![Public Preview](https://img.shields.io/badge/Release_Stage-Public_Preview-yellowgreen)](https://docs.databricks.com/aws/en/release-notes/release-types)
 *
 * This data source can be used to fetch a data quality monitor.
 *
 * For the `table` `objectType`, the caller must either:
 * 1. be an owner of the table's parent catalog
 * 2. have **USE_CATALOG** on the table's parent catalog and be an owner of the table's parent schema.
 * 3. have the following permissions:
 *    - **USE_CATALOG** on the table's parent catalog
 *    - **USE_SCHEMA** on the table's parent schema
 *    - **SELECT** privilege on the table.
 *
 * > **Note** This data source can only be used with a workspace-level provider!
 *
 * ## Example Usage
 *
 * Getting a data quality monitor by Unity Catalog object type (currently supports `schema` and `table`) and object id:
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as databricks from "@pulumi/databricks";
 *
 * const _this = databricks.getSchema({
 *     name: "my_catalog.my_schema",
 * });
 * const thisGetDataQualityMonitor = _this.then(_this => databricks.getDataQualityMonitor({
 *     objectType: "schema",
 *     objectId: _this.schemaInfo?.schemaId,
 * }));
 * ```
 */
export declare function getDataQualityMonitor(args: GetDataQualityMonitorArgs, opts?: pulumi.InvokeOptions): Promise<GetDataQualityMonitorResult>;
/**
 * A collection of arguments for invoking getDataQualityMonitor.
 */
export interface GetDataQualityMonitorArgs {
    /**
     * The UUID of the request object. It is `schemaId` for `schema`, and `tableId` for `table`.
     *
     * Find the `schemaId` from either:
     * 1. The [schemaId](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.
     * 2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) > select the `schema` > go to the `Details` tab > the `Schema ID` field.
     *
     * Find the `tableId` from either:
     * 1. The [tableId](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.
     * 2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) > select the `table` > go to the `Details` tab > the `Table ID` field
     */
    objectId: string;
    /**
     * The type of the monitored object. Can be one of the following: `schema` or `table`
     */
    objectType: string;
}
/**
 * A collection of values returned by getDataQualityMonitor.
 */
export interface GetDataQualityMonitorResult {
    /**
     * (AnomalyDetectionConfig) - Anomaly Detection Configuration, applicable to `schema` object types
     */
    readonly anomalyDetectionConfig: outputs.GetDataQualityMonitorAnomalyDetectionConfig;
    /**
     * (DataProfilingConfig) - Data Profiling Configuration, applicable to `table` object types. Exactly one `Analysis Configuration`
     * must be present
     */
    readonly dataProfilingConfig: outputs.GetDataQualityMonitorDataProfilingConfig;
    /**
     * The provider-assigned unique ID for this managed resource.
     */
    readonly id: string;
    /**
     * (string) - The UUID of the request object. It is `schemaId` for `schema`, and `tableId` for `table`.
     */
    readonly objectId: string;
    /**
     * (string) - The type of the monitored object. Can be one of the following: `schema` or `table`
     */
    readonly objectType: string;
}
/**
 * [![Public Preview](https://img.shields.io/badge/Release_Stage-Public_Preview-yellowgreen)](https://docs.databricks.com/aws/en/release-notes/release-types)
 *
 * This data source can be used to fetch a data quality monitor.
 *
 * For the `table` `objectType`, the caller must either:
 * 1. be an owner of the table's parent catalog
 * 2. have **USE_CATALOG** on the table's parent catalog and be an owner of the table's parent schema.
 * 3. have the following permissions:
 *    - **USE_CATALOG** on the table's parent catalog
 *    - **USE_SCHEMA** on the table's parent schema
 *    - **SELECT** privilege on the table.
 *
 * > **Note** This data source can only be used with a workspace-level provider!
 *
 * ## Example Usage
 *
 * Getting a data quality monitor by Unity Catalog object type (currently supports `schema` and `table`) and object id:
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as databricks from "@pulumi/databricks";
 *
 * const _this = databricks.getSchema({
 *     name: "my_catalog.my_schema",
 * });
 * const thisGetDataQualityMonitor = _this.then(_this => databricks.getDataQualityMonitor({
 *     objectType: "schema",
 *     objectId: _this.schemaInfo?.schemaId,
 * }));
 * ```
 */
export declare function getDataQualityMonitorOutput(args: GetDataQualityMonitorOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetDataQualityMonitorResult>;
/**
 * A collection of arguments for invoking getDataQualityMonitor.
 */
export interface GetDataQualityMonitorOutputArgs {
    /**
     * The UUID of the request object. It is `schemaId` for `schema`, and `tableId` for `table`.
     *
     * Find the `schemaId` from either:
     * 1. The [schemaId](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.
     * 2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) > select the `schema` > go to the `Details` tab > the `Schema ID` field.
     *
     * Find the `tableId` from either:
     * 1. The [tableId](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.
     * 2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) > select the `table` > go to the `Details` tab > the `Table ID` field
     */
    objectId: pulumi.Input<string>;
    /**
     * The type of the monitored object. Can be one of the following: `schema` or `table`
     */
    objectType: pulumi.Input<string>;
}