Docs Packages
  1. Pulumi Registry
  2. Databricks
  3. API Docs
  4. Permissions
databricks logo
Databricks v1.14.0, May 23 23

databricks.Permissions

Explore with Pulumi AI

Import

Import Example Configuration filehcl resource “databricks_mlflow_model” “model” {

name

= “example_model”

description = “MLflow registered model” } resource “databricks_permissions” “model_usage” {

registered_model_id = databricks_mlflow_model.model.registered_model_id

access_control {

group_name

= “users”

permission_level = “CAN_READ”

} } Import commandbash

 $ pulumi import databricks:index/permissions:Permissions model_usage /registered-models/<registered_model_id>

Create Permissions Resource

new Permissions(name: string, args: PermissionsArgs, opts?: CustomResourceOptions);
@overload
def Permissions(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                access_controls: Optional[Sequence[PermissionsAccessControlArgs]] = None,
                authorization: Optional[str] = None,
                cluster_id: Optional[str] = None,
                cluster_policy_id: Optional[str] = None,
                directory_id: Optional[str] = None,
                directory_path: Optional[str] = None,
                experiment_id: Optional[str] = None,
                instance_pool_id: Optional[str] = None,
                job_id: Optional[str] = None,
                notebook_id: Optional[str] = None,
                notebook_path: Optional[str] = None,
                object_type: Optional[str] = None,
                pipeline_id: Optional[str] = None,
                registered_model_id: Optional[str] = None,
                repo_id: Optional[str] = None,
                repo_path: Optional[str] = None,
                sql_alert_id: Optional[str] = None,
                sql_dashboard_id: Optional[str] = None,
                sql_endpoint_id: Optional[str] = None,
                sql_query_id: Optional[str] = None,
                workspace_file_id: Optional[str] = None,
                workspace_file_path: Optional[str] = None)
@overload
def Permissions(resource_name: str,
                args: PermissionsArgs,
                opts: Optional[ResourceOptions] = None)
func NewPermissions(ctx *Context, name string, args PermissionsArgs, opts ...ResourceOption) (*Permissions, error)
public Permissions(string name, PermissionsArgs args, CustomResourceOptions? opts = null)
public Permissions(String name, PermissionsArgs args)
public Permissions(String name, PermissionsArgs args, CustomResourceOptions options)

type: databricks:Permissions
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
name string
The unique name of the resource.
args PermissionsArgs
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 PermissionsArgs
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 PermissionsArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args PermissionsArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args PermissionsArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Permissions Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The Permissions resource accepts the following input properties:

AccessControls List<PermissionsAccessControlArgs>
Authorization string

either tokens or passwords.

ClusterId string

cluster id

ClusterPolicyId string

cluster policy id

DirectoryId string

directory id

DirectoryPath string

path of directory

ExperimentId string

MLflow experiment id

InstancePoolId string

instance pool id

JobId string

job id

NotebookId string

ID of notebook within workspace

NotebookPath string

path of notebook

ObjectType string

type of permissions.

PipelineId string

pipeline id

RegisteredModelId string

MLflow registered model id

RepoId string

repo id

RepoPath string

path of databricks repo directory(/Repos/<username>/...)

SqlAlertId string

SQL alert id

SqlDashboardId string

SQL dashboard id

SqlEndpointId string

SQL warehouse id

SqlQueryId string

SQL query id

WorkspaceFileId string
WorkspaceFilePath string
AccessControls []PermissionsAccessControlArgs
Authorization string

either tokens or passwords.

ClusterId string

cluster id

ClusterPolicyId string

cluster policy id

DirectoryId string

directory id

DirectoryPath string

path of directory

ExperimentId string

MLflow experiment id

InstancePoolId string

instance pool id

JobId string

job id

NotebookId string

ID of notebook within workspace

NotebookPath string

path of notebook

ObjectType string

type of permissions.

PipelineId string

pipeline id

RegisteredModelId string

MLflow registered model id

