com.databricks.sdk.service.catalog

Interface StorageCredentialsService

@Generated
public interface StorageCredentialsService

A storage credential represents an authentication and authorization mechanism for accessing data stored on your cloud tenant. Each storage credential is subject to Unity Catalog access-control policies that control which users and groups can access the credential. If a user does not have access to a storage credential in Unity Catalog, the request fails and Unity Catalog does not attempt to authenticate to your cloud tenant on the user’s behalf.

Databricks recommends using external locations rather than using storage credentials directly.

To create storage credentials, you must be a Databricks account admin. The account admin who creates the storage credential can delegate ownership to another user or group to manage permissions on it.

This is the high-level interface, that contains generated methods.

Evolving: this interface is under development. Method signatures may change.

Method Summary

Modifier and Type	Method and Description
StorageCredentialInfo	create(CreateStorageCredential createStorageCredential) Creates a new storage credential.
void	delete(DeleteStorageCredentialRequest deleteStorageCredentialRequest) Deletes a storage credential from the metastore.
StorageCredentialInfo	get(GetStorageCredentialRequest getStorageCredentialRequest) Gets a storage credential from the metastore.
ListStorageCredentialsResponse	list(ListStorageCredentialsRequest listStorageCredentialsRequest) Gets an array of storage credentials (as __StorageCredentialInfo__ objects).
StorageCredentialInfo	update(UpdateStorageCredential updateStorageCredential) Updates a storage credential on the metastore.
ValidateStorageCredentialResponse	validate(ValidateStorageCredential validateStorageCredential) Validates a storage credential.

Method Detail

create

StorageCredentialInfo create(CreateStorageCredential createStorageCredential)

Creates a new storage credential.

The caller must be a metastore admin or have the **CREATE_STORAGE_CREDENTIAL** privilege on the metastore.

delete

void delete(DeleteStorageCredentialRequest deleteStorageCredentialRequest)

Deletes a storage credential from the metastore. The caller must be an owner of the storage credential.

get

StorageCredentialInfo get(GetStorageCredentialRequest getStorageCredentialRequest)

Gets a storage credential from the metastore. The caller must be a metastore admin, the owner of the storage credential, or have some permission on the storage credential.

list

ListStorageCredentialsResponse list(ListStorageCredentialsRequest listStorageCredentialsRequest)

Gets an array of storage credentials (as __StorageCredentialInfo__ objects). The array is limited to only those storage credentials the caller has permission to access. If the caller is a metastore admin, retrieval of credentials is unrestricted. There is no guarantee of a specific ordering of the elements in the array.

NOTE: we recommend using max_results=0 to use the paginated version of this API. Unpaginated calls will be deprecated soon.

PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero results while still providing a next_page_token. Clients must continue reading pages until next_page_token is absent, which is the only indication that the end of results has been reached.

update

StorageCredentialInfo update(UpdateStorageCredential updateStorageCredential)

Updates a storage credential on the metastore.

The caller must be the owner of the storage credential or a metastore admin. If the caller is a metastore admin, only the **owner** field can be changed.

validate

ValidateStorageCredentialResponse validate(ValidateStorageCredential validateStorageCredential)

Validates a storage credential. At least one of __external_location_name__ and __url__ need to be provided. If only one of them is provided, it will be used for validation. And if both are provided, the __url__ will be used for validation, and __external_location_name__ will be ignored when checking overlapping urls.

Either the __storage_credential_name__ or the cloud-specific credential must be provided.

The caller must be a metastore admin or the storage credential owner or have the **CREATE_EXTERNAL_LOCATION** privilege on the metastore and the storage credential.