Databricks v1.36.0, Apr 19 24

Databricks v1.36.0 published on Friday, Apr 19, 2024 by Pulumi

databricks.Permissions

Explore with Pulumi AI

Databricks v1.36.0 published on Friday, Apr 19, 2024 by Pulumi

pulumi/pulumi-databricks

Import

Import Example

Configuration file:

hcl

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 command:

bash

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

Create Permissions Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Permissions(name: string, args: PermissionsArgs, opts?: CustomResourceOptions);

@overload
def Permissions(resource_name: str,
                args: PermissionsArgs,
                opts: Optional[ResourceOptions] = None)

@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,
                serving_endpoint_id: 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)

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.

Parameters

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.

Example

The following reference example uses placeholder values for all input properties.

var permissionsResource = new Databricks.Permissions("permissionsResource", new()
{
    AccessControls = new[]
    {
        new Databricks.Inputs.PermissionsAccessControlArgs
        {
            PermissionLevel = "string",
            GroupName = "string",
            ServicePrincipalName = "string",
            UserName = "string",
        },
    },
    Authorization = "string",
    ClusterId = "string",
    ClusterPolicyId = "string",
    DirectoryId = "string",
    DirectoryPath = "string",
    ExperimentId = "string",
    InstancePoolId = "string",
    JobId = "string",
    NotebookId = "string",
    NotebookPath = "string",
    ObjectType = "string",
    PipelineId = "string",
    RegisteredModelId = "string",
    RepoId = "string",
    RepoPath = "string",
    ServingEndpointId = "string",
    SqlAlertId = "string",
    SqlDashboardId = "string",
    SqlEndpointId = "string",
    SqlQueryId = "string",
    WorkspaceFileId = "string",
    WorkspaceFilePath = "string",
});

example, err := databricks.NewPermissions(ctx, "permissionsResource", &databricks.PermissionsArgs{
	AccessControls: databricks.PermissionsAccessControlArray{
		&databricks.PermissionsAccessControlArgs{
			PermissionLevel:      pulumi.String("string"),
			GroupName:            pulumi.String("string"),
			ServicePrincipalName: pulumi.String("string"),
			UserName:             pulumi.String("string"),
		},
	},
	Authorization:     pulumi.String("string"),
	ClusterId:         pulumi.String("string"),
	ClusterPolicyId:   pulumi.String("string"),
	DirectoryId:       pulumi.String("string"),
	DirectoryPath:     pulumi.String("string"),
	ExperimentId:      pulumi.String("string"),
	InstancePoolId:    pulumi.String("string"),
	JobId:             pulumi.String("string"),
	NotebookId:        pulumi.String("string"),
	NotebookPath:      pulumi.String("string"),
	ObjectType:        pulumi.String("string"),
	PipelineId:        pulumi.String("string"),
	RegisteredModelId: pulumi.String("string"),
	RepoId:            pulumi.String("string"),
	RepoPath:          pulumi.String("string"),
	ServingEndpointId: pulumi.String("string"),
	SqlAlertId:        pulumi.String("string"),
	SqlDashboardId:    pulumi.String("string"),
	SqlEndpointId:     pulumi.String("string"),
	SqlQueryId:        pulumi.String("string"),
	WorkspaceFileId:   pulumi.String("string"),
	WorkspaceFilePath: pulumi.String("string"),
})

var permissionsResource = new Permissions("permissionsResource", PermissionsArgs.builder()        
    .accessControls(PermissionsAccessControlArgs.builder()
        .permissionLevel("string")
        .groupName("string")
        .servicePrincipalName("string")
        .userName("string")
        .build())
    .authorization("string")
    .clusterId("string")
    .clusterPolicyId("string")
    .directoryId("string")
    .directoryPath("string")
    .experimentId("string")
    .instancePoolId("string")
    .jobId("string")
    .notebookId("string")
    .notebookPath("string")
    .objectType("string")
    .pipelineId("string")
    .registeredModelId("string")
    .repoId("string")
    .repoPath("string")
    .servingEndpointId("string")
    .sqlAlertId("string")
    .sqlDashboardId("string")
    .sqlEndpointId("string")
    .sqlQueryId("string")
    .workspaceFileId("string")
    .workspaceFilePath("string")
    .build());

