databricks.QualityMonitorV2
Explore with Pulumi AI
Users with MANAGE Schema can use quality monitor v2 to set up data quality monitoring checks for UC objects, currently support schema.
Note This resource can only be used with an workspace-level provider!
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as databricks from "@pulumi/databricks";
const _this = new databricks.Schema("this", {
catalogName: "my_catalog",
name: "my_schema",
});
const thisQualityMonitorV2 = new databricks.QualityMonitorV2("this", {
objectType: "schema",
objectId: _this.schemaId,
});
import pulumi
import pulumi_databricks as databricks
this = databricks.Schema("this",
catalog_name="my_catalog",
name="my_schema")
this_quality_monitor_v2 = databricks.QualityMonitorV2("this",
object_type="schema",
object_id=this.schema_id)
package main
import (
"github.com/pulumi/pulumi-databricks/sdk/go/databricks"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
this, err := databricks.NewSchema(ctx, "this", &databricks.SchemaArgs{
CatalogName: pulumi.String("my_catalog"),
Name: pulumi.String("my_schema"),
})
if err != nil {
return err
}
_, err = databricks.NewQualityMonitorV2(ctx, "this", &databricks.QualityMonitorV2Args{
ObjectType: pulumi.String("schema"),
ObjectId: this.SchemaId,
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Databricks = Pulumi.Databricks;
return await Deployment.RunAsync(() =>
{
var @this = new Databricks.Schema("this", new()
{
CatalogName = "my_catalog",
Name = "my_schema",
});
var thisQualityMonitorV2 = new Databricks.QualityMonitorV2("this", new()
{
ObjectType = "schema",
ObjectId = @this.SchemaId,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.databricks.Schema;
import com.pulumi.databricks.SchemaArgs;
import com.pulumi.databricks.QualityMonitorV2;
import com.pulumi.databricks.QualityMonitorV2Args;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var this_ = new Schema("this", SchemaArgs.builder()
.catalogName("my_catalog")
.name("my_schema")
.build());
var thisQualityMonitorV2 = new QualityMonitorV2("thisQualityMonitorV2", QualityMonitorV2Args.builder()
.objectType("schema")
.objectId(this_.schemaId())
.build());
}
}
resources:
this:
type: databricks:Schema
properties:
catalogName: my_catalog
name: my_schema
thisQualityMonitorV2:
type: databricks:QualityMonitorV2
name: this
properties:
objectType: schema
objectId: ${this.schemaId}
Create QualityMonitorV2 Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new QualityMonitorV2(name: string, args: QualityMonitorV2Args, opts?: CustomResourceOptions);
@overload
def QualityMonitorV2(resource_name: str,
args: QualityMonitorV2Args,
opts: Optional[ResourceOptions] = None)
@overload
def QualityMonitorV2(resource_name: str,
opts: Optional[ResourceOptions] = None,
object_id: Optional[str] = None,
object_type: Optional[str] = None)
func NewQualityMonitorV2(ctx *Context, name string, args QualityMonitorV2Args, opts ...ResourceOption) (*QualityMonitorV2, error)
public QualityMonitorV2(string name, QualityMonitorV2Args args, CustomResourceOptions? opts = null)
public QualityMonitorV2(String name, QualityMonitorV2Args args)
public QualityMonitorV2(String name, QualityMonitorV2Args args, CustomResourceOptions options)
type: databricks:QualityMonitorV2
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args QualityMonitorV2Args
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args QualityMonitorV2Args
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args QualityMonitorV2Args
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args QualityMonitorV2Args
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args QualityMonitorV2Args
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var qualityMonitorV2Resource = new Databricks.QualityMonitorV2("qualityMonitorV2Resource", new()
{
ObjectId = "string",
ObjectType = "string",
});
example, err := databricks.NewQualityMonitorV2(ctx, "qualityMonitorV2Resource", &databricks.QualityMonitorV2Args{
ObjectId: pulumi.String("string"),
ObjectType: pulumi.String("string"),
})
var qualityMonitorV2Resource = new QualityMonitorV2("qualityMonitorV2Resource", QualityMonitorV2Args.builder()
.objectId("string")
.objectType("string")
.build());
quality_monitor_v2_resource = databricks.QualityMonitorV2("qualityMonitorV2Resource",
object_id="string",
object_type="string")
const qualityMonitorV2Resource = new databricks.QualityMonitorV2("qualityMonitorV2Resource", {
objectId: "string",
objectType: "string",
});
type: databricks:QualityMonitorV2
properties:
objectId: string
objectType: string
QualityMonitorV2 Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The QualityMonitorV2 resource accepts the following input properties:
- Object
Id string - The uuid of the request object. For example, schema id
- Object
Type string - The type of the monitored object. Can be one of the following: schema
- Object
Id string - The uuid of the request object. For example, schema id
- Object
Type string - The type of the monitored object. Can be one of the following: schema
- object
Id String - The uuid of the request object. For example, schema id
- object
Type String - The type of the monitored object. Can be one of the following: schema
- object
Id string - The uuid of the request object. For example, schema id
- object
Type string - The type of the monitored object. Can be one of the following: schema
- object_
id str - The uuid of the request object. For example, schema id
- object_
type str - The type of the monitored object. Can be one of the following: schema
- object
Id String - The uuid of the request object. For example, schema id
- object
Type String - The type of the monitored object. Can be one of the following: schema
Outputs
All input properties are implicitly available as output properties. Additionally, the QualityMonitorV2 resource produces the following output properties:
- Anomaly
Detection QualityConfig Monitor V2Anomaly Detection Config - (AnomalyDetectionConfig)
- Id string
- The provider-assigned unique ID for this managed resource.
- Anomaly
Detection QualityConfig Monitor V2Anomaly Detection Config - (AnomalyDetectionConfig)
- Id string
- The provider-assigned unique ID for this managed resource.
- anomaly
Detection QualityConfig Monitor V2Anomaly Detection Config - (AnomalyDetectionConfig)
- id String
- The provider-assigned unique ID for this managed resource.
- anomaly
Detection QualityConfig Monitor V2Anomaly Detection Config - (AnomalyDetectionConfig)
- id string
- The provider-assigned unique ID for this managed resource.
- anomaly_
detection_ Qualityconfig Monitor V2Anomaly Detection Config - (AnomalyDetectionConfig)
- id str
- The provider-assigned unique ID for this managed resource.
- anomaly
Detection Property MapConfig - (AnomalyDetectionConfig)
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing QualityMonitorV2 Resource
Get an existing QualityMonitorV2 resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: QualityMonitorV2State, opts?: CustomResourceOptions): QualityMonitorV2
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
anomaly_detection_config: Optional[QualityMonitorV2AnomalyDetectionConfigArgs] = None,
object_id: Optional[str] = None,
object_type: Optional[str] = None) -> QualityMonitorV2
func GetQualityMonitorV2(ctx *Context, name string, id IDInput, state *QualityMonitorV2State, opts ...ResourceOption) (*QualityMonitorV2, error)
public static QualityMonitorV2 Get(string name, Input<string> id, QualityMonitorV2State? state, CustomResourceOptions? opts = null)
public static QualityMonitorV2 get(String name, Output<String> id, QualityMonitorV2State state, CustomResourceOptions options)
resources: _: type: databricks:QualityMonitorV2 get: id: ${id}
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Anomaly
Detection QualityConfig Monitor V2Anomaly Detection Config - (AnomalyDetectionConfig)
- Object
Id string - The uuid of the request object. For example, schema id
- Object
Type string - The type of the monitored object. Can be one of the following: schema
- Anomaly
Detection QualityConfig Monitor V2Anomaly Detection Config Args - (AnomalyDetectionConfig)
- Object
Id string - The uuid of the request object. For example, schema id
- Object
Type string - The type of the monitored object. Can be one of the following: schema
- anomaly
Detection QualityConfig Monitor V2Anomaly Detection Config - (AnomalyDetectionConfig)
- object
Id String - The uuid of the request object. For example, schema id
- object
Type String - The type of the monitored object. Can be one of the following: schema
- anomaly
Detection QualityConfig Monitor V2Anomaly Detection Config - (AnomalyDetectionConfig)
- object
Id string - The uuid of the request object. For example, schema id
- object
Type string - The type of the monitored object. Can be one of the following: schema
- anomaly_
detection_ Qualityconfig Monitor V2Anomaly Detection Config Args - (AnomalyDetectionConfig)
- object_
id str - The uuid of the request object. For example, schema id
- object_
type str - The type of the monitored object. Can be one of the following: schema
- anomaly
Detection Property MapConfig - (AnomalyDetectionConfig)
- object
Id String - The uuid of the request object. For example, schema id
- object
Type String - The type of the monitored object. Can be one of the following: schema
Supporting Types
QualityMonitorV2AnomalyDetectionConfig, QualityMonitorV2AnomalyDetectionConfigArgs
- Last
Run stringId - (string) - Run id of the last run of the workflow
- Latest
Run stringStatus - (string) - The status of the last run of the workflow. Possible values are:
ANOMALY_DETECTION_RUN_STATUS_CANCELED
,ANOMALY_DETECTION_RUN_STATUS_FAILED
,ANOMALY_DETECTION_RUN_STATUS_JOB_DELETED
,ANOMALY_DETECTION_RUN_STATUS_PENDING
,ANOMALY_DETECTION_RUN_STATUS_RUNNING
,ANOMALY_DETECTION_RUN_STATUS_SUCCESS
,ANOMALY_DETECTION_RUN_STATUS_UNKNOWN
,ANOMALY_DETECTION_RUN_STATUS_WORKSPACE_MISMATCH_ERROR
- Last
Run stringId - (string) - Run id of the last run of the workflow
- Latest
Run stringStatus - (string) - The status of the last run of the workflow. Possible values are:
ANOMALY_DETECTION_RUN_STATUS_CANCELED
,ANOMALY_DETECTION_RUN_STATUS_FAILED
,ANOMALY_DETECTION_RUN_STATUS_JOB_DELETED
,ANOMALY_DETECTION_RUN_STATUS_PENDING
,ANOMALY_DETECTION_RUN_STATUS_RUNNING
,ANOMALY_DETECTION_RUN_STATUS_SUCCESS
,ANOMALY_DETECTION_RUN_STATUS_UNKNOWN
,ANOMALY_DETECTION_RUN_STATUS_WORKSPACE_MISMATCH_ERROR
- last
Run StringId - (string) - Run id of the last run of the workflow
- latest
Run StringStatus - (string) - The status of the last run of the workflow. Possible values are:
ANOMALY_DETECTION_RUN_STATUS_CANCELED
,ANOMALY_DETECTION_RUN_STATUS_FAILED
,ANOMALY_DETECTION_RUN_STATUS_JOB_DELETED
,ANOMALY_DETECTION_RUN_STATUS_PENDING
,ANOMALY_DETECTION_RUN_STATUS_RUNNING
,ANOMALY_DETECTION_RUN_STATUS_SUCCESS
,ANOMALY_DETECTION_RUN_STATUS_UNKNOWN
,ANOMALY_DETECTION_RUN_STATUS_WORKSPACE_MISMATCH_ERROR
- last
Run stringId - (string) - Run id of the last run of the workflow
- latest
Run stringStatus - (string) - The status of the last run of the workflow. Possible values are:
ANOMALY_DETECTION_RUN_STATUS_CANCELED
,ANOMALY_DETECTION_RUN_STATUS_FAILED
,ANOMALY_DETECTION_RUN_STATUS_JOB_DELETED
,ANOMALY_DETECTION_RUN_STATUS_PENDING
,ANOMALY_DETECTION_RUN_STATUS_RUNNING
,ANOMALY_DETECTION_RUN_STATUS_SUCCESS
,ANOMALY_DETECTION_RUN_STATUS_UNKNOWN
,ANOMALY_DETECTION_RUN_STATUS_WORKSPACE_MISMATCH_ERROR
- last_
run_ strid - (string) - Run id of the last run of the workflow
- latest_
run_ strstatus - (string) - The status of the last run of the workflow. Possible values are:
ANOMALY_DETECTION_RUN_STATUS_CANCELED
,ANOMALY_DETECTION_RUN_STATUS_FAILED
,ANOMALY_DETECTION_RUN_STATUS_JOB_DELETED
,ANOMALY_DETECTION_RUN_STATUS_PENDING
,ANOMALY_DETECTION_RUN_STATUS_RUNNING
,ANOMALY_DETECTION_RUN_STATUS_SUCCESS
,ANOMALY_DETECTION_RUN_STATUS_UNKNOWN
,ANOMALY_DETECTION_RUN_STATUS_WORKSPACE_MISMATCH_ERROR
- last
Run StringId - (string) - Run id of the last run of the workflow
- latest
Run StringStatus - (string) - The status of the last run of the workflow. Possible values are:
ANOMALY_DETECTION_RUN_STATUS_CANCELED
,ANOMALY_DETECTION_RUN_STATUS_FAILED
,ANOMALY_DETECTION_RUN_STATUS_JOB_DELETED
,ANOMALY_DETECTION_RUN_STATUS_PENDING
,ANOMALY_DETECTION_RUN_STATUS_RUNNING
,ANOMALY_DETECTION_RUN_STATUS_SUCCESS
,ANOMALY_DETECTION_RUN_STATUS_UNKNOWN
,ANOMALY_DETECTION_RUN_STATUS_WORKSPACE_MISMATCH_ERROR
Import
As of Pulumi v1.5, resources can be imported through configuration.
hcl
import {
id = object_type,object_id
to = databricks_quality_monitor_v2.this
}
If you are using an older version of Pulumi, import the resource using the pulumi import
command as follows:
$ pulumi import databricks:index/qualityMonitorV2:QualityMonitorV2 databricks_quality_monitor_v2 object_type,object_id
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- databricks pulumi/pulumi-databricks
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
databricks
Terraform Provider.