Databricks v1.77.0 published on Tuesday, Nov 4, 2025 by Pulumi
databricks.WorkspaceBinding
Import
This resource can be imported by using combination of workspace ID, securable type and name:
hcl
import {
to = databricks_workspace_binding.this
id = “<workspace_id>|<securable_type>|<securable_name>”
}
Alternatively, when using terraform version 1.4 or earlier, import using the pulumi import command:
bash
$ pulumi import databricks:index/workspaceBinding:WorkspaceBinding this "<workspace_id>|<securable_type>|<securable_name>"
Create WorkspaceBinding Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new WorkspaceBinding(name: string, args: WorkspaceBindingArgs, opts?: CustomResourceOptions);@overload
def WorkspaceBinding(resource_name: str,
args: WorkspaceBindingArgs,
opts: Optional[ResourceOptions] = None)
@overload
def WorkspaceBinding(resource_name: str,
opts: Optional[ResourceOptions] = None,
workspace_id: Optional[str] = None,
binding_type: Optional[str] = None,
catalog_name: Optional[str] = None,
securable_name: Optional[str] = None,
securable_type: Optional[str] = None)func NewWorkspaceBinding(ctx *Context, name string, args WorkspaceBindingArgs, opts ...ResourceOption) (*WorkspaceBinding, error)public WorkspaceBinding(string name, WorkspaceBindingArgs args, CustomResourceOptions? opts = null)
public WorkspaceBinding(String name, WorkspaceBindingArgs args)
public WorkspaceBinding(String name, WorkspaceBindingArgs args, CustomResourceOptions options)
type: databricks:WorkspaceBinding
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 WorkspaceBindingArgs
- 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 WorkspaceBindingArgs
- 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 WorkspaceBindingArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args WorkspaceBindingArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args WorkspaceBindingArgs
- 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 workspaceBindingResource = new Databricks.WorkspaceBinding("workspaceBindingResource", new()
{
WorkspaceId = "string",
BindingType = "string",
SecurableName = "string",
SecurableType = "string",
});
example, err := databricks.NewWorkspaceBinding(ctx, "workspaceBindingResource", &databricks.WorkspaceBindingArgs{
WorkspaceId: pulumi.String("string"),
BindingType: pulumi.String("string"),
SecurableName: pulumi.String("string"),
SecurableType: pulumi.String("string"),
})
var workspaceBindingResource = new WorkspaceBinding("workspaceBindingResource", WorkspaceBindingArgs.builder()
.workspaceId("string")
.bindingType("string")
.securableName("string")
.securableType("string")
.build());
workspace_binding_resource = databricks.WorkspaceBinding("workspaceBindingResource",
workspace_id="string",
binding_type="string",
securable_name="string",
securable_type="string")
const workspaceBindingResource = new databricks.WorkspaceBinding("workspaceBindingResource", {
workspaceId: "string",
bindingType: "string",
securableName: "string",
securableType: "string",
});
type: databricks:WorkspaceBinding
properties:
bindingType: string
securableName: string
securableType: string
workspaceId: string
WorkspaceBinding 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 WorkspaceBinding resource accepts the following input properties:
- Workspace
Id string - ID of the workspace. Change forces creation of a new resource.
- Binding
Type string - Binding mode. Default to
BINDING_TYPE_READ_WRITE. Possible values areBINDING_TYPE_READ_ONLY,BINDING_TYPE_READ_WRITE. - Catalog
Name string - Securable
Name string - Name of securable. Change forces creation of a new resource.
- Securable
Type string - Type of securable. Can be
catalog,external_location,storage_credentialorcredential. Default tocatalog. Change forces creation of a new resource.
- Workspace
Id string - ID of the workspace. Change forces creation of a new resource.
- Binding
Type string - Binding mode. Default to
BINDING_TYPE_READ_WRITE. Possible values areBINDING_TYPE_READ_ONLY,BINDING_TYPE_READ_WRITE. - Catalog
Name string - Securable
Name string - Name of securable. Change forces creation of a new resource.
- Securable
Type string - Type of securable. Can be
catalog,external_location,storage_credentialorcredential. Default tocatalog. Change forces creation of a new resource.
- workspace
Id String - ID of the workspace. Change forces creation of a new resource.
- binding
Type String - Binding mode. Default to
BINDING_TYPE_READ_WRITE. Possible values areBINDING_TYPE_READ_ONLY,BINDING_TYPE_READ_WRITE. - catalog
Name String - securable
Name String - Name of securable. Change forces creation of a new resource.
- securable
Type String - Type of securable. Can be
catalog,external_location,storage_credentialorcredential. Default tocatalog. Change forces creation of a new resource.
- workspace
Id string - ID of the workspace. Change forces creation of a new resource.
- binding
Type string - Binding mode. Default to
BINDING_TYPE_READ_WRITE. Possible values areBINDING_TYPE_READ_ONLY,BINDING_TYPE_READ_WRITE. - catalog
Name string - securable
Name string - Name of securable. Change forces creation of a new resource.
- securable
Type string - Type of securable. Can be
catalog,external_location,storage_credentialorcredential. Default tocatalog. Change forces creation of a new resource.
- workspace_
id str - ID of the workspace. Change forces creation of a new resource.
- binding_
type str - Binding mode. Default to
BINDING_TYPE_READ_WRITE. Possible values areBINDING_TYPE_READ_ONLY,BINDING_TYPE_READ_WRITE. - catalog_
name str - securable_
name str - Name of securable. Change forces creation of a new resource.
- securable_
type str - Type of securable. Can be
catalog,external_location,storage_credentialorcredential. Default tocatalog. Change forces creation of a new resource.
- workspace
Id String - ID of the workspace. Change forces creation of a new resource.
- binding
Type String - Binding mode. Default to
BINDING_TYPE_READ_WRITE. Possible values areBINDING_TYPE_READ_ONLY,BINDING_TYPE_READ_WRITE. - catalog
Name String - securable
Name String - Name of securable. Change forces creation of a new resource.
- securable
Type String - Type of securable. Can be
catalog,external_location,storage_credentialorcredential. Default tocatalog. Change forces creation of a new resource.
Outputs
All input properties are implicitly available as output properties. Additionally, the WorkspaceBinding 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 WorkspaceBinding Resource
Get an existing WorkspaceBinding 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?: WorkspaceBindingState, opts?: CustomResourceOptions): WorkspaceBinding@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
binding_type: Optional[str] = None,
catalog_name: Optional[str] = None,
securable_name: Optional[str] = None,
securable_type: Optional[str] = None,
workspace_id: Optional[str] = None) -> WorkspaceBindingfunc GetWorkspaceBinding(ctx *Context, name string, id IDInput, state *WorkspaceBindingState, opts ...ResourceOption) (*WorkspaceBinding, error)public static WorkspaceBinding Get(string name, Input<string> id, WorkspaceBindingState? state, CustomResourceOptions? opts = null)public static WorkspaceBinding get(String name, Output<String> id, WorkspaceBindingState state, CustomResourceOptions options)resources: _: type: databricks:WorkspaceBinding 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.
- Binding
Type string - Binding mode. Default to
BINDING_TYPE_READ_WRITE. Possible values areBINDING_TYPE_READ_ONLY,BINDING_TYPE_READ_WRITE. - Catalog
Name string - Securable
Name string - Name of securable. Change forces creation of a new resource.
- Securable
Type string - Type of securable. Can be
catalog,external_location,storage_credentialorcredential. Default tocatalog. Change forces creation of a new resource. - Workspace
Id string - ID of the workspace. Change forces creation of a new resource.
- Binding
Type string - Binding mode. Default to
BINDING_TYPE_READ_WRITE. Possible values areBINDING_TYPE_READ_ONLY,BINDING_TYPE_READ_WRITE. - Catalog
Name string - Securable
Name string - Name of securable. Change forces creation of a new resource.
- Securable
Type string - Type of securable. Can be
catalog,external_location,storage_credentialorcredential. Default tocatalog. Change forces creation of a new resource. - Workspace
Id string - ID of the workspace. Change forces creation of a new resource.
- binding
Type String - Binding mode. Default to
BINDING_TYPE_READ_WRITE. Possible values areBINDING_TYPE_READ_ONLY,BINDING_TYPE_READ_WRITE. - catalog
Name String - securable
Name String - Name of securable. Change forces creation of a new resource.
- securable
Type String - Type of securable. Can be
catalog,external_location,storage_credentialorcredential. Default tocatalog. Change forces creation of a new resource. - workspace
Id String - ID of the workspace. Change forces creation of a new resource.
- binding
Type string - Binding mode. Default to
BINDING_TYPE_READ_WRITE. Possible values areBINDING_TYPE_READ_ONLY,BINDING_TYPE_READ_WRITE. - catalog
Name string - securable
Name string - Name of securable. Change forces creation of a new resource.
- securable
Type string - Type of securable. Can be
catalog,external_location,storage_credentialorcredential. Default tocatalog. Change forces creation of a new resource. - workspace
Id string - ID of the workspace. Change forces creation of a new resource.
- binding_
type str - Binding mode. Default to
BINDING_TYPE_READ_WRITE. Possible values areBINDING_TYPE_READ_ONLY,BINDING_TYPE_READ_WRITE. - catalog_
name str - securable_
name str - Name of securable. Change forces creation of a new resource.
- securable_
type str - Type of securable. Can be
catalog,external_location,storage_credentialorcredential. Default tocatalog. Change forces creation of a new resource. - workspace_
id str - ID of the workspace. Change forces creation of a new resource.
- binding
Type String - Binding mode. Default to
BINDING_TYPE_READ_WRITE. Possible values areBINDING_TYPE_READ_ONLY,BINDING_TYPE_READ_WRITE. - catalog
Name String - securable
Name String - Name of securable. Change forces creation of a new resource.
- securable
Type String - Type of securable. Can be
catalog,external_location,storage_credentialorcredential. Default tocatalog. Change forces creation of a new resource. - workspace
Id String - ID of the workspace. Change forces creation of a new resource.
Package Details
- Repository
- databricks pulumi/pulumi-databricks
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
databricksTerraform Provider.