permissions_resource = databricks.Permissions("permissionsResource",
    access_controls=[databricks.PermissionsAccessControlArgs(
        permission_level="string",
        group_name="string",
        service_principal_name="string",
        user_name="string",
    )],
    authorization="string",
    cluster_id="string",
    cluster_policy_id="string",
    directory_id="string",
    directory_path="string",
    experiment_id="string",
    instance_pool_id="string",
    job_id="string",
    notebook_id="string",
    notebook_path="string",
    object_type="string",
    pipeline_id="string",
    registered_model_id="string",
    repo_id="string",
    repo_path="string",
    serving_endpoint_id="string",
    sql_alert_id="string",
    sql_dashboard_id="string",
    sql_endpoint_id="string",
    sql_query_id="string",
    workspace_file_id="string",
    workspace_file_path="string")

const permissionsResource = new databricks.Permissions("permissionsResource", {
    accessControls: [{
        permissionLevel: "string",
        groupName: "string",
        servicePrincipalName: "string",
        userName: "string",
    }],
    authorization: "string",
    clusterId: "string",
    clusterPolicyId: "string",
    directoryId: "string",
    directoryPath: "string",
    experimentId: "string",
    instancePoolId: "string",
    jobId: "string",
    notebookId: "string",
    notebookPath: "string",
    objectType: "string",
    pipelineId: "string",
    registeredModelId: "string",
    repoId: "string",
    repoPath: "string",
    servingEndpointId: "string",
    sqlAlertId: "string",
    sqlDashboardId: "string",
    sqlEndpointId: "string",
    sqlQueryId: "string",
    workspaceFileId: "string",
    workspaceFilePath: "string",
});

type: databricks:Permissions
properties:
    accessControls:
        - groupName: string
          permissionLevel: string
          servicePrincipalName: string
          userName: string
    authorization: string
    clusterId: string
    clusterPolicyId: string
    directoryId: string
    directoryPath: string
    experimentId: string
    instancePoolId: string
    jobId: string
    notebookId: string
    notebookPath: string
    objectType: string
    pipelineId: string
    registeredModelId: string
    repoId: string
    repoPath: string
    servingEndpointId: string
    sqlAlertId: string
    sqlDashboardId: string
    sqlEndpointId: string
    sqlQueryId: string
    workspaceFileId: string
    workspaceFilePath: string

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<PermissionsAccessControl>
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>/...)
ServingEndpointId string: Model Serving endpoint id.
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>/...)
ServingEndpointId string: Model Serving endpoint id.
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<PermissionsAccessControl>
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>/...)
servingEndpointId String: Model Serving endpoint id.
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 PermissionsAccessControl[]
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>/...)
servingEndpointId string: Model Serving endpoint id.
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>/...)
serving_endpoint_id str: Model Serving endpoint id.
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>/...)
servingEndpointId String: Model Serving endpoint id.
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,
        serving_endpoint_id: 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<PermissionsAccessControl>
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>/...)
ServingEndpointId string: Model Serving endpoint id.
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>/...)
ServingEndpointId string: Model Serving endpoint id.
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<PermissionsAccessControl>
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>/...)
servingEndpointId String: Model Serving endpoint id.
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 PermissionsAccessControl[]
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>/...)
servingEndpointId string: Model Serving endpoint id.
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>/...)
serving_endpoint_id str: Model Serving endpoint id.
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>/...)
servingEndpointId String: Model Serving endpoint id.
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, PermissionsAccessControlArgs

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.

Databricks v1.36.0 published on Friday, Apr 19, 2024 by Pulumi

pulumi/pulumi-databricks

databricks.Permissions

On this page

On this page

Import

Import Example

Create Permissions Resource

Constructor syntax

Parameters

Example

Permissions Resource Properties

Inputs

Outputs

Look up Existing Permissions Resource

Supporting Types

PermissionsAccessControl, PermissionsAccessControlArgs

Package Details

On this page

On this page