1. Packages
  2. Packages
  3. Databricks Provider
  4. API Docs
  5. SecretAcl
Viewing docs for Databricks v0.4.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
databricks logo
Viewing docs for Databricks v0.4.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

    Create or overwrite the ACL associated with the given principal (user or group) on the specified databricks_secret_scope. Please consult Secrets User Guide for more details.

    The following resources are often used in the same context:

    Example Usage

    This way, data scientists can read the Publishing API key that is synchronized from example, Azure Key Vault.

    using Pulumi;
    using Databricks = Pulumi.Databricks;
    
    class MyStack : Stack
    {
        public MyStack()
        {
            var ds = new Databricks.Group("ds", new Databricks.GroupArgs
            {
                DisplayName = "data-scientists",
            });
            var app = new Databricks.SecretScope("app", new Databricks.SecretScopeArgs
            {
            });
            var mySecretAcl = new Databricks.SecretAcl("mySecretAcl", new Databricks.SecretAclArgs
            {
                Principal = ds.DisplayName,
                Permission = "READ",
                Scope = app.Name,
            });
            var publishingApi = new Databricks.Secret("publishingApi", new Databricks.SecretArgs
            {
                Key = "publishing_api",
                StringValue = data.Azurerm_key_vault_secret.Example.Value,
                Scope = app.Name,
            });
        }
    
    }
    
    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 {
    		ds, err := databricks.NewGroup(ctx, "ds", &databricks.GroupArgs{
    			DisplayName: pulumi.String("data-scientists"),
    		})
    		if err != nil {
    			return err
    		}
    		app, err := databricks.NewSecretScope(ctx, "app", nil)
    		if err != nil {
    			return err
    		}
    		_, err = databricks.NewSecretAcl(ctx, "mySecretAcl", &databricks.SecretAclArgs{
    			Principal:  ds.DisplayName,
    			Permission: pulumi.String("READ"),
    			Scope:      app.Name,
    		})
    		if err != nil {
    			return err
    		}
    		_, err = databricks.NewSecret(ctx, "publishingApi", &databricks.SecretArgs{
    			Key:         pulumi.String("publishing_api"),
    			StringValue: pulumi.Any(data.Azurerm_key_vault_secret.Example.Value),
    			Scope:       app.Name,
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    

    Example coming soon!

    import * as pulumi from "@pulumi/pulumi";
    import * as databricks from "@pulumi/databricks";
    
    const ds = new databricks.Group("ds", {displayName: "data-scientists"});
    const app = new databricks.SecretScope("app", {});
    const mySecretAcl = new databricks.SecretAcl("mySecretAcl", {
        principal: ds.displayName,
        permission: "READ",
        scope: app.name,
    });
    const publishingApi = new databricks.Secret("publishingApi", {
        key: "publishing_api",
        stringValue: data.azurerm_key_vault_secret.example.value,
        scope: app.name,
    });
    
    import pulumi
    import pulumi_databricks as databricks
    
    ds = databricks.Group("ds", display_name="data-scientists")
    app = databricks.SecretScope("app")
    my_secret_acl = databricks.SecretAcl("mySecretAcl",
        principal=ds.display_name,
        permission="READ",
        scope=app.name)
    publishing_api = databricks.Secret("publishingApi",
        key="publishing_api",
        string_value=data["azurerm_key_vault_secret"]["example"]["value"],
        scope=app.name)
    

    Example coming soon!

    Create SecretAcl Resource

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

    Constructor syntax

    new SecretAcl(name: string, args: SecretAclArgs, opts?: CustomResourceOptions);
    @overload
    def SecretAcl(resource_name: str,
                  args: SecretAclArgs,
                  opts: Optional[ResourceOptions] = None)
    
    @overload
    def SecretAcl(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  permission: Optional[str] = None,
                  principal: Optional[str] = None,
                  scope: Optional[str] = None)
    func NewSecretAcl(ctx *Context, name string, args SecretAclArgs, opts ...ResourceOption) (*SecretAcl, error)
    public SecretAcl(string name, SecretAclArgs args, CustomResourceOptions? opts = null)
    public SecretAcl(String name, SecretAclArgs args)
    public SecretAcl(String name, SecretAclArgs args, CustomResourceOptions options)
    
    type: databricks:SecretAcl
    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 SecretAclArgs
    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 SecretAclArgs
    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 SecretAclArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SecretAclArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SecretAclArgs
    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 secretAclResource = new Databricks.SecretAcl("secretAclResource", new()
    {
        Permission = "string",
        Principal = "string",
        Scope = "string",
    });
    
    example, err := databricks.NewSecretAcl(ctx, "secretAclResource", &databricks.SecretAclArgs{
    	Permission: pulumi.String("string"),
    	Principal:  pulumi.String("string"),
    	Scope:      pulumi.String("string"),
    })
    
    var secretAclResource = new SecretAcl("secretAclResource", SecretAclArgs.builder()
        .permission("string")
        .principal("string")
        .scope("string")
        .build());
    
    secret_acl_resource = databricks.SecretAcl("secretAclResource",
        permission="string",
        principal="string",
        scope="string")
    
    const secretAclResource = new databricks.SecretAcl("secretAclResource", {
        permission: "string",
        principal: "string",
        scope: "string",
    });
    
    type: databricks:SecretAcl
    properties:
        permission: string
        principal: string
        scope: string
    

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

    Permission string
    READ, WRITE or MANAGE.
    Principal string
    name of the principals. It can be users for all users or name or display_name of databricks_group
    Scope string
    name of the scope
    Permission string
    READ, WRITE or MANAGE.
    Principal string
    name of the principals. It can be users for all users or name or display_name of databricks_group
    Scope string
    name of the scope
    permission String
    READ, WRITE or MANAGE.
    principal String
    name of the principals. It can be users for all users or name or display_name of databricks_group
    scope String
    name of the scope
    permission string
    READ, WRITE or MANAGE.
    principal string
    name of the principals. It can be users for all users or name or display_name of databricks_group
    scope string
    name of the scope
    permission str
    READ, WRITE or MANAGE.
    principal str
    name of the principals. It can be users for all users or name or display_name of databricks_group
    scope str
    name of the scope
    permission String
    READ, WRITE or MANAGE.
    principal String
    name of the principals. It can be users for all users or name or display_name of databricks_group
    scope String
    name of the scope

    Outputs

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

    Get an existing SecretAcl 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?: SecretAclState, opts?: CustomResourceOptions): SecretAcl
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            permission: Optional[str] = None,
            principal: Optional[str] = None,
            scope: Optional[str] = None) -> SecretAcl
    func GetSecretAcl(ctx *Context, name string, id IDInput, state *SecretAclState, opts ...ResourceOption) (*SecretAcl, error)
    public static SecretAcl Get(string name, Input<string> id, SecretAclState? state, CustomResourceOptions? opts = null)
    public static SecretAcl get(String name, Output<String> id, SecretAclState state, CustomResourceOptions options)
    resources:  _:    type: databricks:SecretAcl    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.
    The following state arguments are supported:
    Permission string
    READ, WRITE or MANAGE.
    Principal string
    name of the principals. It can be users for all users or name or display_name of databricks_group
    Scope string
    name of the scope
    Permission string
    READ, WRITE or MANAGE.
    Principal string
    name of the principals. It can be users for all users or name or display_name of databricks_group
    Scope string
    name of the scope
    permission String
    READ, WRITE or MANAGE.
    principal String
    name of the principals. It can be users for all users or name or display_name of databricks_group
    scope String
    name of the scope
    permission string
    READ, WRITE or MANAGE.
    principal string
    name of the principals. It can be users for all users or name or display_name of databricks_group
    scope string
    name of the scope
    permission str
    READ, WRITE or MANAGE.
    principal str
    name of the principals. It can be users for all users or name or display_name of databricks_group
    scope str
    name of the scope
    permission String
    READ, WRITE or MANAGE.
    principal String
    name of the principals. It can be users for all users or name or display_name of databricks_group
    scope String
    name of the scope

    Import

    The resource secret acl can be imported using scopeName|||principalName combination. bash

     $ pulumi import databricks:index/secretAcl:SecretAcl object `scopeName|||principalName`
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    databricks pulumi/pulumi-databricks
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the databricks Terraform Provider.
    databricks logo
    Viewing docs for Databricks v0.4.0 (Older version)
    published on Monday, Mar 9, 2026 by Pulumi
      Try Pulumi Cloud free. Your team will thank you.