Databricks v1.14.0, May 23 23

databricks.SqlPermissions

Explore with Pulumi AI

The following resources are often used in the same context:

End to end workspace management guide.
databricks.Group to manage groups in Databricks Workspace or Account Console (for AWS deployments).
databricks.Grants to manage data access in Unity Catalog.
databricks.Permissions to manage access control in Databricks workspace.
databricks.User to manage users, that could be added to databricks.Group within the workspace.

Example Usage

The following resource definition will enforce access control on a table by executing the following SQL queries on a special auto-terminating cluster it would create for this operation

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Databricks = Pulumi.Databricks;

return await Deployment.RunAsync(() => 
{
    var fooTable = new Databricks.SqlPermissions("fooTable", new()
    {
        PrivilegeAssignments = new[]
        {
            new Databricks.Inputs.SqlPermissionsPrivilegeAssignmentArgs
            {
                Principal = "serge@example.com",
                Privileges = new[]
                {
                    "SELECT",
                    "MODIFY",
                },
            },
            new Databricks.Inputs.SqlPermissionsPrivilegeAssignmentArgs
            {
                Principal = "special group",
                Privileges = new[]
                {
                    "SELECT",
                },
            },
        },
        Table = "foo",
    });

});

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 {
		_, err := databricks.NewSqlPermissions(ctx, "fooTable", &databricks.SqlPermissionsArgs{
			PrivilegeAssignments: databricks.SqlPermissionsPrivilegeAssignmentArray{
				&databricks.SqlPermissionsPrivilegeAssignmentArgs{
					Principal: pulumi.String("serge@example.com"),
					Privileges: pulumi.StringArray{
						pulumi.String("SELECT"),
						pulumi.String("MODIFY"),
					},
				},
				&databricks.SqlPermissionsPrivilegeAssignmentArgs{
					Principal: pulumi.String("special group"),
					Privileges: pulumi.StringArray{
						pulumi.String("SELECT"),
					},
				},
			},
			Table: pulumi.String("foo"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.databricks.SqlPermissions;
import com.pulumi.databricks.SqlPermissionsArgs;
import com.pulumi.databricks.inputs.SqlPermissionsPrivilegeAssignmentArgs;
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 fooTable = new SqlPermissions("fooTable", SqlPermissionsArgs.builder()        
            .privilegeAssignments(            
                SqlPermissionsPrivilegeAssignmentArgs.builder()
                    .principal("serge@example.com")
                    .privileges(                    
                        "SELECT",
                        "MODIFY")
                    .build(),
                SqlPermissionsPrivilegeAssignmentArgs.builder()
                    .principal("special group")
                    .privileges("SELECT")
                    .build())
            .table("foo")
            .build());

    }
}

import pulumi
import pulumi_databricks as databricks

foo_table = databricks.SqlPermissions("fooTable",
    privilege_assignments=[
        databricks.SqlPermissionsPrivilegeAssignmentArgs(
            principal="serge@example.com",
            privileges=[
                "SELECT",
                "MODIFY",
            ],
        ),
        databricks.SqlPermissionsPrivilegeAssignmentArgs(
            principal="special group",
            privileges=["SELECT"],
        ),
    ],
    table="foo")

import * as pulumi from "@pulumi/pulumi";
import * as databricks from "@pulumi/databricks";

const fooTable = new databricks.SqlPermissions("fooTable", {
    privilegeAssignments: [
        {
            principal: "serge@example.com",
            privileges: [
                "SELECT",
                "MODIFY",
            ],
        },
        {
            principal: "special group",
            privileges: ["SELECT"],
        },
    ],
    table: "foo",
});

resources:
  fooTable:
    type: databricks:SqlPermissions
    properties:
      privilegeAssignments:
        - principal: serge@example.com
          privileges:
            - SELECT
            - MODIFY
        - principal: special group
          privileges:
            - SELECT
      table: foo

Create SqlPermissions Resource

new SqlPermissions(name: string, args?: SqlPermissionsArgs, opts?: CustomResourceOptions);

@overload
def SqlPermissions(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   anonymous_function: Optional[bool] = None,
                   any_file: Optional[bool] = None,
                   catalog: Optional[bool] = None,
                   cluster_id: Optional[str] = None,
                   database: Optional[str] = None,
                   privilege_assignments: Optional[Sequence[SqlPermissionsPrivilegeAssignmentArgs]] = None,
                   table: Optional[str] = None,
                   view: Optional[str] = None)
@overload
def SqlPermissions(resource_name: str,
                   args: Optional[SqlPermissionsArgs] = None,
                   opts: Optional[ResourceOptions] = None)

func NewSqlPermissions(ctx *Context, name string, args *SqlPermissionsArgs, opts ...ResourceOption) (*SqlPermissions, error)

public SqlPermissions(string name, SqlPermissionsArgs? args = null, CustomResourceOptions? opts = null)

public SqlPermissions(String name, SqlPermissionsArgs args)
public SqlPermissions(String name, SqlPermissionsArgs args, CustomResourceOptions options)

type: databricks:SqlPermissions
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args SqlPermissionsArgs: 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 SqlPermissionsArgs: 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 SqlPermissionsArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args SqlPermissionsArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args SqlPermissionsArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

SqlPermissions 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 SqlPermissions resource accepts the following input properties:

AnonymousFunction bool: If this access control for using anonymous function. Defaults to false.
AnyFile bool: If this access control for reading any file. Defaults to false.
Catalog bool: If this access control for the entire catalog. Defaults to false.
ClusterId string
Database string: Name of the database. Has default value of default.
PrivilegeAssignments List<SqlPermissionsPrivilegeAssignmentArgs>
Table string: Name of the table. Can be combined with database.
View string: Name of the view. Can be combined with database.

AnonymousFunction bool: If this access control for using anonymous function. Defaults to false.
AnyFile bool: If this access control for reading any file. Defaults to false.
Catalog bool: If this access control for the entire catalog. Defaults to false.
ClusterId string
Database string: Name of the database. Has default value of default.
PrivilegeAssignments []SqlPermissionsPrivilegeAssignmentArgs
Table string: Name of the table. Can be combined with database.
View string: Name of the view. Can be combined with database.

anonymousFunction Boolean: If this access control for using anonymous function. Defaults to false.
anyFile Boolean: If this access control for reading any file. Defaults to false.
catalog Boolean: If this access control for the entire catalog. Defaults to false.
clusterId String
database String: Name of the database. Has default value of default.
privilegeAssignments List<SqlPermissionsPrivilegeAssignmentArgs>
table String: Name of the table. Can be combined with database.
view String: Name of the view. Can be combined with database.

anonymousFunction boolean: If this access control for using anonymous function. Defaults to false.
anyFile boolean: If this access control for reading any file. Defaults to false.
catalog boolean: If this access control for the entire catalog. Defaults to false.
clusterId string
database string: Name of the database. Has default value of default.
privilegeAssignments SqlPermissionsPrivilegeAssignmentArgs[]
table string: Name of the table. Can be combined with database.
view string: Name of the view. Can be combined with database.

anonymous_function bool: If this access control for using anonymous function. Defaults to false.
any_file bool: If this access control for reading any file. Defaults to false.
catalog bool: If this access control for the entire catalog. Defaults to false.
cluster_id str
database str: Name of the database. Has default value of default.
privilege_assignments Sequence[SqlPermissionsPrivilegeAssignmentArgs]
table str: Name of the table. Can be combined with database.
view str: Name of the view. Can be combined with database.

anonymousFunction Boolean: If this access control for using anonymous function. Defaults to false.
anyFile Boolean: If this access control for reading any file. Defaults to false.
catalog Boolean: If this access control for the entire catalog. Defaults to false.
clusterId String
database String: Name of the database. Has default value of default.
privilegeAssignments List<Property Map>
table String: Name of the table. Can be combined with database.
view String: Name of the view. Can be combined with database.

Outputs

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

Get an existing SqlPermissions 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?: SqlPermissionsState, opts?: CustomResourceOptions): SqlPermissions

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        anonymous_function: Optional[bool] = None,
        any_file: Optional[bool] = None,
        catalog: Optional[bool] = None,
        cluster_id: Optional[str] = None,
        database: Optional[str] = None,
        privilege_assignments: Optional[Sequence[SqlPermissionsPrivilegeAssignmentArgs]] = None,
        table: Optional[str] = None,
        view: Optional[str] = None) -> SqlPermissions

func GetSqlPermissions(ctx *Context, name string, id IDInput, state *SqlPermissionsState, opts ...ResourceOption) (*SqlPermissions, error)

public static SqlPermissions Get(string name, Input<string> id, SqlPermissionsState? state, CustomResourceOptions? opts = null)

public static SqlPermissions get(String name, Output<String> id, SqlPermissionsState 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:

AnonymousFunction bool: If this access control for using anonymous function. Defaults to false.
AnyFile bool: If this access control for reading any file. Defaults to false.
Catalog bool: If this access control for the entire catalog. Defaults to false.
ClusterId string
Database string: Name of the database. Has default value of default.
PrivilegeAssignments List<SqlPermissionsPrivilegeAssignmentArgs>
Table string: Name of the table. Can be combined with database.
View string: Name of the view. Can be combined with database.

AnonymousFunction bool: If this access control for using anonymous function. Defaults to false.
AnyFile bool: If this access control for reading any file. Defaults to false.
Catalog bool: If this access control for the entire catalog. Defaults to false.
ClusterId string
Database string: Name of the database. Has default value of default.
PrivilegeAssignments []SqlPermissionsPrivilegeAssignmentArgs
Table string: Name of the table. Can be combined with database.
View string: Name of the view. Can be combined with database.

anonymousFunction Boolean: If this access control for using anonymous function. Defaults to false.
anyFile Boolean: If this access control for reading any file. Defaults to false.
catalog Boolean: If this access control for the entire catalog. Defaults to false.
clusterId String
database String: Name of the database. Has default value of default.
privilegeAssignments List<SqlPermissionsPrivilegeAssignmentArgs>
table String: Name of the table. Can be combined with database.
view String: Name of the view. Can be combined with database.

anonymousFunction boolean: If this access control for using anonymous function. Defaults to false.
anyFile boolean: If this access control for reading any file. Defaults to false.
catalog boolean: If this access control for the entire catalog. Defaults to false.
clusterId string
database string: Name of the database. Has default value of default.
privilegeAssignments SqlPermissionsPrivilegeAssignmentArgs[]
table string: Name of the table. Can be combined with database.
view string: Name of the view. Can be combined with database.

anonymous_function bool: If this access control for using anonymous function. Defaults to false.
any_file bool: If this access control for reading any file. Defaults to false.
catalog bool: If this access control for the entire catalog. Defaults to false.
cluster_id str
database str: Name of the database. Has default value of default.
privilege_assignments Sequence[SqlPermissionsPrivilegeAssignmentArgs]
table str: Name of the table. Can be combined with database.
view str: Name of the view. Can be combined with database.

anonymousFunction Boolean: If this access control for using anonymous function. Defaults to false.
anyFile Boolean: If this access control for reading any file. Defaults to false.
catalog Boolean: If this access control for the entire catalog. Defaults to false.
clusterId String
database String: Name of the database. Has default value of default.
privilegeAssignments List<Property Map>
table String: Name of the table. Can be combined with database.
view String: Name of the view. Can be combined with database.