1. Packages
  2. Packages
  3. Databricks Provider
  4. API Docs
  5. getSecretUc
Viewing docs for Databricks v1.94.0
published on Friday, May 29, 2026 by Pulumi
databricks logo
Viewing docs for Databricks v1.94.0
published on Friday, May 29, 2026 by Pulumi

    Private Preview

    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_getsecretuc" "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:

    BrowseOnly bool
    (boolean) - Indicates whether the principal is limited to retrieving metadata for the associated object through the BROWSE privilege when include_browse is enabled in the request
    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
    ExternalSecretId string
    (string)
    FullName string
    (string) - The three-level (fully qualified) name of the secret, in the form of catalog_name.schema_name.secret_name
    Id string
    The provider-assigned unique ID for this managed resource.
    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
    BrowseOnly bool
    (boolean) - Indicates whether the principal is limited to retrieving metadata for the associated object through the BROWSE privilege when include_browse is enabled in the request
    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
    ExternalSecretId string
    (string)
    FullName string
    (string) - The three-level (fully qualified) name of the secret, in the form of catalog_name.schema_name.secret_name
    Id string
    The provider-assigned unique ID for this managed resource.
    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
    browse_only bool
    (boolean) - Indicates whether the principal is limited to retrieving metadata for the associated object through the BROWSE privilege when include_browse is enabled in the request
    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
    external_secret_id string
    (string)
    full_name string
    (string) - The three-level (fully qualified) name of the secret, in the form of catalog_name.schema_name.secret_name
    id string
    The provider-assigned unique ID for this managed resource.
    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
    browseOnly Boolean
    (boolean) - Indicates whether the principal is limited to retrieving metadata for the associated object through the BROWSE privilege when include_browse is enabled in the request
    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
    externalSecretId String
    (string)
    fullName String
    (string) - The three-level (fully qualified) name of the secret, in the form of catalog_name.schema_name.secret_name
    id String
    The provider-assigned unique ID for this managed resource.
    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
    browseOnly boolean
    (boolean) - Indicates whether the principal is limited to retrieving metadata for the associated object through the BROWSE privilege when include_browse is enabled in the request
    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
    externalSecretId string
    (string)
    fullName string
    (string) - The three-level (fully qualified) name of the secret, in the form of catalog_name.schema_name.secret_name
    id string
    The provider-assigned unique ID for this managed resource.
    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
    browse_only bool
    (boolean) - Indicates whether the principal is limited to retrieving metadata for the associated object through the BROWSE privilege when include_browse is enabled in the request
    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
    external_secret_id str
    (string)
    full_name str
    (string) - The three-level (fully qualified) name of the secret, in the form of catalog_name.schema_name.secret_name
    id str
    The provider-assigned unique ID for this managed resource.
    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
    browseOnly Boolean
    (boolean) - Indicates whether the principal is limited to retrieving metadata for the associated object through the BROWSE privilege when include_browse is enabled in the request
    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
    externalSecretId String
    (string)
    fullName String
    (string) - The three-level (fully qualified) name of the secret, in the form of catalog_name.schema_name.secret_name
    id String
    The provider-assigned unique ID for this managed resource.
    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.
    databricks logo
    Viewing docs for Databricks v1.94.0
    published on Friday, May 29, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial