Databricks SDK for JavaScript
    Preparing search index...
    Index

    Constructors

    Methods

    • Creates a new secret in Unity Catalog.

      You must be the owner of the parent schema or have the CREATE_SECRET and USE SCHEMA privileges on the parent schema and USE CATALOG on the parent catalog.

      The secret is stored in the specified catalog and schema, and the value field contains the sensitive data to be securely stored.

      Parameters

      Returns Promise<Secret>

    • Gets a secret by its three-level (fully qualified) name.

      You must be a metastore admin, the owner of the secret, or have the MANAGE privilege on the secret.

      The secret value isn't returned by default. To retrieve it, you must also have the READ_SECRET privilege and set include_value to true in the request.

      Parameters

      Returns Promise<Secret>

    • Lists secrets in Unity Catalog.

      You must be a metastore admin, the owner of the secret, or have the MANAGE privilege on the secret.

      Both catalog_name and schema_name must be specified together to filter secrets within a specific schema. Results are paginated; use the page_token field from the response to retrieve subsequent pages.

      Parameters

      Returns Promise<ListSecretsResponse>

    • Updates an existing secret in Unity Catalog.

      You must be the owner of the secret or a metastore admin. If you are a metastore admin, only the owner field can be changed.

      Use the update_mask field to specify which fields to update. Supported updatable fields include value, comment, owner, and expire_time.

      Parameters

      Returns Promise<Secret>