1. Packages
  2. Databricks Provider
  3. API Docs
  4. getEnvironmentsWorkspaceBaseEnvironment
Viewing docs for Databricks v1.90.0
published on Thursday, Mar 19, 2026 by Pulumi
databricks logo
Viewing docs for Databricks v1.90.0
published on Thursday, Mar 19, 2026 by Pulumi

    Public Beta

    This data source retrieves a single Workspace Base Environment by its resource name.

    Using getEnvironmentsWorkspaceBaseEnvironment

    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 getEnvironmentsWorkspaceBaseEnvironment(args: GetEnvironmentsWorkspaceBaseEnvironmentArgs, opts?: InvokeOptions): Promise<GetEnvironmentsWorkspaceBaseEnvironmentResult>
    function getEnvironmentsWorkspaceBaseEnvironmentOutput(args: GetEnvironmentsWorkspaceBaseEnvironmentOutputArgs, opts?: InvokeOptions): Output<GetEnvironmentsWorkspaceBaseEnvironmentResult>
    def get_environments_workspace_base_environment(name: Optional[str] = None,
                                                    provider_config: Optional[GetEnvironmentsWorkspaceBaseEnvironmentProviderConfig] = None,
                                                    opts: Optional[InvokeOptions] = None) -> GetEnvironmentsWorkspaceBaseEnvironmentResult
    def get_environments_workspace_base_environment_output(name: Optional[pulumi.Input[str]] = None,
                                                    provider_config: Optional[pulumi.Input[GetEnvironmentsWorkspaceBaseEnvironmentProviderConfigArgs]] = None,
                                                    opts: Optional[InvokeOptions] = None) -> Output[GetEnvironmentsWorkspaceBaseEnvironmentResult]
    func LookupEnvironmentsWorkspaceBaseEnvironment(ctx *Context, args *LookupEnvironmentsWorkspaceBaseEnvironmentArgs, opts ...InvokeOption) (*LookupEnvironmentsWorkspaceBaseEnvironmentResult, error)
    func LookupEnvironmentsWorkspaceBaseEnvironmentOutput(ctx *Context, args *LookupEnvironmentsWorkspaceBaseEnvironmentOutputArgs, opts ...InvokeOption) LookupEnvironmentsWorkspaceBaseEnvironmentResultOutput

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

    public static class GetEnvironmentsWorkspaceBaseEnvironment 
    {
        public static Task<GetEnvironmentsWorkspaceBaseEnvironmentResult> InvokeAsync(GetEnvironmentsWorkspaceBaseEnvironmentArgs args, InvokeOptions? opts = null)
        public static Output<GetEnvironmentsWorkspaceBaseEnvironmentResult> Invoke(GetEnvironmentsWorkspaceBaseEnvironmentInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetEnvironmentsWorkspaceBaseEnvironmentResult> getEnvironmentsWorkspaceBaseEnvironment(GetEnvironmentsWorkspaceBaseEnvironmentArgs args, InvokeOptions options)
    public static Output<GetEnvironmentsWorkspaceBaseEnvironmentResult> getEnvironmentsWorkspaceBaseEnvironment(GetEnvironmentsWorkspaceBaseEnvironmentArgs args, InvokeOptions options)
    
    fn::invoke:
      function: databricks:index/getEnvironmentsWorkspaceBaseEnvironment:getEnvironmentsWorkspaceBaseEnvironment
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Name string
    The resource name of the workspace base environment. Format: workspace-base-environments/{workspace-base-environment}
    ProviderConfig GetEnvironmentsWorkspaceBaseEnvironmentProviderConfig
    Configure the provider for management through account provider.
    Name string
    The resource name of the workspace base environment. Format: workspace-base-environments/{workspace-base-environment}
    ProviderConfig GetEnvironmentsWorkspaceBaseEnvironmentProviderConfig
    Configure the provider for management through account provider.
    name String
    The resource name of the workspace base environment. Format: workspace-base-environments/{workspace-base-environment}
    providerConfig GetEnvironmentsWorkspaceBaseEnvironmentProviderConfig
    Configure the provider for management through account provider.
    name string
    The resource name of the workspace base environment. Format: workspace-base-environments/{workspace-base-environment}
    providerConfig GetEnvironmentsWorkspaceBaseEnvironmentProviderConfig
    Configure the provider for management through account provider.
    name str
    The resource name of the workspace base environment. Format: workspace-base-environments/{workspace-base-environment}
    provider_config GetEnvironmentsWorkspaceBaseEnvironmentProviderConfig
    Configure the provider for management through account provider.
    name String
    The resource name of the workspace base environment. Format: workspace-base-environments/{workspace-base-environment}
    providerConfig Property Map
    Configure the provider for management through account provider.

    getEnvironmentsWorkspaceBaseEnvironment Result

    The following output properties are available:

    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
    Id string
    The provider-assigned unique ID for this managed resource.
    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 GetEnvironmentsWorkspaceBaseEnvironmentProviderConfig
    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
    Id string
    The provider-assigned unique ID for this managed resource.
    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 GetEnvironmentsWorkspaceBaseEnvironmentProviderConfig
    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
    id String
    The provider-assigned unique ID for this managed resource.
    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 GetEnvironmentsWorkspaceBaseEnvironmentProviderConfig
    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
    id string
    The provider-assigned unique ID for this managed resource.
    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 GetEnvironmentsWorkspaceBaseEnvironmentProviderConfig
    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
    id str
    The provider-assigned unique ID for this managed resource.
    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 GetEnvironmentsWorkspaceBaseEnvironmentProviderConfig
    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
    id String
    The provider-assigned unique ID for this managed resource.
    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

    Supporting Types

    GetEnvironmentsWorkspaceBaseEnvironmentProviderConfig

    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
      Try Pulumi Cloud free. Your team will thank you.