Viewing docs for Databricks v1.101.0
published on Thursday, Jul 30, 2026 by Pulumi
published on Thursday, Jul 30, 2026 by Pulumi
Viewing docs for Databricks v1.101.0
published on Thursday, Jul 30, 2026 by Pulumi
published on Thursday, Jul 30, 2026 by Pulumi
The Secrets data source allows you to list secrets in Unity Catalog within a given catalog and schema.
This returns the metadata of the secrets the calling principal is allowed to see. Secret values are not returned when listing.
Example Usage
Basic Example
This example lists the secrets in a given catalog and schema:
import * as pulumi from "@pulumi/pulumi";
import * as databricks from "@pulumi/databricks";
const all = databricks.getSecretUcs({
catalogName: "my_catalog",
schemaName: "my_schema",
});
import pulumi
import pulumi_databricks as databricks
all = databricks.get_secret_ucs(catalog_name="my_catalog",
schema_name="my_schema")
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.GetSecretUcs(ctx, &databricks.GetSecretUcsArgs{
CatalogName: pulumi.StringRef("my_catalog"),
SchemaName: pulumi.StringRef("my_schema"),
}, 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 all = Databricks.GetSecretUcs.Invoke(new()
{
CatalogName = "my_catalog",
SchemaName = "my_schema",
});
});
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.GetSecretUcsArgs;
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 all = DatabricksFunctions.getSecretUcs(GetSecretUcsArgs.builder()
.catalogName("my_catalog")
.schemaName("my_schema")
.build());
}
}
variables:
all:
fn::invoke:
function: databricks:getSecretUcs
arguments:
catalogName: my_catalog
schemaName: my_schema
pulumi {
required_providers {
databricks = {
source = "pulumi/databricks"
}
}
}
data "databricks_getsecretucs" "all" {
catalog_name = "my_catalog"
schema_name = "my_schema"
}
Using getSecretUcs
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 getSecretUcs(args: GetSecretUcsArgs, opts?: InvokeOptions): Promise<GetSecretUcsResult>
function getSecretUcsOutput(args: GetSecretUcsOutputArgs, opts?: InvokeOptions): Output<GetSecretUcsResult>def get_secret_ucs(catalog_name: Optional[str] = None,
page_size: Optional[int] = None,
provider_config: Optional[GetSecretUcsProviderConfig] = None,
schema_name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetSecretUcsResult
def get_secret_ucs_output(catalog_name: pulumi.Input[Optional[str]] = None,
page_size: pulumi.Input[Optional[int]] = None,
provider_config: pulumi.Input[Optional[GetSecretUcsProviderConfigArgs]] = None,
schema_name: pulumi.Input[Optional[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetSecretUcsResult]func GetSecretUcs(ctx *Context, args *GetSecretUcsArgs, opts ...InvokeOption) (*GetSecretUcsResult, error)
func GetSecretUcsOutput(ctx *Context, args *GetSecretUcsOutputArgs, opts ...InvokeOption) GetSecretUcsResultOutput> Note: This function is named GetSecretUcs in the Go SDK.
public static class GetSecretUcs
{
public static Task<GetSecretUcsResult> InvokeAsync(GetSecretUcsArgs args, InvokeOptions? opts = null)
public static Output<GetSecretUcsResult> Invoke(GetSecretUcsInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetSecretUcsResult> getSecretUcs(GetSecretUcsArgs args, InvokeOptions options)
public static Output<GetSecretUcsResult> getSecretUcs(GetSecretUcsArgs args, InvokeOptions options)
fn::invoke:
function: databricks:index/getSecretUcs:getSecretUcs
arguments:
# arguments dictionarydata "databricks_get_secret_ucs" "name" {
# arguments
}The following arguments are supported:
- Catalog
Name string - The name of the catalog under which to list secrets. Both catalog_name and schema_name must be specified together
- Page
Size int - Maximum number of secrets to return.
- If not specified, at most 1000 secrets are returned.
- If set to a value greater than 0, the page length is the minimum of this value and 1000.
- If set to 0, the page length is set to 1000.
- If set to a value less than 0, an invalid parameter error is returned
- Provider
Config GetSecret Ucs Provider Config - Configure the provider for management through account provider.
- Schema
Name string - The name of the schema under which to list secrets. Both catalog_name and schema_name must be specified together
- Catalog
Name string - The name of the catalog under which to list secrets. Both catalog_name and schema_name must be specified together
- Page
Size int - Maximum number of secrets to return.
- If not specified, at most 1000 secrets are returned.
- If set to a value greater than 0, the page length is the minimum of this value and 1000.
- If set to 0, the page length is set to 1000.
- If set to a value less than 0, an invalid parameter error is returned
- Provider
Config GetSecret Ucs Provider Config - Configure the provider for management through account provider.
- Schema
Name string - The name of the schema under which to list secrets. Both catalog_name and schema_name must be specified together
- catalog_
name string - The name of the catalog under which to list secrets. Both catalog_name and schema_name must be specified together
- page_
size number - Maximum number of secrets to return.
- If not specified, at most 1000 secrets are returned.
- If set to a value greater than 0, the page length is the minimum of this value and 1000.
- If set to 0, the page length is set to 1000.
- If set to a value less than 0, an invalid parameter error is returned
- provider_
config object - Configure the provider for management through account provider.
- schema_
name string - The name of the schema under which to list secrets. Both catalog_name and schema_name must be specified together
- catalog
Name String - The name of the catalog under which to list secrets. Both catalog_name and schema_name must be specified together
- page
Size Integer - Maximum number of secrets to return.
- If not specified, at most 1000 secrets are returned.
- If set to a value greater than 0, the page length is the minimum of this value and 1000.
- If set to 0, the page length is set to 1000.
- If set to a value less than 0, an invalid parameter error is returned
- provider
Config GetSecret Ucs Provider Config - Configure the provider for management through account provider.
- schema
Name String - The name of the schema under which to list secrets. Both catalog_name and schema_name must be specified together
- catalog
Name string - The name of the catalog under which to list secrets. Both catalog_name and schema_name must be specified together
- page
Size number - Maximum number of secrets to return.
- If not specified, at most 1000 secrets are returned.
- If set to a value greater than 0, the page length is the minimum of this value and 1000.
- If set to 0, the page length is set to 1000.
- If set to a value less than 0, an invalid parameter error is returned
- provider
Config GetSecret Ucs Provider Config - Configure the provider for management through account provider.
- schema
Name string - The name of the schema under which to list secrets. Both catalog_name and schema_name must be specified together
- catalog_
name str - The name of the catalog under which to list secrets. Both catalog_name and schema_name must be specified together
- page_
size int - Maximum number of secrets to return.
- If not specified, at most 1000 secrets are returned.
- If set to a value greater than 0, the page length is the minimum of this value and 1000.
- If set to 0, the page length is set to 1000.
- If set to a value less than 0, an invalid parameter error is returned
- provider_
config GetSecret Ucs Provider Config - Configure the provider for management through account provider.
- schema_
name str - The name of the schema under which to list secrets. Both catalog_name and schema_name must be specified together
- catalog
Name String - The name of the catalog under which to list secrets. Both catalog_name and schema_name must be specified together
- page
Size Number - Maximum number of secrets to return.
- If not specified, at most 1000 secrets are returned.
- If set to a value greater than 0, the page length is the minimum of this value and 1000.
- If set to 0, the page length is set to 1000.
- If set to a value less than 0, an invalid parameter error is returned
- provider
Config Property Map - Configure the provider for management through account provider.
- schema
Name String - The name of the schema under which to list secrets. Both catalog_name and schema_name must be specified together
getSecretUcs Result
The following output properties are available:
- Secrets
List<Get
Secret Ucs Secret> - Catalog
Name string - (string) - The name of the catalog where the schema and the secret reside
- Page
Size int - Provider
Config GetSecret Ucs Provider Config - Schema
Name string - (string) - The name of the schema where the secret resides
- Secrets
[]Get
Secret Ucs Secret - Catalog
Name string - (string) - The name of the catalog where the schema and the secret reside
- Page
Size int - Provider
Config GetSecret Ucs Provider Config - Schema
Name string - (string) - The name of the schema where the secret resides
- secrets list(object)
- catalog_
name string - (string) - The name of the catalog where the schema and the secret reside
- page_
size number - provider_
config object - schema_
name string - (string) - The name of the schema where the secret resides
- secrets
List<Get
Secret Ucs Secret> - catalog
Name String - (string) - The name of the catalog where the schema and the secret reside
- page
Size Integer - provider
Config GetSecret Ucs Provider Config - schema
Name String - (string) - The name of the schema where the secret resides
- secrets
Get
Secret Ucs Secret[] - catalog
Name string - (string) - The name of the catalog where the schema and the secret reside
- page
Size number - provider
Config GetSecret Ucs Provider Config - schema
Name string - (string) - The name of the schema where the secret resides
- secrets
Sequence[Get
Secret Ucs Secret] - catalog_
name str - (string) - The name of the catalog where the schema and the secret reside
- page_
size int - provider_
config GetSecret Ucs Provider Config - schema_
name str - (string) - The name of the schema where the secret resides
- secrets List<Property Map>
- catalog
Name String - (string) - The name of the catalog where the schema and the secret reside
- page
Size Number - provider
Config Property Map - schema
Name String - (string) - The name of the schema where the secret resides
Supporting Types
GetSecretUcsProviderConfig
- Workspace
Id 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.
- workspace_
id 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.
- workspace
Id 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.
- workspace
Id String - Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
GetSecretUcsSecret
- Catalog
Name string - The name of the catalog under which to list secrets. Both catalog_name and schema_name must be specified together
- 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 - The name of the schema under which to list secrets. Both catalog_name and schema_name must be specified together
- 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 GetSecret Ucs Secret Provider Config - Configure the provider for management through account provider.
- Catalog
Name string - The name of the catalog under which to list secrets. Both catalog_name and schema_name must be specified together
- 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 - The name of the schema under which to list secrets. Both catalog_name and schema_name must be specified together
- 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 GetSecret Ucs Secret Provider Config - Configure the provider for management through account provider.
- catalog_
name string - The name of the catalog under which to list secrets. Both catalog_name and schema_name must be specified together
- 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 - The name of the schema under which to list secrets. Both catalog_name and schema_name must be specified together
- 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 - Configure the provider for management through account provider.
- catalog
Name String - The name of the catalog under which to list secrets. Both catalog_name and schema_name must be specified together
- 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 - The name of the schema under which to list secrets. Both catalog_name and schema_name must be specified together
- 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 GetSecret Ucs Secret Provider Config - Configure the provider for management through account provider.
- catalog
Name string - The name of the catalog under which to list secrets. Both catalog_name and schema_name must be specified together
- 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 - The name of the schema under which to list secrets. Both catalog_name and schema_name must be specified together
- 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 GetSecret Ucs Secret Provider Config - Configure the provider for management through account provider.
- catalog_
name str - The name of the catalog under which to list secrets. Both catalog_name and schema_name must be specified together
- 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 - The name of the schema under which to list secrets. Both catalog_name and schema_name must be specified together
- 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 GetSecret Ucs Secret Provider Config - Configure the provider for management through account provider.
- catalog
Name String - The name of the catalog under which to list secrets. Both catalog_name and schema_name must be specified together
- 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 - The name of the schema under which to list secrets. Both catalog_name and schema_name must be specified together
- 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 Property Map - Configure the provider for management through account provider.
GetSecretUcsSecretProviderConfig
- Workspace
Id 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.
- workspace_
id 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.
- workspace
Id 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.
- workspace
Id 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
databricksTerraform Provider.
Viewing docs for Databricks v1.101.0
published on Thursday, Jul 30, 2026 by Pulumi
published on Thursday, Jul 30, 2026 by Pulumi