Docs Home
Databricks v1.63.0 published on Thursday, Mar 13, 2025 by Pulumi
databricks.SqlVisualization
Explore with Pulumi AI
Import
You can import a databricks_sql_visualization resource with ID like the following:
bash
$ pulumi import databricks:index/sqlVisualization:SqlVisualization this <query-id>/<visualization-id>
Create SqlVisualization Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new SqlVisualization(name: string, args: SqlVisualizationArgs, opts?: CustomResourceOptions);@overload
def SqlVisualization(resource_name: str,
args: SqlVisualizationArgs,
opts: Optional[ResourceOptions] = None)
@overload
def SqlVisualization(resource_name: str,
opts: Optional[ResourceOptions] = None,
options: Optional[str] = None,
query_id: Optional[str] = None,
type: Optional[str] = None,
description: Optional[str] = None,
name: Optional[str] = None,
query_plan: Optional[str] = None,
visualization_id: Optional[str] = None)func NewSqlVisualization(ctx *Context, name string, args SqlVisualizationArgs, opts ...ResourceOption) (*SqlVisualization, error)public SqlVisualization(string name, SqlVisualizationArgs args, CustomResourceOptions? opts = null)
public SqlVisualization(String name, SqlVisualizationArgs args)
public SqlVisualization(String name, SqlVisualizationArgs args, CustomResourceOptions options)
type: databricks:SqlVisualization
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 SqlVisualizationArgs
- 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 SqlVisualizationArgs
- 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 SqlVisualizationArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args SqlVisualizationArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args SqlVisualizationArgs
- 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 sqlVisualizationResource = new Databricks.SqlVisualization("sqlVisualizationResource", new()
{
Options = "string",
QueryId = "string",
Type = "string",
Description = "string",
Name = "string",
QueryPlan = "string",
VisualizationId = "string",
});
example, err := databricks.NewSqlVisualization(ctx, "sqlVisualizationResource", &databricks.SqlVisualizationArgs{
Options: pulumi.String("string"),
QueryId: pulumi.String("string"),
Type: pulumi.String("string"),
Description: pulumi.String("string"),
Name: pulumi.String("string"),
QueryPlan: pulumi.String("string"),
VisualizationId: pulumi.String("string"),
})
var sqlVisualizationResource = new SqlVisualization("sqlVisualizationResource", SqlVisualizationArgs.builder()
.options("string")
.queryId("string")
.type("string")
.description("string")
.name("string")
.queryPlan("string")
.visualizationId("string")
.build());
sql_visualization_resource = databricks.SqlVisualization("sqlVisualizationResource",
options="string",
query_id="string",
type="string",
description="string",
name="string",
query_plan="string",
visualization_id="string")
const sqlVisualizationResource = new databricks.SqlVisualization("sqlVisualizationResource", {
options: "string",
queryId: "string",
type: "string",
description: "string",
name: "string",
queryPlan: "string",
visualizationId: "string",
});
type: databricks:SqlVisualization
properties:
description: string
name: string
options: string
queryId: string
queryPlan: string
type: string
visualizationId: string
SqlVisualization 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 SqlVisualization resource accepts the following input properties:
- Options string
- Query
Id string - Type string
- Description string
- Name string
- Query
Plan string - Visualization
Id string
- Options string
- Query
Id string - Type string
- Description string
- Name string
- Query
Plan string - Visualization
Id string
- options String
- query
Id String - type String
- description String
- name String
- query
Plan String - visualization
Id String
- options string
- query
Id string - type string
- description string
- name string
- query
Plan string - visualization
Id string
- options str
- query_
id str - type str
- description str
- name str
- query_
plan str - visualization_
id str
- options String
- query
Id String - type String
- description String
- name String
- query
Plan String - visualization
Id String
Outputs
All input properties are implicitly available as output properties. Additionally, the SqlVisualization resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing SqlVisualization Resource
Get an existing SqlVisualization 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?: SqlVisualizationState, opts?: CustomResourceOptions): SqlVisualization@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
description: Optional[str] = None,
name: Optional[str] = None,
options: Optional[str] = None,
query_id: Optional[str] = None,
query_plan: Optional[str] = None,
type: Optional[str] = None,
visualization_id: Optional[str] = None) -> SqlVisualizationfunc GetSqlVisualization(ctx *Context, name string, id IDInput, state *SqlVisualizationState, opts ...ResourceOption) (*SqlVisualization, error)public static SqlVisualization Get(string name, Input<string> id, SqlVisualizationState? state, CustomResourceOptions? opts = null)public static SqlVisualization get(String name, Output<String> id, SqlVisualizationState state, CustomResourceOptions options)resources: _: type: databricks:SqlVisualization 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.
- Description string
- Name string
- Options string
- Query
Id string - Query
Plan string - Type string
- Visualization
Id string
- Description string
- Name string
- Options string
- Query
Id string - Query
Plan string - Type string
- Visualization
Id string
- description String
- name String
- options String
- query
Id String - query
Plan String - type String
- visualization
Id String
- description string
- name string
- options string
- query
Id string - query
Plan string - type string
- visualization
Id string
- description str
- name str
- options str
- query_
id str - query_
plan str - type str
- visualization_
id str
- description String
- name String
- options String
- query
Id String - query
Plan String - type String
- visualization
Id String
Package Details
- Repository
- databricks pulumi/pulumi-databricks
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
databricksTerraform Provider.