getSecretUc

Databricks v1.101.0, Jul 30 26

Viewing docs for Databricks v1.101.0
published on Thursday, Jul 30, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-databricks

Viewing docs for Databricks v1.101.0
published on Thursday, Jul 30, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-databricks

Example Usage

Basic Example

This example reads a secret in Unity Catalog by its fully qualified name:

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

const example = databricks.getSecretUc({
    fullName: "my_catalog.my_schema.my_secret",
});

import pulumi
import pulumi_databricks as databricks

example = databricks.get_secret_uc(full_name="my_catalog.my_schema.my_secret")

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.GetSecretUc(ctx, &databricks.LookupSecretUcArgs{
			FullName: "my_catalog.my_schema.my_secret",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = Databricks.GetSecretUc.Invoke(new()
    {
        FullName = "my_catalog.my_schema.my_secret",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.databricks.DatabricksFunctions;
import com.pulumi.databricks.inputs.GetSecretUcArgs;
import java.util.ArrayList;
import java.util.Arrays;
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) {
        final var example = DatabricksFunctions.getSecretUc(GetSecretUcArgs.builder()
            .fullName("my_catalog.my_schema.my_secret")
            .build());

    }
}

variables:
  example:
    fn::invoke:
      function: databricks:getSecretUc
      arguments:
        fullName: my_catalog.my_schema.my_secret

pulumi {
  required_providers {
    databricks = {
      source = "pulumi/databricks"
    }
  }
}

data "databricks_getsecretuc" "example" {
  full_name = "my_catalog.my_schema.my_secret"
}

Using getSecretUc

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getSecretUc(args: GetSecretUcArgs, opts?: InvokeOptions): Promise<GetSecretUcResult>
function getSecretUcOutput(args: GetSecretUcOutputArgs, opts?: InvokeOptions): Output<GetSecretUcResult>

def get_secret_uc(full_name: Optional[str] = None,
                  provider_config: Optional[GetSecretUcProviderConfig] = None,
                  opts: Optional[InvokeOptions] = None) -> GetSecretUcResult
def get_secret_uc_output(full_name: pulumi.Input[Optional[str]] = None,
                  provider_config: pulumi.Input[Optional[GetSecretUcProviderConfigArgs]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetSecretUcResult]

func LookupSecretUc(ctx *Context, args *LookupSecretUcArgs, opts ...InvokeOption) (*LookupSecretUcResult, error)
func LookupSecretUcOutput(ctx *Context, args *LookupSecretUcOutputArgs, opts ...InvokeOption) LookupSecretUcResultOutput

> Note: This function is named LookupSecretUc in the Go SDK.

public static class GetSecretUc 
{
    public static Task<GetSecretUcResult> InvokeAsync(GetSecretUcArgs args, InvokeOptions? opts = null)
    public static Output<GetSecretUcResult> Invoke(GetSecretUcInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetSecretUcResult> getSecretUc(GetSecretUcArgs args, InvokeOptions options)
public static Output<GetSecretUcResult> getSecretUc(GetSecretUcArgs args, InvokeOptions options)

fn::invoke:
  function: databricks:index/getSecretUc:getSecretUc
  arguments:
    # arguments dictionary

data "databricks_get_secret_uc" "name" {
    # arguments
}

The following arguments are supported:

FullName string: The three-level (fully qualified) name of the secret, in the form of catalog_name.schema_name.secret_name
ProviderConfig GetSecretUcProviderConfig: Configure the provider for management through account provider.

FullName string: The three-level (fully qualified) name of the secret, in the form of catalog_name.schema_name.secret_name
ProviderConfig GetSecretUcProviderConfig: Configure the provider for management through account provider.

full_name string: The three-level (fully qualified) name of the secret, in the form of catalog_name.schema_name.secret_name
provider_config object: Configure the provider for management through account provider.

fullName String: The three-level (fully qualified) name of the secret, in the form of catalog_name.schema_name.secret_name
providerConfig GetSecretUcProviderConfig: Configure the provider for management through account provider.

fullName string: The three-level (fully qualified) name of the secret, in the form of catalog_name.schema_name.secret_name
providerConfig GetSecretUcProviderConfig: Configure the provider for management through account provider.

full_name str: The three-level (fully qualified) name of the secret, in the form of catalog_name.schema_name.secret_name
provider_config GetSecretUcProviderConfig: Configure the provider for management through account provider.

fullName String: The three-level (fully qualified) name of the secret, in the form of catalog_name.schema_name.secret_name
providerConfig Property Map: Configure the provider for management through account provider.

getSecretUc Result

The following output properties are available:

CatalogName string: (string) - The name of the catalog where the schema and the secret reside
Comment string: (string) - User-provided free-form text description of the secret
CreateTime string: (string) - The time at which this secret was created
CreatedBy string: (string) - The principal that created the secret
EffectiveOwner string: (string) - The effective owner of the secret, which may differ from the directly-set owner due to inheritance
EffectiveValue string: (string) - The secret value. Only populated in responses when you have the READ_SECRET privilege and include_value is set to true in the request. The maximum size is 60 KiB
ExpireTime string: (string) - User-provided expiration time of the secret. This field indicates when the secret should no longer be used and may be displayed as a warning in the UI. It is purely informational and does not trigger any automatic actions or affect the secret's lifecycle
FullName string: (string) - The three-level (fully qualified) name of the secret, in the form of catalog_name.schema_name.secret_name
MetastoreId string: (string) - Unique identifier of the metastore hosting the secret
Name string: (string) - The name of the secret, relative to its parent schema
Owner string: (string) - The owner of the secret. Defaults to the creating principal on creation. Can be updated to transfer ownership of the secret to another principal
SchemaName string: (string) - The name of the schema where the secret resides
UpdateTime string: (string) - The time at which this secret was last updated
UpdatedBy string: (string) - The principal that last updated the secret
Value string: (string) - The secret value to store. This field is input-only and is not returned in responses — use the effective_value field (via GetSecret with include_value set to true) to read the secret value. The maximum size is 60 KiB (pre-encryption). Accepted content includes passwords, tokens, keys, and other sensitive credential data
ProviderConfig GetSecretUcProviderConfig

CatalogName string: (string) - The name of the catalog where the schema and the secret reside
Comment string: (string) - User-provided free-form text description of the secret
CreateTime string: (string) - The time at which this secret was created
CreatedBy string: (string) - The principal that created the secret
EffectiveOwner string: (string) - The effective owner of the secret, which may differ from the directly-set owner due to inheritance
EffectiveValue string: (string) - The secret value. Only populated in responses when you have the READ_SECRET privilege and include_value is set to true in the request. The maximum size is 60 KiB
ExpireTime string: (string) - User-provided expiration time of the secret. This field indicates when the secret should no longer be used and may be displayed as a warning in the UI. It is purely informational and does not trigger any automatic actions or affect the secret's lifecycle
FullName string: (string) - The three-level (fully qualified) name of the secret, in the form of catalog_name.schema_name.secret_name
MetastoreId string: (string) - Unique identifier of the metastore hosting the secret
Name string: (string) - The name of the secret, relative to its parent schema
Owner string: (string) - The owner of the secret. Defaults to the creating principal on creation. Can be updated to transfer ownership of the secret to another principal
SchemaName string: (string) - The name of the schema where the secret resides
UpdateTime string: (string) - The time at which this secret was last updated
UpdatedBy string: (string) - The principal that last updated the secret
Value string: (string) - The secret value to store. This field is input-only and is not returned in responses — use the effective_value field (via GetSecret with include_value set to true) to read the secret value. The maximum size is 60 KiB (pre-encryption). Accepted content includes passwords, tokens, keys, and other sensitive credential data
ProviderConfig GetSecretUcProviderConfig

catalog_name string: (string) - The name of the catalog where the schema and the secret reside
comment string: (string) - User-provided free-form text description of the secret
create_time string: (string) - The time at which this secret was created
created_by string: (string) - The principal that created the secret
effective_owner string: (string) - The effective owner of the secret, which may differ from the directly-set owner due to inheritance
effective_value string: (string) - The secret value. Only populated in responses when you have the READ_SECRET privilege and include_value is set to true in the request. The maximum size is 60 KiB
expire_time string: (string) - User-provided expiration time of the secret. This field indicates when the secret should no longer be used and may be displayed as a warning in the UI. It is purely informational and does not trigger any automatic actions or affect the secret's lifecycle
full_name string: (string) - The three-level (fully qualified) name of the secret, in the form of catalog_name.schema_name.secret_name
metastore_id string: (string) - Unique identifier of the metastore hosting the secret
name string: (string) - The name of the secret, relative to its parent schema
owner string: (string) - The owner of the secret. Defaults to the creating principal on creation. Can be updated to transfer ownership of the secret to another principal
schema_name string: (string) - The name of the schema where the secret resides
update_time string: (string) - The time at which this secret was last updated
updated_by string: (string) - The principal that last updated the secret
value string: (string) - The secret value to store. This field is input-only and is not returned in responses — use the effective_value field (via GetSecret with include_value set to true) to read the secret value. The maximum size is 60 KiB (pre-encryption). Accepted content includes passwords, tokens, keys, and other sensitive credential data
provider_config object

catalogName String: (string) - The name of the catalog where the schema and the secret reside
comment String: (string) - User-provided free-form text description of the secret
createTime String: (string) - The time at which this secret was created
createdBy String: (string) - The principal that created the secret
effectiveOwner String: (string) - The effective owner of the secret, which may differ from the directly-set owner due to inheritance
effectiveValue String: (string) - The secret value. Only populated in responses when you have the READ_SECRET privilege and include_value is set to true in the request. The maximum size is 60 KiB
expireTime String: (string) - User-provided expiration time of the secret. This field indicates when the secret should no longer be used and may be displayed as a warning in the UI. It is purely informational and does not trigger any automatic actions or affect the secret's lifecycle
fullName String: (string) - The three-level (fully qualified) name of the secret, in the form of catalog_name.schema_name.secret_name
metastoreId String: (string) - Unique identifier of the metastore hosting the secret
name String: (string) - The name of the secret, relative to its parent schema
owner String: (string) - The owner of the secret. Defaults to the creating principal on creation. Can be updated to transfer ownership of the secret to another principal
schemaName String: (string) - The name of the schema where the secret resides
updateTime String: (string) - The time at which this secret was last updated
updatedBy String: (string) - The principal that last updated the secret
value String: (string) - The secret value to store. This field is input-only and is not returned in responses — use the effective_value field (via GetSecret with include_value set to true) to read the secret value. The maximum size is 60 KiB (pre-encryption). Accepted content includes passwords, tokens, keys, and other sensitive credential data
providerConfig GetSecretUcProviderConfig

catalogName string: (string) - The name of the catalog where the schema and the secret reside
comment string: (string) - User-provided free-form text description of the secret
createTime string: (string) - The time at which this secret was created
createdBy string: (string) - The principal that created the secret
effectiveOwner string: (string) - The effective owner of the secret, which may differ from the directly-set owner due to inheritance
effectiveValue string: (string) - The secret value. Only populated in responses when you have the READ_SECRET privilege and include_value is set to true in the request. The maximum size is 60 KiB
expireTime string: (string) - User-provided expiration time of the secret. This field indicates when the secret should no longer be used and may be displayed as a warning in the UI. It is purely informational and does not trigger any automatic actions or affect the secret's lifecycle
fullName string: (string) - The three-level (fully qualified) name of the secret, in the form of catalog_name.schema_name.secret_name
metastoreId string: (string) - Unique identifier of the metastore hosting the secret
name string: (string) - The name of the secret, relative to its parent schema
owner string: (string) - The owner of the secret. Defaults to the creating principal on creation. Can be updated to transfer ownership of the secret to another principal
schemaName string: (string) - The name of the schema where the secret resides
updateTime string: (string) - The time at which this secret was last updated
updatedBy string: (string) - The principal that last updated the secret
value string: (string) - The secret value to store. This field is input-only and is not returned in responses — use the effective_value field (via GetSecret with include_value set to true) to read the secret value. The maximum size is 60 KiB (pre-encryption). Accepted content includes passwords, tokens, keys, and other sensitive credential data
providerConfig GetSecretUcProviderConfig

catalog_name str: (string) - The name of the catalog where the schema and the secret reside
comment str: (string) - User-provided free-form text description of the secret
create_time str: (string) - The time at which this secret was created
created_by str: (string) - The principal that created the secret
effective_owner str: (string) - The effective owner of the secret, which may differ from the directly-set owner due to inheritance
effective_value str: (string) - The secret value. Only populated in responses when you have the READ_SECRET privilege and include_value is set to true in the request. The maximum size is 60 KiB
expire_time str: (string) - User-provided expiration time of the secret. This field indicates when the secret should no longer be used and may be displayed as a warning in the UI. It is purely informational and does not trigger any automatic actions or affect the secret's lifecycle
full_name str: (string) - The three-level (fully qualified) name of the secret, in the form of catalog_name.schema_name.secret_name
metastore_id str: (string) - Unique identifier of the metastore hosting the secret
name str: (string) - The name of the secret, relative to its parent schema
owner str: (string) - The owner of the secret. Defaults to the creating principal on creation. Can be updated to transfer ownership of the secret to another principal
schema_name str: (string) - The name of the schema where the secret resides
update_time str: (string) - The time at which this secret was last updated
updated_by str: (string) - The principal that last updated the secret
value str: (string) - The secret value to store. This field is input-only and is not returned in responses — use the effective_value field (via GetSecret with include_value set to true) to read the secret value. The maximum size is 60 KiB (pre-encryption). Accepted content includes passwords, tokens, keys, and other sensitive credential data
provider_config GetSecretUcProviderConfig

catalogName String: (string) - The name of the catalog where the schema and the secret reside
comment String: (string) - User-provided free-form text description of the secret
createTime String: (string) - The time at which this secret was created
createdBy String: (string) - The principal that created the secret
effectiveOwner String: (string) - The effective owner of the secret, which may differ from the directly-set owner due to inheritance
effectiveValue String: (string) - The secret value. Only populated in responses when you have the READ_SECRET privilege and include_value is set to true in the request. The maximum size is 60 KiB
expireTime String: (string) - User-provided expiration time of the secret. This field indicates when the secret should no longer be used and may be displayed as a warning in the UI. It is purely informational and does not trigger any automatic actions or affect the secret's lifecycle
fullName String: (string) - The three-level (fully qualified) name of the secret, in the form of catalog_name.schema_name.secret_name
metastoreId String: (string) - Unique identifier of the metastore hosting the secret
name String: (string) - The name of the secret, relative to its parent schema
owner String: (string) - The owner of the secret. Defaults to the creating principal on creation. Can be updated to transfer ownership of the secret to another principal
schemaName String: (string) - The name of the schema where the secret resides
updateTime String: (string) - The time at which this secret was last updated
updatedBy String: (string) - The principal that last updated the secret
value String: (string) - The secret value to store. This field is input-only and is not returned in responses — use the effective_value field (via GetSecret with include_value set to true) to read the secret value. The maximum size is 60 KiB (pre-encryption). Accepted content includes passwords, tokens, keys, and other sensitive credential data
providerConfig Property Map

Supporting Types

GetSecretUcProviderConfig

WorkspaceId string: Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.

WorkspaceId string: Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.

workspace_id string: Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.

workspaceId String: Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.

workspaceId string: Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.

workspace_id str: Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.

workspaceId String: Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.

Package Details

Repository: databricks pulumi/pulumi-databricks
License: Apache-2.0
Notes: This Pulumi package is based on the databricks Terraform Provider.

Viewing docs for Databricks v1.101.0
published on Thursday, Jul 30, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-databricks

databricks.getSecretUc

On this page

On this page

Example Usage

Basic Example

Using getSecretUc

getSecretUc Result

Supporting Types

GetSecretUcProviderConfig

Package Details

On this page

On this page

Try Pulumi Cloud free.
Your team will thank you.

databricks.getSecretUc

On this page

On this page

Example Usage

Basic Example

Using getSecretUc

getSecretUc Result

Supporting Types

GetSecretUcProviderConfig

Package Details

On this page

On this page

Try Pulumi Cloud free.Your team will thank you.

Try Pulumi Cloud free.
Your team will thank you.