RepoId string

repo id

RepoPath string

path of databricks repo directory(/Repos/<username>/...)

SqlAlertId string

SQL alert id

SqlDashboardId string

SQL dashboard id

SqlEndpointId string

SQL warehouse id

SqlQueryId string

SQL query id

WorkspaceFileId string
WorkspaceFilePath string
accessControls List<PermissionsAccessControlArgs>
authorization String

either tokens or passwords.

clusterId String

cluster id

clusterPolicyId String

cluster policy id

directoryId String

directory id

directoryPath String

path of directory

experimentId String

MLflow experiment id

instancePoolId String

instance pool id

jobId String

job id

notebookId String

ID of notebook within workspace

notebookPath String

path of notebook

objectType String

type of permissions.

pipelineId String

pipeline id

registeredModelId String

MLflow registered model id

repoId String

repo id

repoPath String

path of databricks repo directory(/Repos/<username>/...)

sqlAlertId String

SQL alert id

sqlDashboardId String

SQL dashboard id

sqlEndpointId String

SQL warehouse id

sqlQueryId String

SQL query id

workspaceFileId String
workspaceFilePath String
accessControls PermissionsAccessControlArgs[]
authorization string

either tokens or passwords.

clusterId string

cluster id

clusterPolicyId string

cluster policy id

directoryId string

directory id

directoryPath string

path of directory

experimentId string

MLflow experiment id

instancePoolId string

instance pool id

jobId string

job id

notebookId string

ID of notebook within workspace

notebookPath string

path of notebook

objectType string

type of permissions.

pipelineId string

pipeline id

registeredModelId string

MLflow registered model id

repoId string

repo id

repoPath string

path of databricks repo directory(/Repos/<username>/...)

sqlAlertId string

SQL alert id

sqlDashboardId string

SQL dashboard id

sqlEndpointId string

SQL warehouse id

sqlQueryId string

SQL query id

workspaceFileId string
workspaceFilePath string
access_controls Sequence[PermissionsAccessControlArgs]
authorization str

either tokens or passwords.

cluster_id str

cluster id

cluster_policy_id str

cluster policy id

directory_id str

directory id

directory_path str

path of directory

experiment_id str

MLflow experiment id

instance_pool_id str

instance pool id

job_id str

job id

notebook_id str

ID of notebook within workspace

notebook_path str

path of notebook

object_type str

type of permissions.

pipeline_id str

pipeline id

registered_model_id str

MLflow registered model id

repo_id str

repo id

repo_path str

path of databricks repo directory(/Repos/<username>/...)

sql_alert_id str

SQL alert id

sql_dashboard_id str

SQL dashboard id

sql_endpoint_id str

SQL warehouse id

sql_query_id str

SQL query id

workspace_file_id str
workspace_file_path str
accessControls List<Property Map>
authorization String

either tokens or passwords.

clusterId String

cluster id

clusterPolicyId String

cluster policy id

directoryId String

directory id

directoryPath String

path of directory

experimentId String

MLflow experiment id

instancePoolId String

instance pool id

jobId String

job id

notebookId String

ID of notebook within workspace

notebookPath String

path of notebook

objectType String

type of permissions.

pipelineId String

pipeline id

registeredModelId String

MLflow registered model id

repoId String

repo id

repoPath String

path of databricks repo directory(/Repos/<username>/...)

sqlAlertId String

SQL alert id

sqlDashboardId String

SQL dashboard id

sqlEndpointId String

SQL warehouse id

sqlQueryId String

SQL query id

workspaceFileId String
workspaceFilePath String

Outputs

All input properties are implicitly available as output properties. Additionally, the Permissions 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 Permissions Resource

Get an existing Permissions 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?: PermissionsState, opts?: CustomResourceOptions): Permissions
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        access_controls: Optional[Sequence[PermissionsAccessControlArgs]] = None,
        authorization: Optional[str] = None,
        cluster_id: Optional[str] = None,
        cluster_policy_id: Optional[str] = None,
        directory_id: Optional[str] = None,
        directory_path: Optional[str] = None,
        experiment_id: Optional[str] = None,
        instance_pool_id: Optional[str] = None,
        job_id: Optional[str] = None,
        notebook_id: Optional[str] = None,
        notebook_path: Optional[str] = None,
        object_type: Optional[str] = None,
        pipeline_id: Optional[str] = None,
        registered_model_id: Optional[str] = None,
        repo_id: Optional[str] = None,
        repo_path: Optional[str] = None,
        sql_alert_id: Optional[str] = None,
        sql_dashboard_id: Optional[str] = None,
        sql_endpoint_id: Optional[str] = None,
        sql_query_id: Optional[str] = None,
        workspace_file_id: Optional[str] = None,
        workspace_file_path: Optional[str] = None) -> Permissions
func GetPermissions(ctx *Context, name string, id IDInput, state *PermissionsState, opts ...ResourceOption) (*Permissions, error)
public static Permissions Get(string name, Input<string> id, PermissionsState? state, CustomResourceOptions? opts = null)
public static Permissions get(String name, Output<String> id, PermissionsState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
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.
The following state arguments are supported:
AccessControls List<PermissionsAccessControlArgs>
Authorization string

either tokens or passwords.

ClusterId string

cluster id

ClusterPolicyId string

cluster policy id

DirectoryId string

directory id

DirectoryPath string

path of directory

ExperimentId string

MLflow experiment id

InstancePoolId string

instance pool id

JobId string

job id

NotebookId string

ID of notebook within workspace

NotebookPath string

path of notebook

ObjectType string

type of permissions.

PipelineId string

pipeline id

RegisteredModelId string

MLflow registered model id

RepoId string

repo id

RepoPath string

path of databricks repo directory(/Repos/<username>/...)

SqlAlertId string

SQL alert id

SqlDashboardId string

SQL dashboard id

SqlEndpointId string

SQL warehouse id

SqlQueryId string

SQL query id

WorkspaceFileId string
WorkspaceFilePath string
AccessControls []PermissionsAccessControlArgs
Authorization string

either tokens or passwords.

ClusterId string

cluster id

ClusterPolicyId string

cluster policy id

DirectoryId string

directory id

DirectoryPath string

path of directory

ExperimentId string

MLflow experiment id

InstancePoolId string

instance pool id

JobId string

job id

NotebookId string

ID of notebook within workspace

NotebookPath string

path of notebook

ObjectType string

type of permissions.

PipelineId string

pipeline id

RegisteredModelId string

MLflow registered model id

RepoId string

repo id

RepoPath string

path of databricks repo directory(/Repos/<username>/...)

SqlAlertId string

SQL alert id

SqlDashboardId string

SQL dashboard id

SqlEndpointId string

SQL warehouse id

SqlQueryId string

SQL query id

WorkspaceFileId string
WorkspaceFilePath string
accessControls List<PermissionsAccessControlArgs>
authorization String

either tokens or passwords.

clusterId String

cluster id

clusterPolicyId String

cluster policy id

directoryId String

directory id

directoryPath String

path of directory

experimentId String

MLflow experiment id

instancePoolId String

instance pool id

jobId String

job id

notebookId String

ID of notebook within workspace

notebookPath String

path of notebook

objectType String

type of permissions.

pipelineId String

pipeline id

registeredModelId String

MLflow registered model id

repoId String

repo id

repoPath String

path of databricks repo directory(/Repos/<username>/...)

sqlAlertId String

SQL alert id

sqlDashboardId String

SQL dashboard id

sqlEndpointId String

SQL warehouse id

sqlQueryId String

SQL query id

workspaceFileId String
workspaceFilePath String
accessControls PermissionsAccessControlArgs[]
authorization string

either tokens or passwords.

clusterId string

cluster id

clusterPolicyId string

cluster policy id

directoryId string

directory id

directoryPath string

path of directory

experimentId string

MLflow experiment id

instancePoolId string

instance pool id

jobId string

job id

notebookId string

ID of notebook within workspace

notebookPath string

path of notebook

objectType string

type of permissions.

pipelineId string

pipeline id

registeredModelId string

MLflow registered model id

repoId string

repo id

repoPath string

path of databricks repo directory(/Repos/<username>/...)

sqlAlertId string

SQL alert id

sqlDashboardId string

SQL dashboard id

sqlEndpointId string

SQL warehouse id

sqlQueryId string

SQL query id

workspaceFileId string
workspaceFilePath string
access_controls Sequence[PermissionsAccessControlArgs]
authorization str

either tokens or passwords.

cluster_id str

cluster id

cluster_policy_id str

cluster policy id

directory_id str

directory id

directory_path str

path of directory

experiment_id str

MLflow experiment id

instance_pool_id str

instance pool id

job_id str

job id

notebook_id str

ID of notebook within workspace

notebook_path str

path of notebook

object_type str

type of permissions.

pipeline_id str

pipeline id

registered_model_id str

MLflow registered model id

repo_id str

repo id

repo_path str

path of databricks repo directory(/Repos/<username>/...)

sql_alert_id str

SQL alert id

sql_dashboard_id str

SQL dashboard id

sql_endpoint_id str

SQL warehouse id

sql_query_id str

SQL query id

workspace_file_id str
workspace_file_path str
accessControls List<Property Map>
authorization String

either tokens or passwords.

clusterId String

cluster id

clusterPolicyId String

cluster policy id

directoryId String

directory id

directoryPath String

path of directory

experimentId String

MLflow experiment id

instancePoolId String

instance pool id

jobId String

job id

notebookId String

ID of notebook within workspace

notebookPath String

path of notebook

objectType String

type of permissions.

pipelineId String

pipeline id

registeredModelId String

MLflow registered model id

repoId String

repo id

repoPath String

path of databricks repo directory(/Repos/<username>/...)

sqlAlertId String

SQL alert id

sqlDashboardId String

SQL dashboard id

sqlEndpointId String

SQL warehouse id

sqlQueryId String

SQL query id

workspaceFileId String
workspaceFilePath String

Supporting Types

PermissionsAccessControl

PermissionLevel string

permission level according to specific resource. See examples above for the reference.

Exactly one of the below arguments is required:

GroupName string

name of the group. We recommend setting permissions on groups.

ServicePrincipalName string

Application ID of the service_principal.

UserName string

name of the user.

PermissionLevel string

permission level according to specific resource. See examples above for the reference.

Exactly one of the below arguments is required:

GroupName string

name of the group. We recommend setting permissions on groups.

ServicePrincipalName string

Application ID of the service_principal.

UserName string

name of the user.

permissionLevel String

permission level according to specific resource. See examples above for the reference.

Exactly one of the below arguments is required:

groupName String

name of the group. We recommend setting permissions on groups.

servicePrincipalName String

Application ID of the service_principal.

userName String

name of the user.

permissionLevel string

permission level according to specific resource. See examples above for the reference.

Exactly one of the below arguments is required:

groupName string

name of the group. We recommend setting permissions on groups.

servicePrincipalName string

Application ID of the service_principal.

userName string

name of the user.

permission_level str

permission level according to specific resource. See examples above for the reference.

Exactly one of the below arguments is required:

group_name str

name of the group. We recommend setting permissions on groups.

service_principal_name str

Application ID of the service_principal.

user_name str

name of the user.

permissionLevel String

permission level according to specific resource. See examples above for the reference.

Exactly one of the below arguments is required:

groupName String

name of the group. We recommend setting permissions on groups.

servicePrincipalName String

Application ID of the service_principal.

userName String

name of the user.

Package Details

Repository
databricks pulumi/pulumi-databricks
License
Apache-2.0
Notes

This Pulumi package is based on the databricks Terraform Provider.