1. Packages
  2. Databricks Provider
  3. API Docs
  4. getEnvironmentsWorkspaceBaseEnvironments
Viewing docs for Databricks v1.90.0
published on Thursday, Mar 19, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-databricks

databricks.getEnvironmentsWorkspaceBaseEnvironments

databricks logo
Viewing docs for Databricks v1.90.0
published on Thursday, Mar 19, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-databricks

    Public Beta

    This data source retrieves the list of all Workspace Base Environments in the workspace. The list can be accessed via the data object’s workspace_base_environments field.

    Using getEnvironmentsWorkspaceBaseEnvironments

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getEnvironmentsWorkspaceBaseEnvironments(args: GetEnvironmentsWorkspaceBaseEnvironmentsArgs, opts?: InvokeOptions): Promise<GetEnvironmentsWorkspaceBaseEnvironmentsResult>
function getEnvironmentsWorkspaceBaseEnvironmentsOutput(args: GetEnvironmentsWorkspaceBaseEnvironmentsOutputArgs, opts?: InvokeOptions): Output<GetEnvironmentsWorkspaceBaseEnvironmentsResult>
    def get_environments_workspace_base_environments(page_size: Optional[int] = None,
                                                 provider_config: Optional[GetEnvironmentsWorkspaceBaseEnvironmentsProviderConfig] = None,
                                                 opts: Optional[InvokeOptions] = None) -> GetEnvironmentsWorkspaceBaseEnvironmentsResult
def get_environments_workspace_base_environments_output(page_size: Optional[pulumi.Input[int]] = None,
                                                 provider_config: Optional[pulumi.Input[GetEnvironmentsWorkspaceBaseEnvironmentsProviderConfigArgs]] = None,
                                                 opts: Optional[InvokeOptions] = None) -> Output[GetEnvironmentsWorkspaceBaseEnvironmentsResult]
    func GetEnvironmentsWorkspaceBaseEnvironments(ctx *Context, args *GetEnvironmentsWorkspaceBaseEnvironmentsArgs, opts ...InvokeOption) (*GetEnvironmentsWorkspaceBaseEnvironmentsResult, error)
