Databricks SDK for JavaScript
    Preparing search index...

    Interface UpdateExternalLocationRequest

    interface UpdateExternalLocationRequest {
        browseOnly?: boolean;
        comment?: string;
        createdAt?: bigint;
        createdBy?: string;
        credentialId?: string;
        credentialName?: string;
        effectiveEnableFileEvents?: boolean;
        effectiveFileEventQueue?: FileEventQueue;
        enableFileEvents?: boolean;
        encryptionDetails?: EncryptionDetails;
        fallback?: boolean;
        fileEventQueue?: FileEventQueue;
        force?: boolean;
        isolationMode?: IsolationMode;
        metastoreId?: string;
        name?: string;
        nameArg?: string;
        newName?: string;
        owner?: string;
        readOnly?: boolean;
        skipValidation?: boolean;
        updatedAt?: bigint;
        updatedBy?: string;
        url?: string;
    }
    Index

    Properties

    browseOnly? comment? createdAt? createdBy? credentialId? credentialName? effectiveEnableFileEvents? effectiveFileEventQueue? enableFileEvents? encryptionDetails? fallback? fileEventQueue? force? isolationMode? metastoreId? name? nameArg? newName? owner? readOnly? skipValidation? updatedAt? updatedBy? url?

    Properties

    browseOnly?: 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.

    comment?: string

    User-provided free-form text description.

    createdAt?: bigint

    Time at which this external location was created, in epoch milliseconds.

    createdBy?: string

    Username of external location creator.

    credentialId?: string

    Unique ID of the location's storage credential.

    credentialName?: string

    Name of the storage credential used with this location.

    effectiveEnableFileEvents?: boolean

    The effective value of enable_file_events after applying server-side defaults.

    effectiveFileEventQueue?: FileEventQueue

    The effective file event queue configuration after applying server-side defaults. Always populated when a queue is provisioned, regardless of whether the user explicitly set enable_file_events. Use this field instead of file_event_queue for reading the actual queue state.

    enableFileEvents?: boolean

    Whether to enable file events on this external location. Default to true. Set to false to disable file events. The actual applied value may differ due to server-side defaults; check effective_enable_file_events for the effective state.

    encryptionDetails?: EncryptionDetails
    fallback?: boolean

    Indicates whether fallback mode is enabled for this external location. When fallback mode is enabled, the access to the location falls back to cluster credentials if UC credentials are not sufficient.

    fileEventQueue?: FileEventQueue

    File event queue settings. If enable_file_events is not false, must be defined and have exactly one of the documented properties.

    force?: boolean

    Force update even if changing url invalidates dependent external tables or mounts.

    isolationMode?: IsolationMode
    metastoreId?: string

    Unique identifier of metastore hosting the external location.

    name?: string

    Name of the external location.

    nameArg?: string

    Name of the external location.

    newName?: string

    New name for the external location.

    owner?: string

    The owner of the external location.

    readOnly?: boolean

    Indicates whether the external location is read-only.

    skipValidation?: boolean

    Skips validation of the storage credential associated with the external location.

    updatedAt?: bigint

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

    updatedBy?: string

    Username of user who last modified the external location.

    url?: string

    Path URL of the external location.

    Settings

    Member Visibility

    On This Page

    Properties