Databricks SDK for JavaScript
    Preparing search index...

    Interface UpdateCredentialRequest

    interface UpdateCredentialRequest {
        comment?: string;
        createdAt?: bigint;
        createdBy?: string;
        credential?:
            | { $case: "awsIamRole"; awsIamRole: AwsIamRole }
            | {
                $case: "azureServicePrincipal";
                azureServicePrincipal: AzureServicePrincipal;
            }
            | {
                $case: "gcpServiceAccountKey";
                gcpServiceAccountKey: GcpServiceAccountKey;
            }
            | {
                $case: "azureManagedIdentity";
                azureManagedIdentity: AzureManagedIdentity;
            }
            | {
                $case: "databricksGcpServiceAccount";
                databricksGcpServiceAccount: DatabricksGcpServiceAccount;
            }
            | { $case: "cloudflareApiToken"; cloudflareApiToken: CloudflareApiToken };
        force?: boolean;
        fullName?: string;
        id?: string;
        isolationMode?: IsolationMode;
        metastoreId?: string;
        name?: string;
        nameArg?: string;
        newName?: string;
        owner?: string;
        readOnly?: boolean;
        skipValidation?: boolean;
        updatedAt?: bigint;
        updatedBy?: string;
        usedForManagedStorage?: boolean;
    }
    Index

    Properties

    comment? createdAt? createdBy? credential? force? fullName? id? isolationMode? metastoreId? name? nameArg? newName? owner? readOnly? skipValidation? updatedAt? updatedBy? usedForManagedStorage?

    Properties

    comment?: string

    Comment associated with the credential.

    createdAt?: bigint

    Time at which this credential was created, in epoch milliseconds.

    createdBy?: string

    Username of credential creator.

    credential?:
        | { $case: "awsIamRole"; awsIamRole: AwsIamRole }
        | {
            $case: "azureServicePrincipal";
            azureServicePrincipal: AzureServicePrincipal;
        }
        | {
            $case: "gcpServiceAccountKey";
            gcpServiceAccountKey: GcpServiceAccountKey;
        }
        | {
            $case: "azureManagedIdentity";
            azureManagedIdentity: AzureManagedIdentity;
        }
        | {
            $case: "databricksGcpServiceAccount";
            databricksGcpServiceAccount: DatabricksGcpServiceAccount;
        }
        | { $case: "cloudflareApiToken"; cloudflareApiToken: CloudflareApiToken }

    (--[Create:REQ, Update:OPT] The long-lived cloud credential.--)

    Type Declaration

    force?: boolean

    Force an update even if there are dependent services (when purpose is SERVICE) or dependent external locations and external tables (when purpose is STORAGE).

    fullName?: string

    The full name of the credential.

    id?: string

    The unique identifier of the credential.

    isolationMode?: IsolationMode

    Whether the current securable is accessible from all workspaces or a specific set of workspaces.

    metastoreId?: string

    Unique identifier of the parent metastore.

    name?: string

    The credential name. The name must be unique among storage and service credentials within the metastore.

    nameArg?: string

    Name of the credential.

    newName?: string

    New name of credential.

    owner?: string

    Username of current owner of credential.

    readOnly?: boolean

    Whether the credential is usable only for read operations. Only applicable when purpose is STORAGE.

    skipValidation?: boolean

    Supply true to this argument to skip validation of the updated credential.

    updatedAt?: bigint

    Time at which this credential was last modified, in epoch milliseconds.

    updatedBy?: string

    Username of user who last modified the credential.

    usedForManagedStorage?: boolean

    Whether this credential is the current metastore's root storage credential. Only applicable when purpose is STORAGE.

    Settings

    Member Visibility

    On This Page

    Properties