func GetEnvironmentsWorkspaceBaseEnvironmentsOutput(ctx *Context, args *GetEnvironmentsWorkspaceBaseEnvironmentsOutputArgs, opts ...InvokeOption) GetEnvironmentsWorkspaceBaseEnvironmentsResultOutput

    > Note: This function is named GetEnvironmentsWorkspaceBaseEnvironments in the Go SDK.

    public static class GetEnvironmentsWorkspaceBaseEnvironments 
{
    public static Task<GetEnvironmentsWorkspaceBaseEnvironmentsResult> InvokeAsync(GetEnvironmentsWorkspaceBaseEnvironmentsArgs args, InvokeOptions? opts = null)
    public static Output<GetEnvironmentsWorkspaceBaseEnvironmentsResult> Invoke(GetEnvironmentsWorkspaceBaseEnvironmentsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetEnvironmentsWorkspaceBaseEnvironmentsResult> getEnvironmentsWorkspaceBaseEnvironments(GetEnvironmentsWorkspaceBaseEnvironmentsArgs args, InvokeOptions options)
public static Output<GetEnvironmentsWorkspaceBaseEnvironmentsResult> getEnvironmentsWorkspaceBaseEnvironments(GetEnvironmentsWorkspaceBaseEnvironmentsArgs args, InvokeOptions options)

    fn::invoke:
  function: databricks:index/getEnvironmentsWorkspaceBaseEnvironments:getEnvironmentsWorkspaceBaseEnvironments
  arguments:
    # arguments dictionary

    The following arguments are supported:

    PageSize int
    The maximum number of environments to return per page. Default is 1000
    ProviderConfig GetEnvironmentsWorkspaceBaseEnvironmentsProviderConfig
    Configure the provider for management through account provider.
    PageSize int
    The maximum number of environments to return per page. Default is 1000
    ProviderConfig GetEnvironmentsWorkspaceBaseEnvironmentsProviderConfig
    Configure the provider for management through account provider.
    pageSize Integer
    The maximum number of environments to return per page. Default is 1000
    providerConfig GetEnvironmentsWorkspaceBaseEnvironmentsProviderConfig
    Configure the provider for management through account provider.
    pageSize number
    The maximum number of environments to return per page. Default is 1000
    providerConfig GetEnvironmentsWorkspaceBaseEnvironmentsProviderConfig
    Configure the provider for management through account provider.
    page_size int
    The maximum number of environments to return per page. Default is 1000
    provider_config GetEnvironmentsWorkspaceBaseEnvironmentsProviderConfig
    Configure the provider for management through account provider.
    pageSize Number
    The maximum number of environments to return per page. Default is 1000
    providerConfig Property Map
    Configure the provider for management through account provider.

    getEnvironmentsWorkspaceBaseEnvironments Result

    The following output properties are available:

    id String
    The provider-assigned unique ID for this managed resource.
    workspaceBaseEnvironments List<Property Map>
    pageSize Number
    providerConfig Property Map

    Supporting Types

    GetEnvironmentsWorkspaceBaseEnvironmentsProviderConfig

    WorkspaceId string
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
    WorkspaceId string
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
    workspaceId String
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
    workspaceId string
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
    workspace_id str
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
    workspaceId String
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.

    GetEnvironmentsWorkspaceBaseEnvironmentsWorkspaceBaseEnvironment

    BaseEnvironmentType string
    (string) - The type of base environment (CPU or GPU). Possible values are: CPU, GPU
    CreateTime string
    (string) - Timestamp when the environment was created
    CreatorUserId string
    (string) - User ID of the creator
    DisplayName string
    (string) - Human-readable display name for the workspace base environment
    EffectiveBaseEnvironmentType string
    Filepath string
    (string) - The WSFS or UC Volumes path to the environment YAML file
    IsDefault bool
    (boolean) - Whether this is the default environment for the workspace
    LastUpdatedUserId string
    (string) - User ID of the last user who updated the environment
    Message string
    (string) - Status message providing additional details about the environment status
    Name string
    (string) - The resource name of the workspace base environment. Format: workspace-base-environments/{workspace-base-environment}
    Status string
    (string) - The status of the materialized workspace base environment. Possible values are: CREATED, EXPIRED, FAILED, INVALID, PENDING, REFRESHING
    UpdateTime string
    (string) - Timestamp when the environment was last updated
    ProviderConfig GetEnvironmentsWorkspaceBaseEnvironmentsWorkspaceBaseEnvironmentProviderConfig
    Configure the provider for management through account provider.
    BaseEnvironmentType string
    (string) - The type of base environment (CPU or GPU). Possible values are: CPU, GPU
    CreateTime string
    (string) - Timestamp when the environment was created
    CreatorUserId string
    (string) - User ID of the creator
    DisplayName string
    (string) - Human-readable display name for the workspace base environment
    EffectiveBaseEnvironmentType string
    Filepath string
    (string) - The WSFS or UC Volumes path to the environment YAML file
    IsDefault bool
    (boolean) - Whether this is the default environment for the workspace
    LastUpdatedUserId string
    (string) - User ID of the last user who updated the environment
    Message string
    (string) - Status message providing additional details about the environment status
    Name string
    (string) - The resource name of the workspace base environment. Format: workspace-base-environments/{workspace-base-environment}
    Status string
    (string) - The status of the materialized workspace base environment. Possible values are: CREATED, EXPIRED, FAILED, INVALID, PENDING, REFRESHING
    UpdateTime string
    (string) - Timestamp when the environment was last updated
    ProviderConfig GetEnvironmentsWorkspaceBaseEnvironmentsWorkspaceBaseEnvironmentProviderConfig
    Configure the provider for management through account provider.
    baseEnvironmentType String
    (string) - The type of base environment (CPU or GPU). Possible values are: CPU, GPU
    createTime String
    (string) - Timestamp when the environment was created
    creatorUserId String
    (string) - User ID of the creator
    displayName String
    (string) - Human-readable display name for the workspace base environment
    effectiveBaseEnvironmentType String
    filepath String
    (string) - The WSFS or UC Volumes path to the environment YAML file
    isDefault Boolean
    (boolean) - Whether this is the default environment for the workspace
    lastUpdatedUserId String
    (string) - User ID of the last user who updated the environment
    message String
    (string) - Status message providing additional details about the environment status
    name String
    (string) - The resource name of the workspace base environment. Format: workspace-base-environments/{workspace-base-environment}
    status String
    (string) - The status of the materialized workspace base environment. Possible values are: CREATED, EXPIRED, FAILED, INVALID, PENDING, REFRESHING
    updateTime String
    (string) - Timestamp when the environment was last updated
    providerConfig GetEnvironmentsWorkspaceBaseEnvironmentsWorkspaceBaseEnvironmentProviderConfig
    Configure the provider for management through account provider.
    baseEnvironmentType string
    (string) - The type of base environment (CPU or GPU). Possible values are: CPU, GPU
    createTime string
    (string) - Timestamp when the environment was created
    creatorUserId string
    (string) - User ID of the creator
    displayName string
    (string) - Human-readable display name for the workspace base environment
    effectiveBaseEnvironmentType string
    filepath string
    (string) - The WSFS or UC Volumes path to the environment YAML file
    isDefault boolean
    (boolean) - Whether this is the default environment for the workspace
    lastUpdatedUserId string
    (string) - User ID of the last user who updated the environment
    message string
    (string) - Status message providing additional details about the environment status
    name string
    (string) - The resource name of the workspace base environment. Format: workspace-base-environments/{workspace-base-environment}
    status string
    (string) - The status of the materialized workspace base environment. Possible values are: CREATED, EXPIRED, FAILED, INVALID, PENDING, REFRESHING
    updateTime string
    (string) - Timestamp when the environment was last updated
    providerConfig GetEnvironmentsWorkspaceBaseEnvironmentsWorkspaceBaseEnvironmentProviderConfig
    Configure the provider for management through account provider.
    base_environment_type str
    (string) - The type of base environment (CPU or GPU). Possible values are: CPU, GPU
    create_time str
    (string) - Timestamp when the environment was created
    creator_user_id str
    (string) - User ID of the creator
    display_name str
    (string) - Human-readable display name for the workspace base environment
    effective_base_environment_type str
    filepath str
    (string) - The WSFS or UC Volumes path to the environment YAML file
    is_default bool
    (boolean) - Whether this is the default environment for the workspace
    last_updated_user_id str
    (string) - User ID of the last user who updated the environment
    message str
    (string) - Status message providing additional details about the environment status
    name str
    (string) - The resource name of the workspace base environment. Format: workspace-base-environments/{workspace-base-environment}
    status str
    (string) - The status of the materialized workspace base environment. Possible values are: CREATED, EXPIRED, FAILED, INVALID, PENDING, REFRESHING
    update_time str
    (string) - Timestamp when the environment was last updated
    provider_config GetEnvironmentsWorkspaceBaseEnvironmentsWorkspaceBaseEnvironmentProviderConfig
    Configure the provider for management through account provider.
    baseEnvironmentType String
    (string) - The type of base environment (CPU or GPU). Possible values are: CPU, GPU
    createTime String
    (string) - Timestamp when the environment was created
    creatorUserId String
    (string) - User ID of the creator
    displayName String
    (string) - Human-readable display name for the workspace base environment
    effectiveBaseEnvironmentType String
    filepath String
    (string) - The WSFS or UC Volumes path to the environment YAML file
    isDefault Boolean
    (boolean) - Whether this is the default environment for the workspace
    lastUpdatedUserId String
    (string) - User ID of the last user who updated the environment
    message String
    (string) - Status message providing additional details about the environment status
    name String
    (string) - The resource name of the workspace base environment. Format: workspace-base-environments/{workspace-base-environment}
    status String
    (string) - The status of the materialized workspace base environment. Possible values are: CREATED, EXPIRED, FAILED, INVALID, PENDING, REFRESHING
    updateTime String
    (string) - Timestamp when the environment was last updated
    providerConfig Property Map
    Configure the provider for management through account provider.

    GetEnvironmentsWorkspaceBaseEnvironmentsWorkspaceBaseEnvironmentProviderConfig

    WorkspaceId string
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
    WorkspaceId string
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
    workspaceId String
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
    workspaceId string
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
    workspace_id str
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
    workspaceId String
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.

    Package Details

    Repository
    databricks pulumi/pulumi-databricks
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the databricks Terraform Provider.
    databricks logo
    Viewing docs for Databricks v1.90.0
    published on Thursday, Mar 19, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-databricks
      Try Pulumi Cloud free. Your team will thank you.