Databricks SDK for JavaScript
    Preparing search index...

    Interface SetWorkspaceWarehouseConfigRequest

    Sets the workspace level warehouse configuration that is shared by all SQL warehouses in this workspace.

    This is idempotent.

    interface SetWorkspaceWarehouseConfigRequest {
        channel?: Channel;
        configParam?: RepeatedEndpointConfPairs;
        dataAccessConfig?: EndpointConfPair[];
        enabledWarehouseTypes?: WarehouseTypePair[];
        enableServerlessCompute?: boolean;
        globalParam?: RepeatedEndpointConfPairs;
        googleServiceAccount?: string;
        instanceProfileArn?: string;
        securityPolicy?: EndpointSecurityPolicy;
        sqlConfigurationParameters?: RepeatedEndpointConfPairs;
    }
    Index

    Properties

    channel? configParam? dataAccessConfig? enabledWarehouseTypes? enableServerlessCompute? globalParam? googleServiceAccount? instanceProfileArn? securityPolicy? sqlConfigurationParameters?

    Properties

    channel?: Channel

    Optional: Channel selection details

    configParam?: RepeatedEndpointConfPairs

    Deprecated: Use sql_configuration_parameters

    dataAccessConfig?: EndpointConfPair[]

    Spark confs for external hive metastore configuration JSON serialized size must be less than <= 512K

    enabledWarehouseTypes?: WarehouseTypePair[]

    List of Warehouse Types allowed in this workspace (limits allowed value of the type field in CreateWarehouse and EditWarehouse). Note: Some types cannot be disabled, they don't need to be specified in SetWorkspaceWarehouseConfig. Note: Disabling a type may cause existing warehouses to be converted to another type. Used by frontend to save specific type availability in the warehouse create and edit form UI.

    enableServerlessCompute?: boolean

    Deprecated: only setting this to true is allowed.

    globalParam?: RepeatedEndpointConfPairs

    Deprecated: Use sql_configuration_parameters

    googleServiceAccount?: string

    GCP only: Google Service Account used to pass to cluster to access Google Cloud Storage

    instanceProfileArn?: string

    AWS Only: The instance profile used to pass an IAM role to the SQL warehouses. This configuration is also applied to the workspace's serverless compute for notebooks and jobs.

    securityPolicy?: EndpointSecurityPolicy

    Security policy for warehouses

    sqlConfigurationParameters?: RepeatedEndpointConfPairs

    SQL configuration parameters

    Settings

    Member Visibility

    On This Page

    Properties